TeamCity REST API Reference 2021.2 Help

TriggeredBy

Represents the user/trigger/dependency which caused this build to start.

Properties

Field

Data type

type

string

details

string

date

string

displayText

string

rawValue

string

user

User

build

Build

buildType

BuildType

properties

Properties

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<TriggeredBy date="string" details="string" displayText="string" rawValue="string" type="string"> <user email="string" enabled2FA="true" hasPassword="true" href="string" id="123456789" lastLogin="string" locator="string" name="string" password="string" realm="string" username="string"> <properties>[[[properties...|properties.html]]]</properties> <roles>[[[roles...|roles.html]]]</roles> <groups>[[[groups...|groups.html]]]</groups> <avatars>[[[userAvatars...|useravatars.html]]]</avatars> </user> <build artifactsDirectory="string" branchName="string" buildTypeId="string" buildTypeInternalId="string" chainModificationId="string" changesCollectingInProgress="true" composite="true" currentSettingsHash="string" customized="true" defaultBranch="true" detachedFromAgent="true" failedToStart="true" finishDate="string" finishEstimate="string" finishOnAgentDate="string" history="true" href="string" id="123456789" limitedChangesCount="123" locator="string" modificationId="string" number="string" percentageComplete="123" personal="true" pinned="true" queuePosition="123" queuedDate="string" running="true" settingsHash="string" startDate="string" startEstimate="string" state="string" status="string" statusText="string" taskId="123456789" unspecifiedBranch="true" usedByOtherBuilds="true" waitReason="string" webUrl="string"> <links>[[[links...|links.html]]]</links> <buildType>[[[buildType...|buildtype.html]]]</buildType> <comment>[[[comment...|comment.html]]]</comment> <tags>[[[tags...|tags.html]]]</tags> <pinInfo>[[[comment...|comment.html]]]</pinInfo> <user>[[[user...|user.html]]]</user> <delayedByBuild>[[[build...|build.html]]]</delayedByBuild> <plannedAgent>[[[agent...|agent.html]]]</plannedAgent> <running-info>[[[progress-info...|progressinfo.html]]]</running-info> <canceledInfo>[[[comment...|comment.html]]]</canceledInfo> <triggered>[[[TriggeredBy...|triggeredby.html]]]</triggered> <lastChanges>[[[changes...|changes.html]]]</lastChanges> <changes>[[[changes...|changes.html]]]</changes> <revisions>[[[Revisions...|revisions.html]]]</revisions> <versionedSettingsRevision>[[[Revision...|revision.html]]]</versionedSettingsRevision> <artifactDependencyChanges>[[[buildChanges...|buildchanges.html]]]</artifactDependencyChanges> <agent>[[[agent...|agent.html]]]</agent> <compatibleAgents>[[[agents...|agents.html]]]</compatibleAgents> <testOccurrences>[[[testOccurrences...|testoccurrences.html]]]</testOccurrences> <problemOccurrences>[[[problemOccurrences...|problemoccurrences.html]]]</problemOccurrences> <artifacts>[[[files...|files.html]]]</artifacts> <relatedIssues>[[[issuesUsages...|issuesusages.html]]]</relatedIssues> <properties>[[[properties...|properties.html]]]</properties> <resultingProperties>[[[properties...|properties.html]]]</resultingProperties> <attributes>[[[entries...|entries.html]]]</attributes> <statistics>[[[properties...|properties.html]]]</statistics> <metadata>[[[datas...|datas.html]]]</metadata> <snapshot-dependencies>[[[builds...|builds.html]]]</snapshot-dependencies> <artifact-dependencies>[[[builds...|builds.html]]]</artifact-dependencies> <custom-artifact-dependencies>[[[artifact-dependencies...|artifactdependencies.html]]]</custom-artifact-dependencies> <replacementIds>[[[items...|items.html]]]</replacementIds> <related>[[[related...|related.html]]]</related> <triggeringOptions>[[[buildTriggeringOptions...|buildtriggeringoptions.html]]]</triggeringOptions> <statusChangeComment>[[[comment...|comment.html]]]</statusChangeComment> <vcsLabels>[[[vcsLabel...|vcslabel.html]]]</vcsLabels> <customization>[[[customizations...|customizations.html]]]</customization> </build> <buildType description="string" externalStatusAllowed="true" href="string" id="string" inherited="true" internalId="string" locator="string" name="string" paused="true" projectId="string" projectInternalId="string" projectName="string" templateFlag="true" type="string" uuid="string" webUrl="string"> <links>[[[links...|links.html]]]</links> <project>[[[project...|project.html]]]</project> <templates>[[[buildTypes...|buildtypes.html]]]</templates> <template>[[[buildType...|buildtype.html]]]</template> <vcs-root-entries>[[[vcs-root-entries...|vcsrootentries.html]]]</vcs-root-entries> <settings>[[[properties...|properties.html]]]</settings> <parameters>[[[properties...|properties.html]]]</parameters> <steps>[[[steps...|steps.html]]]</steps> <features>[[[features...|features.html]]]</features> <triggers>[[[triggers...|triggers.html]]]</triggers> <snapshot-dependencies>[[[snapshot-dependencies...|snapshotdependencies.html]]]</snapshot-dependencies> <artifact-dependencies>[[[artifact-dependencies...|artifactdependencies.html]]]</artifact-dependencies> <agent-requirements>[[[agent-requirements...|agentrequirements.html]]]</agent-requirements> <branches>[[[branches...|branches.html]]]</branches> <builds>[[[builds...|builds.html]]]</builds> <investigations>[[[investigations...|investigations.html]]]</investigations> <compatibleAgents>[[[agents...|agents.html]]]</compatibleAgents> <vcsRootInstances>[[[vcs-root-instances...|vcsrootinstances.html]]]</vcsRootInstances> <pauseComment>[[[comment...|comment.html]]]</pauseComment> </buildType> <properties count="123" href="string"> <property>[[[property...|property.html]]]</property> </properties> </TriggeredBy>
{ "date" : "date", "displayText" : "displayText", "rawValue" : "rawValue", "build" : "[[[build...|build.html]]]", "buildType" : "[[[buildType...|buildtype.html]]]", "details" : "details", "type" : "type", "user" : "[[[user...|user.html]]]", "properties" : "[[[properties...|properties.html]]]" }
Last modified: 21 October 2021