TriggeredBy
Identifies the authority that triggered this build.
Properties
type
Returns the following values depending on the authority that triggered this build:
user if the build was triggered manually in TeamCity UI or via REST API.
snapshotDependency if the build is a part of a build chain and was requested by a downstream build configuration.
vcs if the build was initiated by the VCS Trigger that found new commits in the remote repository.
schedule if the build was initiated by the Schedule Trigger.
finishBuild if the build was initiated by the Finish Build Trigger.
retry if the build was initiated by the Retry Trigger that re-starts failed builds.
details
Optional details regarding the triggering event.
date
The timestamp of the build triggering.
displayText
The summary displayed next to the 'Triggered' line in TeamCity UI. Enumerates authorities that caused this build to run and displays the build's parent configuration name and number.
rawValue
The string representation of the properties array.
user
Identifies the user who initiated a build, directly or indirectly. Indirectly means they initiated another build that eventuated the current one (for example, started a dependent build or triggered a build that failed and was then restarted by the Retry Trigger). Builds initiated by the Schedule Trigger do not have a related user.
build
A separate build that caused this one to run. Can co-exist with the user field: for example, if a user triggered build A that requested (via a snapshot dependency) build B, the latter will have links to both the build A and the user who initiated it.
buildType
The parent build configuration of the build.
properties
The array of name-value pairs containing service information about the triggered build and the events that initiated it.
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="20240515T132432+0200" details="string" displayText="Snapshot dependency; Finish Build Trigger; Pet Clinic / Update Packages, build #27" rawValue="##buildTypeId='bt403' origin='rest' buildId='9543' type='snapshotDependency' userId='1'" type="user">
<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="/Users/John.Doe/.BuildServer/system/artifacts/ProjectName/ConfigName/1337" branchName="sandbox" buildTypeId="ProjectName_BuildConfName" buildTypeInternalId="string" chainModificationId="string" changesCollectingInProgress="false" composite="false" currentSettingsHash="string" customized="true" defaultBranch="true" detachedFromAgent="false" failedToStart="true" finishDate="20240408T162702+0200" finishEstimate="20240409T160130+0200" finishOnAgentDate="20240408T162702+0200" history="true" href="/app/rest/builds/id:8006" id="8134" limitedChangesCount="3" locator="string" modificationId="string" number="54" percentageComplete="123" personal="true" pinned="true" queuePosition="2" queuedDate="20240408T162059+0200" running="true" settingsHash="string" startDate="20240408T162559+0200" startEstimate="20240409T155123+0200" state="queued" status="SUCCESS" statusText="Tests passed: 5, muted: 1" taskId="123456789" unspecifiedBranch="false" usedByOtherBuilds="true" waitReason="There are no idle compatible agents which can run this build" webUrl="https://example.com/app/rest/builds/id:8006">
<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...|]]]</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>
<compatibleCloudImages>[[[cloudImages...|cloudimages.html]]]</compatibleCloudImages>
<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>
<originalProperties>[[[properties...|properties.html]]]</originalProperties>
<startProperties>[[[properties...|properties.html]]]</startProperties>
<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>
<matrixConfiguration>[[[MatrixConfiguration...|matrixconfiguration.html]]]</matrixConfiguration>
<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>
<compatibleCloudImages>[[[cloudImages...|cloudimages.html]]]</compatibleCloudImages>
<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" : "20240515T132432+0200",
"displayText" : "Snapshot dependency; Finish Build Trigger; Pet Clinic / Update Packages, build #27",
"rawValue" : "##buildTypeId='bt403' origin='rest' buildId='9543' type='snapshotDependency' userId='1'",
"build" : {
"agent" : "[[[agent...|agent.html]]]",
"metadata" : "[[[datas...|datas.html]]]",
"triggered" : "[[[TriggeredBy...|]]]",
"usedByOtherBuilds" : true,
"settingsHash" : "settingsHash",
"number" : "54",
"chainModificationId" : "chainModificationId",
"changesCollectingInProgress" : false,
"lastChanges" : "[[[changes...|changes.html]]]",
"resultingProperties" : "[[[properties...|properties.html]]]",
"composite" : false,
"links" : "[[[links...|links.html]]]",
"id" : 8134,
"state" : "queued",
"href" : "/app/rest/builds/id:8006",
"detachedFromAgent" : false,
"compatibleCloudImages" : "[[[cloudImages...|cloudimages.html]]]",
"artifacts" : "[[[files...|files.html]]]",
"testOccurrences" : "[[[testOccurrences...|testoccurrences.html]]]",
"artifactDependencyChanges" : "[[[buildChanges...|buildchanges.html]]]",
"startProperties" : "[[[properties...|properties.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]]]",
"matrixConfiguration" : "[[[MatrixConfiguration...|matrixconfiguration.html]]]",
"running-info" : "[[[progress-info...|progressinfo.html]]]",
"versionedSettingsRevision" : "[[[Revision...|revision.html]]]",
"percentageComplete" : 6,
"webUrl" : "https://example.com/app/rest/builds/id:8006",
"buildType" : "[[[buildType...|buildtype.html]]]",
"triggeringOptions" : "[[[buildTriggeringOptions...|buildtriggeringoptions.html]]]",
"locator" : "locator",
"startDate" : "20240408T162559+0200",
"status" : "SUCCESS",
"pinned" : true,
"customized" : true,
"approvalInfo" : "[[[approvalInfo...|approvalinfo.html]]]",
"vcsLabels" : [ "[[[vcsLabel...|vcslabel.html]]]" ],
"customization" : "[[[customizations...|customizations.html]]]",
"finishEstimate" : "20240409T160130+0200",
"changes" : "[[[changes...|changes.html]]]",
"plannedAgent" : "[[[agent...|agent.html]]]",
"running" : true,
"statusChangeComment" : "[[[comment...|comment.html]]]",
"finishOnAgentDate" : "20240408T162702+0200",
"buildTypeId" : "ProjectName_BuildConfName",
"buildTypeInternalId" : "buildTypeInternalId",
"originalProperties" : "[[[properties...|properties.html]]]",
"modificationId" : "modificationId",
"related" : "[[[related...|related.html]]]",
"failedToStart" : true,
"revisions" : "[[[Revisions...|revisions.html]]]",
"delayedByBuild" : "[[[build...|build.html]]]",
"queuePosition" : 2,
"problemOccurrences" : "[[[problemOccurrences...|problemoccurrences.html]]]",
"artifactsDirectory" : "/Users/John.Doe/.BuildServer/system/artifacts/ProjectName/ConfigName/1337",
"relatedIssues" : "[[[issuesUsages...|issuesusages.html]]]",
"branchName" : "sandbox",
"startEstimate" : "20240409T155123+0200",
"downloadedArtifacts" : "[[[downloadedArtifacts...|downloadedartifacts.html]]]",
"limitedChangesCount" : 3,
"firstBuildWithSameChanges" : "[[[build...|build.html]]]",
"currentSettingsHash" : "currentSettingsHash",
"unspecifiedBranch" : false,
"queuedWaitReasons" : "[[[properties...|properties.html]]]",
"waitReason" : "There are no idle compatible agents which can run this build",
"pinInfo" : "[[[comment...|comment.html]]]",
"snapshot-dependencies" : "[[[builds...|builds.html]]]",
"statusText" : "Tests passed: 5, muted: 1",
"custom-artifact-dependencies" : "[[[artifact-dependencies...|artifactdependencies.html]]]",
"comment" : "[[[comment...|comment.html]]]",
"finishDate" : "20240408T162702+0200",
"attributes" : "[[[entries...|entries.html]]]",
"user" : "[[[user...|user.html]]]",
"queuedDate" : "20240408T162059+0200",
"taskId" : 9,
"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",
"compatibleCloudImages" : "[[[cloudImages...|cloudimages.html]]]",
"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" : "user",
"user" : {
"lastLogin" : "lastLogin",
"roles" : {
"role" : [ "[[[role...|role.html]]]" ]
},
"groups" : {
"count" : 8,
"group" : [ "[[[group...|group.html]]]" ]
},
"hasPassword" : true,
"password" : "password",
"enabled2FA" : true,
"name" : "name",
"realm" : "realm",
"id" : 3,
"href" : "href",
"locator" : "locator",
"email" : "email",
"properties" : {
"count" : 1,
"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" : 1,
"property" : [ {
"inherited" : true,
"name" : "name",
"type" : "[[[type...|type.html]]]",
"value" : "value"
} ],
"href" : "href"
}
}
Last modified: 23 September 2024