TeamCity REST API Reference 2022.10 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> <approvalInfo>[[[approvalInfo...|approvalinfo.html]]]</approvalInfo> <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> <queuedWaitReasons>[[[properties...|properties.html]]]</queuedWaitReasons> <downloadedArtifacts>[[[downloadedArtifacts...|downloadedartifacts.html]]]</downloadedArtifacts> <firstBuildWithSameChanges>[[[build...|build.html]]]</firstBuildWithSameChanges> </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" : { "agent" : "[[[agent...|agent.html]]]", "metadata" : "[[[datas...|datas.html]]]", "triggered" : "[[[TriggeredBy...|triggeredby.html]]]", "usedByOtherBuilds" : true, "settingsHash" : "settingsHash", "number" : "number", "chainModificationId" : "chainModificationId", "changesCollectingInProgress" : true, "lastChanges" : "[[[changes...|changes.html]]]", "resultingProperties" : "[[[properties...|properties.html]]]", "composite" : true, "links" : "[[[links...|links.html]]]", "id" : 2, "state" : "queued", "href" : "href", "detachedFromAgent" : true, "artifacts" : "[[[files...|files.html]]]", "testOccurrences" : "[[[testOccurrences...|testoccurrences.html]]]", "artifactDependencyChanges" : "[[[buildChanges...|buildchanges.html]]]", "defaultBranch" : true, "compatibleAgents" : "[[[agents...|agents.html]]]", "artifact-dependencies" : "[[[builds...|builds.html]]]", "replacementIds" : "[[[items...|items.html]]]", "personal" : true, "history" : true, "tags" : "[[[tags...|tags.html]]]", "canceledInfo" : "[[[comment...|comment.html]]]", "running-info" : "[[[progress-info...|progressinfo.html]]]", "versionedSettingsRevision" : "[[[Revision...|revision.html]]]", "percentageComplete" : 6, "webUrl" : "webUrl", "buildType" : "[[[buildType...|buildtype.html]]]", "triggeringOptions" : "[[[buildTriggeringOptions...|buildtriggeringoptions.html]]]", "locator" : "locator", "startDate" : "startDate", "status" : "status", "pinned" : true, "customized" : true, "approvalInfo" : "[[[approvalInfo...|approvalinfo.html]]]", "vcsLabels" : [ "[[[vcsLabel...|vcslabel.html]]]" ], "customization" : "[[[customizations...|customizations.html]]]", "finishEstimate" : "finishEstimate", "changes" : "[[[changes...|changes.html]]]", "plannedAgent" : "[[[agent...|agent.html]]]", "running" : true, "statusChangeComment" : "[[[comment...|comment.html]]]", "finishOnAgentDate" : "finishOnAgentDate", "buildTypeId" : "buildTypeId", "buildTypeInternalId" : "buildTypeInternalId", "modificationId" : "modificationId", "related" : "[[[related...|related.html]]]", "failedToStart" : true, "revisions" : "[[[Revisions...|revisions.html]]]", "delayedByBuild" : "[[[build...|build.html]]]", "queuePosition" : 5, "problemOccurrences" : "[[[problemOccurrences...|problemoccurrences.html]]]", "artifactsDirectory" : "artifactsDirectory", "relatedIssues" : "[[[issuesUsages...|issuesusages.html]]]", "branchName" : "branchName", "startEstimate" : "startEstimate", "downloadedArtifacts" : "[[[downloadedArtifacts...|downloadedartifacts.html]]]", "limitedChangesCount" : 6, "firstBuildWithSameChanges" : "[[[build...|build.html]]]", "currentSettingsHash" : "currentSettingsHash", "unspecifiedBranch" : true, "queuedWaitReasons" : "[[[properties...|properties.html]]]", "waitReason" : "waitReason", "pinInfo" : "[[[comment...|comment.html]]]", "snapshot-dependencies" : "[[[builds...|builds.html]]]", "statusText" : "statusText", "custom-artifact-dependencies" : "[[[artifact-dependencies...|artifactdependencies.html]]]", "comment" : "[[[comment...|comment.html]]]", "finishDate" : "finishDate", "attributes" : "[[[entries...|entries.html]]]", "user" : "[[[user...|user.html]]]", "queuedDate" : "queuedDate", "taskId" : 6, "properties" : "[[[properties...|properties.html]]]", "statistics" : "[[[properties...|properties.html]]]" }, "buildType" : { "template" : "[[[buildType...|buildtype.html]]]", "paused" : true, "description" : "description", "project" : "[[[project...|project.html]]]", "investigations" : "[[[investigations...|investigations.html]]]", "templateFlag" : true, "type" : "regular", "uuid" : "uuid", "projectInternalId" : "projectInternalId", "internalId" : "internalId", "features" : "[[[features...|features.html]]]", "builds" : "[[[builds...|builds.html]]]", "links" : "[[[links...|links.html]]]", "id" : "id", "href" : "href", "settings" : "[[[properties...|properties.html]]]", "vcsRootInstances" : "[[[vcs-root-instances...|vcsrootinstances.html]]]", "templates" : "[[[buildTypes...|buildtypes.html]]]", "artifact-dependencies" : "[[[artifact-dependencies...|artifactdependencies.html]]]", "compatibleAgents" : "[[[agents...|agents.html]]]", "pauseComment" : "[[[comment...|comment.html]]]", "triggers" : "[[[triggers...|triggers.html]]]", "branches" : "[[[branches...|branches.html]]]", "steps" : "[[[steps...|steps.html]]]", "externalStatusAllowed" : true, "agent-requirements" : "[[[agent-requirements...|agentrequirements.html]]]", "webUrl" : "webUrl", "inherited" : true, "snapshot-dependencies" : "[[[snapshot-dependencies...|snapshotdependencies.html]]]", "name" : "name", "vcs-root-entries" : "[[[vcs-root-entries...|vcsrootentries.html]]]", "projectName" : "projectName", "projectId" : "projectId", "parameters" : "[[[properties...|properties.html]]]", "locator" : "locator" }, "details" : "details", "type" : "type", "user" : { "lastLogin" : "lastLogin", "roles" : { "role" : [ "[[[role...|role.html]]]" ] }, "groups" : { "count" : 5, "group" : [ "[[[group...|group.html]]]" ] }, "hasPassword" : true, "password" : "password", "enabled2FA" : true, "name" : "name", "realm" : "realm", "id" : 5, "href" : "href", "locator" : "locator", "email" : "email", "properties" : { "count" : 6, "property" : [ { "inherited" : true, "name" : "name", "type" : "[[[type...|type.html]]]", "value" : "value" } ], "href" : "href" }, "username" : "username", "avatars" : { "urlToSize80" : "urlToSize80", "urlToSize28" : "urlToSize28", "urlToSize40" : "urlToSize40", "urlToSize32" : "urlToSize32", "urlToSize20" : "urlToSize20", "urlToSize64" : "urlToSize64", "urlToSize56" : "urlToSize56" } }, "properties" : { "count" : 6, "property" : [ { "inherited" : true, "name" : "name", "type" : "[[[type...|type.html]]]", "value" : "value" } ], "href" : "href" } }
Last modified: 30 November 2022