Builds

Last modified: 23 September 2024

Represents a paginated list of Build entities.

Properties

count

tip

Data type: integer
Example: 12

The current number of Build objects in this list.

nextHref

tip

Data type: string
Example: /app/rest/builds?locator=count:200,start:250,state:finished

If the list of returned entities exceeds the request count value, TeamCity splits it into multiple batches. This property returns the endpoint that allows you to obtain the next batch.

prevHref

tip

Data type: string
Example: /app/rest/builds?locator=count:50,start:0,state:finished

If the list of returned entities exceeds the request count value, TeamCity splits it into multiple batches. This property returns the endpoint that allows you to obtain the previous batch.

build

tip

Data type: List<Build>
Example:

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

href

tip

Data type: string
Example: /app/rest/builds?locator=buildType:Project_Config&fields=count,href

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

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.

<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>