TeamCity 2021.1 Help

Build

Represents a build instance.

Properties

FieldData typeAllowed values

id

long

taskId

long

buildTypeId

string

buildTypeInternalId

string

number

string

status

string

state

string

  • queued
  • finished
  • running
  • deleted
  • unknown

running

boolean

composite

boolean

failedToStart

boolean

personal

boolean

percentageComplete

integer

branchName

string

defaultBranch

boolean

unspecifiedBranch

boolean

history

boolean

pinned

boolean

href

string

webUrl

string

queuePosition

integer

limitedChangesCount

integer

artifactsDirectory

string

links

Links

statusText

string

buildType

BuildType

comment

Comment

tags

Tags

pinInfo

Comment

user

User

startEstimate

string

waitReason

string

finishEstimate

string

running-info

ProgressInfo

canceledInfo

Comment

queuedDate

string

startDate

string

finishDate

string

triggered

TriggeredBy

lastChanges

Changes

changes

Changes

revisions

Revisions

versionedSettingsRevision

Revision

artifactDependencyChanges

BuildChanges

agent

Agent

compatibleAgents

Agents

testOccurrences

TestOccurrences

problemOccurrences

ProblemOccurrences

artifacts

Files

relatedIssues

IssuesUsages

properties

Properties

resultingProperties

Properties

attributes

Entries

statistics

Properties

metadata

Datas

snapshot-dependencies

Builds

artifact-dependencies

Builds

custom-artifact-dependencies

ArtifactDependencies

settingsHash

string

currentSettingsHash

string

modificationId

string

chainModificationId

string

replacementIds

Items

related

Related

triggeringOptions

BuildTriggeringOptions

usedByOtherBuilds

boolean

statusChangeComment

Comment

vcsLabels

List<VcsLabel>

detachedFromAgent

boolean

finishOnAgentDate

string

customized

boolean

customization

Customizations

locator

string

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.

