BuildApi

getAllBuilds

Get all builds.


Endpoint	/app/rest/builds
Produces	`application/xml` `application/json`
Parameters	`locator: string<BuildLocator>` `fields: string`
Response	`Builds`

getAggregatedBuildStatus

Get the build status of aggregated matching builds.


Endpoint	/app/rest/builds/aggregated/{buildLocator}/status
Parameters	`buildLocator: string<BuildLocator>`
Response	`string`

getAggregatedBuildStatusIcon

Get the status icon (in specified format) of aggregated matching builds.


Endpoint	/app/rest/builds/aggregated/{buildLocator}/statusIcon{suffix}
Parameters	`buildLocator: string<BuildLocator>` `suffix: string`

deleteMultipleBuilds

Delete multiple builds matching the locator.


Endpoint	/app/rest/builds/multiple/{buildLocator}
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `fields: string`
Response	`MultipleOperationResult`

getMultipleBuilds

Get multiple builds matching the locator.


Endpoint	/app/rest/builds/multiple/{buildLocator}
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `fields: string`
Response	`Builds`

cancelMultiple

cancelMultipleBuilds


Endpoint	/app/rest/builds/multiple/{buildLocator}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `body: BuildCancelRequest` `fields: string`
Response	`MultipleOperationResult`

deleteMultipleBuildComments

Delete comments of multiple matching builds.


Endpoint	/app/rest/builds/multiple/{buildLocator}/comment
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `fields: string`
Response	`MultipleOperationResult`

setMultipleBuildComments

Update comments in multiple matching builds.


Endpoint	/app/rest/builds/multiple/{buildLocator}/comment
Consumes	`text/plain`
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `body: string` `fields: string`
Response	`MultipleOperationResult`

pinMultipleBuilds

Pin multiple matching builds.


Endpoint	/app/rest/builds/multiple/{buildLocator}/pinInfo
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `body: PinInfo` `fields: string`
Response	`MultipleOperationResult`

removeMultipleBuildTags

Remove tags from multiple matching builds.


Endpoint	/app/rest/builds/multiple/{buildLocator}/tags
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `body: Tags` `fields: string`
Response	`MultipleOperationResult`

addTagsToMultipleBuilds

Add tags to multiple matching builds.


Endpoint	/app/rest/builds/multiple/{buildLocator}/tags
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `body: Tags` `fields: string`
Response	`MultipleOperationResult`

deleteBuild

Delete build matching the locator.


Endpoint	/app/rest/builds/{buildLocator}
Parameters	`buildLocator: string<BuildLocator>`

getBuild

Get build matching the locator.


Endpoint	/app/rest/builds/{buildLocator}
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `fields: string`
Response	`Build`

cancelBuild


Endpoint	/app/rest/builds/{buildLocator}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `body: BuildCancelRequest` `fields: string`
Response	`Build`

getArtifactDependencyChanges

Get artifact dependency changes of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/artifactDependencyChanges
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `fields: string`
Response	`BuildChanges`

getFilesListOfBuild

List all files.


Endpoint	/app/rest/builds/{buildLocator}/artifacts
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `basePath: string` `locator: string` `fields: string` `resolveParameters: boolean` `logBuildUsage: boolean`
Response	`Files`

getZippedFileOfBuild

Get specific file zipped.


Endpoint	/app/rest/builds/{buildLocator}/artifacts/archived{path}
Produces	`/`
Parameters	`path: string` `buildLocator: string<BuildLocator>` `basePath: string` `locator: string` `name: string` `resolveParameters: boolean` `logBuildUsage: boolean`

downloadFileOfBuild

Download specific file.


Endpoint	/app/rest/builds/{buildLocator}/artifacts/files{path}
Produces	`/`
Parameters	`path: string` `buildLocator: string<BuildLocator>` `resolveParameters: boolean` `logBuildUsage: boolean`

getFileMetadataOfBuild

Get metadata of specific file.


Endpoint	/app/rest/builds/{buildLocator}/artifacts/metadata{path}
Produces	`application/xml` `application/json`
Parameters	`path: string` `buildLocator: string<BuildLocator>` `fields: string` `resolveParameters: boolean` `logBuildUsage: boolean`
Response	`file`

getFilesListForSubpathOfBuild

List files under this path.


Endpoint	/app/rest/builds/{buildLocator}/artifacts/{path}
Produces	`application/xml` `application/json`
Parameters	`path: string` `buildLocator: string<BuildLocator>` `basePath: string` `locator: string` `fields: string` `resolveParameters: boolean` `logBuildUsage: boolean`
Response	`Files`

getArtifactsDirectory

Get the artifacts' directory of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/artifactsDirectory
Produces	`text/plain`
Parameters	`buildLocator: string<BuildLocator>`
Response	`string`

resetBuildFinishProperties

Remove build parameters from the matching build.


