BranchVersion

Last modified: 14 March 2025

An object that describes the actual state of a repository branch. Inherits the majority of its properties from the base Branch class.

Properties

version

tip

Data type: string
Example: c1046c4fa016a774253fb3b93e6cc8bd12c159e5

The full revision SHA. Points to the latest commit in this branch.

groupFlag

tip

Data type: boolean
Example: false

Returns true if the branch belongs to the automatically created 'My Branches' group; otherwise, false. Branch grouping allows TeamCity to automatically categorize branches based on current TeamCity user commits.

builds

tip

Data type: Builds
Example:

Returns all builds that target this branch.

lastActivity

tip

Data type: string
Example: 20240426T123848+0200

Returns the date and time of the last branch activity (the last TeamCity build or the latest VCS commit).

unspecified

tip

Data type: boolean
Example: false

Returns true for unspecified branches; otherwise, false. A branch is labeled as unspecified when TeamCity fails to find a branch for this build. Such branches have a predefined '<unspecified>' name.

name

tip

Data type: string
Example: main

A public branch name displayed in TeamCity UI. To get a full VCS name instead (for example, 'refs/heads/main'), read the vcsBranchName property of a nested Revision entity.

default

tip

Data type: boolean
Example: true

Returns true if this branch is the default branch of this build configuration; otherwise, false. When obtaining builds of the specific BuildType, add the branch(default:any) locator to get builds from all existing branches.

active

tip

Data type: boolean
Example: true

Returns true for active branches and false for inactive ones. A branch is considered inactive if it had neither new TeamCity builds in the last 24 hours, nor recent VCS repository changes in the last 7 days. Learn more: Active branches.

internalName

tip

Data type: string
Example: &lt;default&gt;

An internal branch name. Returns `<default>` for default branches, and real branch names for other (non-default) branches.

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.

<branchVersion active="true" default="true" groupFlag="false" internalName="&amp;lt;default&amp;gt;" lastActivity="20240426T123848+0200" name="main" unspecified="false" version="c1046c4fa016a774253fb3b93e6cc8bd12c159e5">
  <builds count="12" href="/app/rest/builds?locator=buildType:Project_Config&amp;fields=count,href" nextHref="/app/rest/builds?locator=count:200,start:250,state:finished" prevHref="/app/rest/builds?locator=count:50,start:0,state:finished">
    <build>build...</build>
  </builds>
</branchVersion>