<build artifactsDirectory="string" branchName="string" buildTypeId="string" buildTypeInternalId="string" chainModificationId="string" 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 count="123"> <link>[[[link...|link.html]]]</link> </links> <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> </buildType> <comment text="string" timestamp="string"> <user>[[[user...|user.html]]]</user> </comment> <tags count="123"> <tag>[[[tag...|tag.html]]]</tag> </tags> <pinInfo text="string" timestamp="string"> <user>[[[user...|user.html]]]</user> </pinInfo> <user email="string" 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> </user> <running-info currentStageText="string" elapsedSeconds="123456789" estimatedTotalSeconds="123456789" lastActivityTime="string" leftSeconds="123456789" outdated="true" percentageComplete="123" probablyHanging="true"> <outdatedReasonBuild>[[[build...|build.html]]]</outdatedReasonBuild> </running-info> <canceledInfo text="string" timestamp="string"> <user>[[[user...|user.html]]]</user> </canceledInfo> <triggered date="string" details="string" displayText="string" rawValue="string" type="string"> <user>[[[user...|user.html]]]</user> <build>[[[build...|build.html]]]</build> <buildType>[[[buildType...|buildtype.html]]]</buildType> <properties>[[[properties...|properties.html]]]</properties> </triggered> <lastChanges count="123" href="string" nextHref="string" prevHref="string"> <change>[[[change...|change.html]]]</change> </lastChanges> <changes count="123" href="string" nextHref="string" prevHref="string"> <change>[[[change...|change.html]]]</change> </changes> <revisions count="123"> <revision>[[[Revision...|revision.html]]]</revision> </revisions> <versionedSettingsRevision checkout-rules="string" internalVersion="string" vcsBranchName="string" version="string"> <vcs-root-instance>[[[vcs-root-instance...|vcsrootinstance.html]]]</vcs-root-instance> </versionedSettingsRevision> <artifactDependencyChanges count="123"> <buildChange>[[[buildChange...|buildchange.html]]]</buildChange> </artifactDependencyChanges> <agent authorized="true" connected="true" cpuRank="123" currentAgentVersion="string" disconnectionComment="string" enabled="true" host="string" href="string" id="123" idleSinceTime="string" ip="string" javaOutdated="true" lastActivityTime="string" locator="string" name="string" outdated="true" pluginsOutdated="true" port="123" protocol="string" registrationTimestamp="string" typeId="123" uptodate="true" version="string" webUrl="string"> <build>[[[build...|build.html]]]</build> <links>[[[links...|links.html]]]</links> <enabledInfo>[[[enabledInfo...|enabledinfo.html]]]</enabledInfo> <authorizedInfo>[[[authorizedInfo...|authorizedinfo.html]]]</authorizedInfo> <properties>[[[properties...|properties.html]]]</properties> <cloudInstance>[[[cloudInstance...|cloudinstance.html]]]</cloudInstance> <cloudImage>[[[cloudImage...|cloudimage.html]]]</cloudImage> <environment>[[[environment...|environment.html]]]</environment> <pool>[[[agentPool...|agentpool.html]]]</pool> <compatibilityPolicy>[[[compatibilityPolicy...|compatibilitypolicy.html]]]</compatibilityPolicy> <compatibleBuildTypes>[[[buildTypes...|buildtypes.html]]]</compatibleBuildTypes> <incompatibleBuildTypes>[[[compatibilities...|compatibilities.html]]]</incompatibleBuildTypes> <builds>[[[builds...|builds.html]]]</builds> </agent> <compatibleAgents count="123" href="string" nextHref="string" prevHref="string"> <agent>[[[agent...|agent.html]]]</agent> </compatibleAgents> <testOccurrences count="123" failed="123" href="string" ignored="123" muted="123" newFailed="123" nextHref="string" passed="123" prevHref="string"> <testOccurrence>[[[testOccurrence...|testoccurrence.html]]]</testOccurrence> <testCounters>[[[testCounters...|testcounters.html]]]</testCounters> </testOccurrences> <problemOccurrences count="123" failed="123" href="string" ignored="123" muted="123" newFailed="123" nextHref="string" passed="123" prevHref="string"> <problemOccurrence>[[[problemOccurrence...|problemoccurrence.html]]]</problemOccurrence> </problemOccurrences> <artifacts count="123" href="string"> <file>[[[file...|file.html]]]</file> </artifacts> <relatedIssues count="123" href="string"> <issueUsage>[[[IssueUsage...|issueusage.html]]]</issueUsage> </relatedIssues> <properties count="123" href="string"> <property>[[[property...|property.html]]]</property> </properties> <resultingProperties count="123" href="string"> <property>[[[property...|property.html]]]</property> </resultingProperties> <attributes count="123"> <entry>[[[entry...|entry.html]]]</entry> </attributes> <statistics count="123" href="string"> <property>[[[property...|property.html]]]</property> </statistics> <metadata count="123"> <data>[[[metaData...|metadata.html]]]</data> </metadata> <snapshot-dependencies count="123" href="string" nextHref="string" prevHref="string"> <build>[[[build...|build.html]]]</build> </snapshot-dependencies> <artifact-dependencies count="123" href="string" nextHref="string" prevHref="string"> <build>[[[build...|build.html]]]</build> </artifact-dependencies> <custom-artifact-dependencies count="123" replace="string"> <artifact-dependency>[[[artifact-dependency...|artifactdependency.html]]]</artifact-dependency> </custom-artifact-dependencies> <replacementIds item="string"/> <related> <builds>[[[builds...|builds.html]]]</builds> </related> <triggeringOptions cleanSources="true" cleanSourcesInAllDependencies="true" freezeSettings="true" queueAtTop="true" rebuildAllDependencies="true" rebuildFailedOrIncompleteDependencies="true" tagDependencies="true"> <rebuildDependencies>[[[buildTypes...|buildtypes.html]]]</rebuildDependencies> </triggeringOptions> <statusChangeComment text="string" timestamp="string"> <user>[[[user...|user.html]]]</user> </statusChangeComment> <vcsLabels>[[[vcsLabel...|vcslabel.html]]]</vcsLabels> <customization artifactDependencies="Map{}" changes="Map{}" parameters="Map{}"/> </build>
{ "agent" : { "disconnectionComment" : "disconnectionComment", "idleSinceTime" : "idleSinceTime", "enabledInfo" : "[[[enabledInfo...|enabledinfo.html]]]", "cpuRank" : 0, "enabled" : true, "compatibleBuildTypes" : "[[[buildTypes...|buildtypes.html]]]", "protocol" : "unidirectional", "outdated" : true, "authorized" : true, "host" : "host", "builds" : "[[[builds...|builds.html]]]", "links" : "[[[links...|links.html]]]", "id" : 9, "href" : "href", "cloudImage" : "[[[cloudImage...|cloudimage.html]]]", "authorizedInfo" : "[[[authorizedInfo...|authorizedinfo.html]]]", "incompatibleBuildTypes" : "[[[compatibilities...|compatibilities.html]]]", "uptodate" : true, "ip" : "ip", "pool" : "[[[agentPool...|agentpool.html]]]", "cloudInstance" : "[[[cloudInstance...|cloudinstance.html]]]", "version" : "version", "connected" : true, "currentAgentVersion" : "currentAgentVersion", "compatibilityPolicy" : "[[[compatibilityPolicy...|compatibilitypolicy.html]]]", "registrationTimestamp" : "registrationTimestamp", "environment" : "[[[environment...|environment.html]]]", "pluginsOutdated" : true, "port" : 5, "build" : "[[[build...|build.html]]]", "webUrl" : "webUrl", "name" : "name", "typeId" : 8, "lastActivityTime" : "lastActivityTime", "locator" : "locator", "properties" : "[[[properties...|properties.html]]]", "javaOutdated" : true }, "metadata" : { "data" : [ "[[[metaData...|metadata.html]]]" ], "count" : 7 }, "triggered" : { "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]]]" }, "usedByOtherBuilds" : true, "settingsHash" : "settingsHash", "number" : "number", "chainModificationId" : "chainModificationId", "lastChanges" : { "change" : [ { "date" : "date", "vcsRootInstance" : "[[[vcs-root-instance...|vcsrootinstance.html]]]", "personal" : true, "storesProjectSettings" : true, "type" : "type", "version" : "version", "webUrl" : "webUrl", "registrationDate" : "registrationDate", "files" : "[[[FileChanges...|filechanges.html]]]", "parentRevisions" : "[[[items...|items.html]]]", "internalVersion" : "internalVersion", "comment" : "comment", "attributes" : "[[[properties...|properties.html]]]", "id" : 6, "href" : "href", "user" : "[[[user...|user.html]]]", "locator" : "locator", "parentChanges" : "[[[changes...|changes.html]]]", "username" : "username" } ], "count" : 9, "prevHref" : "prevHref", "href" : "href", "nextHref" : "nextHref" }, "resultingProperties" : { "count" : 7, "property" : [ "[[[property...|property.html]]]" ], "href" : "href" }, "composite" : true, "links" : { "count" : 3, "link" : [ "[[[link...|link.html]]]" ] }, "id" : 3, "state" : "queued", "href" : "href", "detachedFromAgent" : true, "artifacts" : { "file" : [ "[[[file...|file.html]]]" ], "count" : 4, "href" : "href" }, "testOccurrences" : { "ignored" : 3, "newFailed" : 5, "count" : 8, "testOccurrence" : [ "[[[testOccurrence...|testoccurrence.html]]]" ], "prevHref" : "prevHref", "href" : "href", "failed" : 7, "passed" : 3, "muted" : 9, "testCounters" : "[[[testCounters...|testcounters.html]]]", "nextHref" : "nextHref" }, "artifactDependencyChanges" : { "buildChange" : [ "[[[buildChange...|buildchange.html]]]" ], "count" : 3 }, "defaultBranch" : true, "compatibleAgents" : { "agent" : [ "[[[agent...|agent.html]]]" ], "count" : 5, "prevHref" : "prevHref", "href" : "href", "nextHref" : "nextHref" }, "artifact-dependencies" : { "build" : [ "[[[build...|build.html]]]" ], "count" : 4, "prevHref" : "prevHref", "href" : "href", "nextHref" : "nextHref" }, "replacementIds" : { "item" : [ "item" ] }, "personal" : true, "history" : true, "tags" : { "count" : 6, "tag" : [ "[[[tag...|tag.html]]]" ] }, "canceledInfo" : { "text" : "text", "user" : "[[[user...|user.html]]]", "timestamp" : "timestamp" }, "running-info" : { "estimatedTotalSeconds" : 9, "outdated" : true, "percentageComplete" : 4, "probablyHanging" : true, "outdatedReasonBuild" : "[[[build...|build.html]]]", "currentStageText" : "currentStageText", "lastActivityTime" : "lastActivityTime", "elapsedSeconds" : 8, "leftSeconds" : 1 }, "versionedSettingsRevision" : { "vcsBranchName" : "vcsBranchName", "vcs-root-instance" : { "lastVersion" : "lastVersion", "vcsRootInternalId" : "vcsRootInternalId", "commitHookMode" : true, "vcs-root" : { "vcsRootInstances" : "[[[vcs-root-instances...|vcsrootinstances.html]]]", "project" : "[[[project...|project.html]]]", "projectLocator" : "projectLocator", "uuid" : "uuid", "modificationCheckInterval" : 1, "internalId" : "internalId", "name" : "name", "vcsName" : "vcsName", "id" : "id", "href" : "href", "locator" : "locator", "properties" : "[[[properties...|properties.html]]]", "repositoryIdStrings" : "[[[items...|items.html]]]" }, "projectLocator" : "projectLocator", "modificationCheckInterval" : 4, "lastVersionInternal" : "lastVersionInternal", "name" : "name", "vcsName" : "vcsName", "vcs-root-id" : "vcs-root-id", "id" : "id", "href" : "href", "properties" : { "count" : 7, "property" : [ "[[[property...|property.html]]]" ], "href" : "href" }, "status" : { "current" : "[[[VcsCheckStatus...|vcscheckstatus.html]]]", "previous" : "[[[VcsCheckStatus...|vcscheckstatus.html]]]" }, "repositoryState" : { "count" : 4, "branch" : [ "[[[branchVersion...|branchversion.html]]]" ], "timestamp" : "timestamp" }, "repositoryIdStrings" : { "item" : [ "item" ] } }, "checkout-rules" : "checkout-rules", "internalVersion" : "internalVersion", "version" : "version" }, "percentageComplete" : 2, "webUrl" : "webUrl", "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]]]", "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" }, "triggeringOptions" : { "cleanSources" : true, "rebuildFailedOrIncompleteDependencies" : true, "queueAtTop" : true, "cleanSourcesInAllDependencies" : true, "rebuildDependencies" : "[[[buildTypes...|buildtypes.html]]]", "tagDependencies" : true, "rebuildAllDependencies" : true, "freezeSettings" : true }, "locator" : "locator", "startDate" : "startDate", "status" : "status", "pinned" : true, "customized" : true, "vcsLabels" : [ { "failureReason" : "failureReason", "vcs-root-instance" : "[[[vcs-root-instance...|vcsrootinstance.html]]]", "buildId" : 9, "text" : "text", "status" : "none" } ], "customization" : { "changes" : { "key" : "changes" }, "artifactDependencies" : { "key" : "artifactDependencies" }, "parameters" : { "key" : "parameters" } }, "finishEstimate" : "finishEstimate", "changes" : { "change" : [ { "date" : "date", "vcsRootInstance" : "[[[vcs-root-instance...|vcsrootinstance.html]]]", "personal" : true, "storesProjectSettings" : true, "type" : "type", "version" : "version", "webUrl" : "webUrl", "registrationDate" : "registrationDate", "files" : "[[[FileChanges...|filechanges.html]]]", "parentRevisions" : "[[[items...|items.html]]]", "internalVersion" : "internalVersion", "comment" : "comment", "attributes" : "[[[properties...|properties.html]]]", "id" : 6, "href" : "href", "user" : "[[[user...|user.html]]]", "locator" : "locator", "parentChanges" : "[[[changes...|changes.html]]]", "username" : "username" } ], "count" : 9, "prevHref" : "prevHref", "href" : "href", "nextHref" : "nextHref" }, "running" : true, "statusChangeComment" : { "text" : "text", "user" : "[[[user...|user.html]]]", "timestamp" : "timestamp" }, "finishOnAgentDate" : "finishOnAgentDate", "buildTypeId" : "buildTypeId", "buildTypeInternalId" : "buildTypeInternalId", "modificationId" : "modificationId", "related" : { "builds" : "[[[builds...|builds.html]]]" }, "failedToStart" : true, "revisions" : { "count" : 7, "revision" : [ { "vcsBranchName" : "vcsBranchName", "vcs-root-instance" : { "lastVersion" : "lastVersion", "vcsRootInternalId" : "vcsRootInternalId", "commitHookMode" : true, "vcs-root" : { "vcsRootInstances" : "[[[vcs-root-instances...|vcsrootinstances.html]]]", "project" : "[[[project...|project.html]]]", "projectLocator" : "projectLocator", "uuid" : "uuid", "modificationCheckInterval" : 1, "internalId" : "internalId", "name" : "name", "vcsName" : "vcsName", "id" : "id", "href" : "href", "locator" : "locator", "properties" : "[[[properties...|properties.html]]]", "repositoryIdStrings" : "[[[items...|items.html]]]" }, "projectLocator" : "projectLocator", "modificationCheckInterval" : 4, "lastVersionInternal" : "lastVersionInternal", "name" : "name", "vcsName" : "vcsName", "vcs-root-id" : "vcs-root-id", "id" : "id", "href" : "href", "properties" : { "count" : 7, "property" : [ "[[[property...|property.html]]]" ], "href" : "href" }, "status" : { "current" : "[[[VcsCheckStatus...|vcscheckstatus.html]]]", "previous" : "[[[VcsCheckStatus...|vcscheckstatus.html]]]" }, "repositoryState" : { "count" : 4, "branch" : [ "[[[branchVersion...|branchversion.html]]]" ], "timestamp" : "timestamp" }, "repositoryIdStrings" : { "item" : [ "item" ] } }, "checkout-rules" : "checkout-rules", "internalVersion" : "internalVersion", "version" : "version" } ] }, "queuePosition" : 1, "problemOccurrences" : { "ignored" : 3, "newFailed" : 2, "count" : 7, "prevHref" : "prevHref", "problemOccurrence" : [ "[[[problemOccurrence...|problemoccurrence.html]]]" ], "href" : "href", "passed" : 0, "failed" : 3, "muted" : 8, "nextHref" : "nextHref" }, "artifactsDirectory" : "artifactsDirectory", "relatedIssues" : { "issueUsage" : [ "[[[IssueUsage...|issueusage.html]]]" ], "count" : 0, "href" : "href" }, "branchName" : "branchName", "startEstimate" : "startEstimate", "limitedChangesCount" : 8, "currentSettingsHash" : "currentSettingsHash", "unspecifiedBranch" : true, "waitReason" : "waitReason", "pinInfo" : { "text" : "text", "user" : "[[[user...|user.html]]]", "timestamp" : "timestamp" }, "snapshot-dependencies" : { "build" : [ "[[[build...|build.html]]]" ], "count" : 4, "prevHref" : "prevHref", "href" : "href", "nextHref" : "nextHref" }, "statusText" : "statusText", "custom-artifact-dependencies" : { "artifact-dependency" : [ "[[[artifact-dependency...|artifactdependency.html]]]" ], "count" : 2, "replace" : "replace" }, "comment" : { "text" : "text", "user" : "[[[user...|user.html]]]", "timestamp" : "timestamp" }, "finishDate" : "finishDate", "attributes" : { "entry" : [ "[[[entry...|entry.html]]]" ], "count" : 0 }, "user" : { "lastLogin" : "lastLogin", "roles" : { "role" : [ "[[[role...|role.html]]]" ] }, "groups" : { "count" : 4, "group" : [ "[[[group...|group.html]]]" ] }, "hasPassword" : true, "password" : "password", "name" : "name", "realm" : "realm", "id" : 8, "href" : "href", "locator" : "locator", "email" : "email", "properties" : { "count" : 7, "property" : [ "[[[property...|property.html]]]" ], "href" : "href" }, "username" : "username" }, "queuedDate" : "queuedDate", "taskId" : 0, "properties" : { "count" : 7, "property" : [ "[[[property...|property.html]]]" ], "href" : "href" }, "statistics" : { "count" : 7, "property" : [ "[[[property...|property.html]]]" ], "href" : "href" } }
Last modified: 25 May 2021