Related | TeamCity REST API Reference

Represents a link to the Builds entity.

Properties

Field	Data type
`builds`	`Builds`

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.

<related>
  <builds count="123" href="string" nextHref="string" prevHref="string">
    <build>[[[build...|build.html]]]</build>
  </builds>
</related>

{
  "builds" : {
    "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]]]"
    } ],
    "count" : 1,
    "prevHref" : "prevHref",
    "href" : "href",
    "nextHref" : "nextHref"
  }
}

Last modified: 26 October 2022