Branches

Represents a list of Branch entities.

Properties

count

The current number of Branch objects in this list.

href

The relative link (without the server URL) used to retrieve this object.

branch

The list of branches owned by this collection that satisfy the given locator.

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.

<branches count="4" href="/app/rest/buildTypes/MyProject_MyBuildConfig/branches">
  <branch>[[[branch...|branch.html]]]</branch>
</branches>

{
  "count" : 4,
  "href" : "/app/rest/buildTypes/MyProject_MyBuildConfig/branches",
  "branch" : [ {
    "internalName" : "<default>",
    "default" : true,
    "unspecified" : false,
    "name" : "main",
    "builds" : {
      "build" : [ {
        "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...|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" : 3,
        "properties" : "[[[properties...|properties.html]]]",
        "statistics" : "[[[properties...|properties.html]]]"
      } ],
      "count" : 12,
      "prevHref" : "/app/rest/builds?locator=count:50,start:0,state:finished",
      "href" : "/app/rest/builds?locator=buildType:Project_Config&fields=count,href",
      "nextHref" : "/app/rest/builds?locator=count:200,start:250,state:finished"
    },
    "active" : true,
    "lastActivity" : "20240426T123848+0200",
    "groupFlag" : false
  } ]
}

Last modified: 04 July 2024