TeamCity REST API Reference 2024.07 Help

ProgressInfo

An object that stores the latest information about a currently running build. Returns an empty object for finished and queued builds.

Properties

percentageComplete

The current completion rate (in percents).

elapsedSeconds

Time (in seconds) passed since the build actually started. Does not include time spent in queue.

estimatedTotalSeconds

The currently estimated build duration (in seconds). The sum of elapsedSeconds, leftSeconds, and post-build activity duration.

leftSeconds

The estimated remaining build time (in seconds)

currentStageText

The description of the currently performed build stage. Combines the build status with the latest build log message.

outdated

Returns true for history builds. Builds are labeled as outdated (history) if there are finished non-personal builds that processed newer (or same) changes as in this build.

probablyHanging

Returns true if the server suspects this build is hanging. Builds are considered hung when their run duration exceeds the estimates and the build sends no new messages for some time.

lastActivityTime

The timestamp of the latest build log message.

outdatedReasonBuild

Returns the first non-outdated build that processed the same changes as this outdated (history) build.

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.

<progress-info currentStageText="Step 2/2: *** Start reading the project structure ***" elapsedSeconds="152" estimatedTotalSeconds="308" lastActivityTime="20240510T190625+0200" leftSeconds="154" outdated="true" percentageComplete="54" probablyHanging="false"> <outdatedReasonBuild 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...|]]]</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> <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> </outdatedReasonBuild> </progress-info>
{ "estimatedTotalSeconds" : 308, "outdated" : true, "percentageComplete" : 54, "probablyHanging" : false, "outdatedReasonBuild" : { "agent" : "[[[agent...|agent.html]]]", "metadata" : "[[[datas...|datas.html]]]", "triggered" : "[[[TriggeredBy...|triggeredby.html]]]", "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...|]]]", "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]]]" }, "currentStageText" : "Step 2/2: *** Start reading the project structure ***", "lastActivityTime" : "20240510T190625+0200", "elapsedSeconds" : 152, "leftSeconds" : 154 }
Last modified: 23 September 2024