ProgressInfo
An object that stores the latest information about a currently running build. Returns an empty object for finished and queued builds.
tip
Data type:
integer
Example:54
The current completion rate (in percents).
tip
Data type:
long
Example:152
Time (in seconds) passed since the build actually started. Does not include time spent in queue.
tip
Data type:
long
Example:308
The currently estimated build duration (in seconds). The sum of elapsedSeconds
, leftSeconds
, and post-build activity duration.
tip
Data type:
long
Example:154
The estimated remaining build time (in seconds)
tip
Data type:
string
Example:Step 2/2: *** Start reading the project structure ***
The description of the currently performed build stage. Combines the build status with the latest build log message.
tip
Data type:
boolean
Example:true
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.
tip
Data type:
boolean
Example:false
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.
tip
Data type:
string
Example:20240510T190625+0200
The timestamp of the latest build log message.
tip
Data type:
Build
Example:
Returns the first non-outdated build that processed the same changes as this outdated (history) build.
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>
<buildType>buildType...</buildType>
<comment>comment...</comment>
<tags>tags...</tags>
<pinInfo>comment...</pinInfo>
<user>user...</user>
<delayedByBuild>build...</delayedByBuild>
<plannedAgent>agent...</plannedAgent>
<approvalInfo>approvalInfo...</approvalInfo>
<running-info>progress-info...</running-info>
<canceledInfo>comment...</canceledInfo>
<triggered>TriggeredBy...</triggered>
<lastChanges>changes...</lastChanges>
<changes>changes...</changes>
<revisions>Revisions...</revisions>
<versionedSettingsRevision>Revision...</versionedSettingsRevision>
<artifactDependencyChanges>buildChanges...</artifactDependencyChanges>
<agent>agent...</agent>
<compatibleAgents>agents...</compatibleAgents>
<compatibleCloudImages>cloudImages...</compatibleCloudImages>
<testOccurrences>testOccurrences...</testOccurrences>
<problemOccurrences>problemOccurrences...</problemOccurrences>
<artifacts>files...</artifacts>
<relatedIssues>issuesUsages...</relatedIssues>
<properties>properties...</properties>
<resultingProperties>properties...</resultingProperties>
<originalProperties>properties...</originalProperties>
<startProperties>properties...</startProperties>
<attributes>entries...</attributes>
<statistics>properties...</statistics>
<metadata>datas...</metadata>
<snapshot-dependencies>builds...</snapshot-dependencies>
<artifact-dependencies>builds...</artifact-dependencies>
<custom-artifact-dependencies>artifact-dependencies...</custom-artifact-dependencies>
<replacementIds>items...</replacementIds>
<related>related...</related>
<triggeringOptions>buildTriggeringOptions...</triggeringOptions>
<statusChangeComment>comment...</statusChangeComment>
<vcsLabels>vcsLabel...</vcsLabels>
<customization>customizations...</customization>
<queuedWaitReasons>properties...</queuedWaitReasons>
<downloadedArtifacts>downloadedArtifacts...</downloadedArtifacts>
<matrixConfiguration>MatrixConfiguration...</matrixConfiguration>
<firstBuildWithSameChanges>build...</firstBuildWithSameChanges>
</outdatedReasonBuild>
</progress-info>
{
"estimatedTotalSeconds" : 308,
"outdated" : true,
"percentageComplete" : 54,
"probablyHanging" : false,
"outdatedReasonBuild" : {
"agent" : "agent...",
"metadata" : "datas...",
"triggered" : "TriggeredBy...",
"usedByOtherBuilds" : true,
"settingsHash" : "settingsHash",
"number" : "54",
"chainModificationId" : "chainModificationId",
"changesCollectingInProgress" : false,
"lastChanges" : "changes...",
"resultingProperties" : "properties...",
"composite" : false,
"links" : "links...",
"id" : 8134,
"state" : "queued",
"href" : "/app/rest/builds/id:8006",
"detachedFromAgent" : false,
"compatibleCloudImages" : "cloudImages...",
"artifacts" : "files...",
"testOccurrences" : "testOccurrences...",
"artifactDependencyChanges" : "buildChanges...",
"startProperties" : "properties...",
"defaultBranch" : true,
"compatibleAgents" : "agents...",
"artifact-dependencies" : "builds...",
"replacementIds" : "items...",
"personal" : true,
"history" : true,
"tags" : "tags...",
"canceledInfo" : "comment...",
"matrixConfiguration" : "MatrixConfiguration...",
"running-info" : "progress-info...",
"versionedSettingsRevision" : "Revision...",
"percentageComplete" : 6,
"webUrl" : "https://example.com/app/rest/builds/id:8006",
"buildType" : "buildType...",
"triggeringOptions" : "buildTriggeringOptions...",
"locator" : "locator",
"startDate" : "20240408T162559+0200",
"status" : "SUCCESS",
"pinned" : true,
"customized" : true,
"approvalInfo" : "approvalInfo...",
"vcsLabels" : [ "vcsLabel..." ],
"customization" : "customizations...",
"finishEstimate" : "20240409T160130+0200",
"changes" : "changes...",
"plannedAgent" : "agent...",
"running" : true,
"statusChangeComment" : "comment...",
"finishOnAgentDate" : "20240408T162702+0200",
"buildTypeId" : "ProjectName_BuildConfName",
"buildTypeInternalId" : "buildTypeInternalId",
"originalProperties" : "properties...",
"modificationId" : "modificationId",
"related" : "related...",
"failedToStart" : true,
"revisions" : "Revisions...",
"delayedByBuild" : "build...",
"queuePosition" : 2,
"problemOccurrences" : "problemOccurrences...",
"artifactsDirectory" : "/Users/John.Doe/.BuildServer/system/artifacts/ProjectName/ConfigName/1337",
"relatedIssues" : "issuesUsages...",
"branchName" : "sandbox",
"startEstimate" : "20240409T155123+0200",
"downloadedArtifacts" : "downloadedArtifacts...",
"limitedChangesCount" : 3,
"firstBuildWithSameChanges" : "build...",
"currentSettingsHash" : "currentSettingsHash",
"unspecifiedBranch" : false,
"queuedWaitReasons" : "properties...",
"waitReason" : "There are no idle compatible agents which can run this build",
"pinInfo" : "comment...",
"snapshot-dependencies" : "builds...",
"statusText" : "Tests passed: 5, muted: 1",
"custom-artifact-dependencies" : "artifact-dependencies...",
"comment" : "comment...",
"finishDate" : "20240408T162702+0200",
"attributes" : "entries...",
"user" : "user...",
"queuedDate" : "20240408T162059+0200",
"taskId" : 9,
"properties" : "properties...",
"statistics" : "properties..."
},
"currentStageText" : "Step 2/2: *** Start reading the project structure ***",
"lastActivityTime" : "20240510T190625+0200",
"elapsedSeconds" : 152,
"leftSeconds" : 154
}
Thanks for your feedback!