Endpoint	/app/rest/builds/{buildLocator}/caches/finishProperties
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>`

getCanceledInfo

Check if the matching build is canceled.


Endpoint	/app/rest/builds/{buildLocator}/canceledInfo
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `fields: string`
Response	`Comment`

deleteBuildComment

Remove the build comment matching the locator.


Endpoint	/app/rest/builds/{buildLocator}/comment
Parameters	`buildLocator: string<BuildLocator>`

setBuildComment

Update the comment on the matching build.


Endpoint	/app/rest/builds/{buildLocator}/comment
Consumes	`text/plain`
Parameters	`buildLocator: string<BuildLocator>` `body: string`

setFinishedTime

Marks the running build as finished by passing agent the current time of the build to finish.


Endpoint	/app/rest/builds/{buildLocator}/finish
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`buildLocator: string<BuildLocator>`
Response	`string`

getBuildFinishDate

Get the finish date of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/finishDate
Produces	`text/plain`
Parameters	`buildLocator: string<BuildLocator>`
Response	`string`

setBuildFinishDate

Marks the running build as finished by passing agent the current time of the build to finish.


Endpoint	/app/rest/builds/{buildLocator}/finishDate
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`buildLocator: string<BuildLocator>` `body: string`
Response	`string`

addLogMessageToBuild

Adds a message to the build log. Service messages are accepted.


Endpoint	/app/rest/builds/{buildLocator}/log
Consumes	`text/plain`
Parameters	`buildLocator: string<BuildLocator>` `body: string` `fields: string`

getBuildNumber

Get the number of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/number
Produces	`text/plain`
Parameters	`buildLocator: string<BuildLocator>`
Response	`string`

setBuildNumber

Update the number of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/number
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`buildLocator: string<BuildLocator>` `body: string`
Response	`string`

getBuildPinInfo

Check if the matching build is pinned.


Endpoint	/app/rest/builds/{buildLocator}/pinInfo
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `fields: string`
Response	`PinInfo`

setBuildPinInfo

Update the pin info of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/pinInfo
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `body: PinInfo` `fields: string`
Response	`PinInfo`

getBuildProblems

Get build problems of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/problemOccurrences
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `fields: string`
Response	`ProblemOccurrences`

addProblemToBuild

Add a build problem to the matching build.


Endpoint	/app/rest/builds/{buildLocator}/problemOccurrences
Consumes	`text/plain`
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `body: string` `fields: string`
Response	`ProblemOccurrence`

getBuildRelatedIssues

Get related issues of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/relatedIssues
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `fields: string`
Response	`IssuesUsages`

getBuildResolved

Get the resolvement status of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/resolved/{value}
Produces	`text/plain`
Parameters	`buildLocator: string<BuildLocator>` `value: string`
Response	`string`

getBuildActualParameters

Get actual build parameters of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/resulting-properties
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `fields: string`
Response	`Properties`

getBuildResultingProperties

Update a build parameter of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/resulting-properties/{propertyName}
Produces	`text/plain`
Parameters	`buildLocator: string<BuildLocator>` `propertyName: string`
Response	`string`

markBuildAsRunning

Starts the queued build as an agent-less build and returns the corresponding running build.


Endpoint	/app/rest/builds/{buildLocator}/runningData
Consumes	`text/plain`
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `body: string` `fields: string`
Response	`Build`

getBuildSourceFile

Get a source file of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/sources/files/{fileName}
Produces	`application/octet-stream`
Parameters	`buildLocator: string<BuildLocator>` `fileName: string`

getBuildStatisticValues

Get all statistical values of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/statistics
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `fields: string`
Response	`Properties`

getBuildStatisticValue

Get a statistical value of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/statistics/{name}
Produces	`text/plain`
Parameters	`buildLocator: string<BuildLocator>` `name: string`
Response	`string`

getBuildStatus

Get status of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/status
Produces	`text/plain`
Parameters	`buildLocator: string<BuildLocator>`
Response	`string`

setBuildStatus

Change status of the build.


Endpoint	/app/rest/builds/{buildLocator}/status
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `fields: string` `body: BuildStatusUpdate`

getBuildStatusIcon

Get the status icon (in specified format) of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/statusIcon{suffix}
Parameters	`buildLocator: string<BuildLocator>` `suffix: string`

getBuildStatusText

Get the build status text of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/statusText
Produces	`text/plain`
Parameters	`buildLocator: string<BuildLocator>`
Response	`string`

setBuildStatusText

Update the build status of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/statusText
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`buildLocator: string<BuildLocator>` `body: string`
Response	`string`

getBuildTags

Get tags of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/tags
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `locator: string<TagLocator>` `fields: string`
Response	`Tags`

addTagsToBuild

Add tags to the matching build.


Endpoint	/app/rest/builds/{buildLocator}/tags
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `body: Tags` `fields: string`
Response	`Tags`

setBuildTags

Update tags of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/tags
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `locator: string<TagLocator>` `body: Tags` `fields: string`
Response	`Tags`

getBuildTestOccurrences

Get test occurrences of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/testOccurrences
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `fields: string`
Response	`TestOccurrences`

getBuildVcsLabels

Get VCS labels of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/vcsLabels
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `fields: string`
Response	`VcsLabels`

addBuildVcsLabel

Add a VCS label to the matching build.


Endpoint	/app/rest/builds/{buildLocator}/vcsLabels
Consumes	`text/plain`
Produces	`application/xml` `application/json`
Parameters	`buildLocator: string<BuildLocator>` `locator: string<VcsRootInstanceLocator>` `fields: string` `body: string`
Response	`VcsLabels`

getBuildField

Get a field of the matching build.


Endpoint	/app/rest/builds/{buildLocator}/{field}
Produces	`text/plain`
Parameters	`buildLocator: string<BuildLocator>` `field: string`
Response	`string`

Last modified: 27 March 2024