BuildApi
getAllBuilds
Get all builds.
Endpoint | /app/rest/builds
|
Produces |
|
Parameters |
|
Response |
getAggregatedBuildStatus
Get the build status of aggregated matching builds.
Endpoint | /app/rest/builds/aggregated/{buildLocator}/status
|
Parameters |
|
Response |
|
getAggregatedBuildStatusIcon
Get the status icon (in specified format) of aggregated matching builds.
Endpoint | /app/rest/builds/aggregated/{buildLocator}/statusIcon{suffix}
|
Parameters |
|
deleteMultipleBuilds
Delete multiple builds matching the locator.
Endpoint | /app/rest/builds/multiple/{buildLocator}
|
Produces |
|
Parameters |
|
Response |
getMultipleBuilds
Get multiple builds matching the locator.
Endpoint | /app/rest/builds/multiple/{buildLocator}
|
Produces |
|
Parameters |
|
Response |
cancelMultiple
cancelMultipleBuilds
Endpoint | /app/rest/builds/multiple/{buildLocator}
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
deleteMultipleBuildComments
Delete comments of multiple matching builds.
Endpoint | /app/rest/builds/multiple/{buildLocator}/comment
|
Produces |
|
Parameters |
|
Response |
setMultipleBuildComments
Update comments in multiple matching builds.
Endpoint | /app/rest/builds/multiple/{buildLocator}/comment
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
pinMultipleBuilds
Pin multiple matching builds.
Endpoint | /app/rest/builds/multiple/{buildLocator}/pinInfo
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
removeMultipleBuildTags
Remove tags from multiple matching builds.
Endpoint | /app/rest/builds/multiple/{buildLocator}/tags
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
addTagsToMultipleBuilds
Add tags to multiple matching builds.
Endpoint | /app/rest/builds/multiple/{buildLocator}/tags
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
deleteBuild
Delete build matching the locator.
Endpoint | /app/rest/builds/{buildLocator}
|
Parameters |
|
getBuild
Get build matching the locator.
Endpoint | /app/rest/builds/{buildLocator}
|
Produces |
|
Parameters |
|
Response |
cancelBuild
cancelBuild
Endpoint | /app/rest/builds/{buildLocator}
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
getArtifactDependencyChanges
Get artifact dependency changes of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/artifactDependencyChanges
|
Produces |
|
Parameters |
|
Response |
getFilesListOfBuild
List all files.
Endpoint | /app/rest/builds/{buildLocator}/artifacts
|
Produces |
|
Parameters |
|
Response |
getZippedFileOfBuild
Get specific file zipped.
Endpoint | /app/rest/builds/{buildLocator}/artifacts/archived{path}
|
Produces |
|
Parameters |
|
downloadFileOfBuild
Download specific file.
Endpoint | /app/rest/builds/{buildLocator}/artifacts/files{path}
|
Produces |
|
Parameters |
|
getFileMetadataOfBuild
Get metadata of specific file.
Endpoint | /app/rest/builds/{buildLocator}/artifacts/metadata{path}
|
Produces |
|
Parameters |
|
Response |
|
getFilesListForSubpathOfBuild
List files under this path.
Endpoint | /app/rest/builds/{buildLocator}/artifacts/{path}
|
Produces |
|
Parameters |
|
Response |
getArtifactsDirectory
Get the artifacts' directory of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/artifactsDirectory
|
Produces |
|
Parameters |
|
Response |
|
resetBuildFinishProperties
Remove build parameters from the matching build.
Endpoint | /app/rest/builds/{buildLocator}/caches/finishProperties
|
Produces |
|
Parameters |
|
getCanceledInfo
Check if the matching build is canceled.
Endpoint | /app/rest/builds/{buildLocator}/canceledInfo
|
Produces |
|
Parameters |
|
Response |
deleteBuildComment
Remove the build comment matching the locator.
Endpoint | /app/rest/builds/{buildLocator}/comment
|
Parameters |
|
setBuildComment
Update the comment on the matching build.
Endpoint | /app/rest/builds/{buildLocator}/comment
|
Consumes |
|
Parameters |
|
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 |
|
Produces |
|
Parameters |
|
Response |
|
getBuildFinishDate
Get the finish date of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/finishDate
|
Produces |
|
Parameters |
|
Response |
|
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 |
|
Produces |
|
Parameters |
|
Response |
|
addLogMessageToBuild
Adds a message to the build log. Service messages are accepted.
Endpoint | /app/rest/builds/{buildLocator}/log
|
Consumes |
|
Parameters |
|
getBuildNumber
Get the number of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/number
|
Produces |
|
Parameters |
|
Response |
|
setBuildNumber
Update the number of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/number
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
|
getBuildPinInfo
Check if the matching build is pinned.
Endpoint | /app/rest/builds/{buildLocator}/pinInfo
|
Produces |
|
Parameters |
|
Response |
setBuildPinInfo
Update the pin info of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/pinInfo
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
getBuildProblems
Get build problems of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/problemOccurrences
|
Produces |
|
Parameters |
|
Response |
addProblemToBuild
Add a build problem to the matching build.
Endpoint | /app/rest/builds/{buildLocator}/problemOccurrences
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
getBuildRelatedIssues
Get related issues of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/relatedIssues
|
Produces |
|
Parameters |
|
Response |
getBuildResolved
Get the resolvement status of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/resolved/{value}
|
Produces |
|
Parameters |
|
Response |
|
getBuildActualParameters
Get actual build parameters of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/resulting-properties
|
Produces |
|
Parameters |
|
Response |
getBuildResultingProperties
Update a build parameter of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/resulting-properties/{propertyName}
|
Produces |
|
Parameters |
|
Response |
|
markBuildAsRunning
Starts the queued build as an agent-less build and returns the corresponding running build.
Endpoint | /app/rest/builds/{buildLocator}/runningData
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
getBuildSourceFile
Get a source file of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/sources/files/{fileName}
|
Produces |
|
Parameters |
|
getBuildStatisticValues
Get all statistical values of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/statistics
|
Produces |
|
Parameters |
|
Response |
getBuildStatisticValue
Get a statistical value of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/statistics/{name}
|
Produces |
|
Parameters |
|
Response |
|
getBuildStatus
Get status of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/status
|
Produces |
|
Parameters |
|
Response |
|
setBuildStatus
Change status of the build.
Endpoint | /app/rest/builds/{buildLocator}/status
|
Consumes |
|
Produces |
|
Parameters |
|
getBuildStatusIcon
Get the status icon (in specified format) of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/statusIcon{suffix}
|
Parameters |
|
getBuildStatusText
Get the build status text of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/statusText
|
Produces |
|
Parameters |
|
Response |
|
setBuildStatusText
Update the build status of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/statusText
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
|
getBuildTags
Get tags of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/tags
|
Produces |
|
Parameters |
|
Response |
addTagsToBuild
Add tags to the matching build.
Endpoint | /app/rest/builds/{buildLocator}/tags
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
setBuildTags
Update tags of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/tags
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
getBuildTestOccurrences
Get test occurrences of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/testOccurrences
|
Produces |
|
Parameters |
|
Response |
getBuildVcsLabels
Get VCS labels of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/vcsLabels
|
Produces |
|
Parameters |
|
Response |
addBuildVcsLabel
Add a VCS label to the matching build.
Endpoint | /app/rest/builds/{buildLocator}/vcsLabels
|
Consumes |
|
Produces |
|
Parameters |
|
Response |
getBuildField
Get a field of the matching build.
Endpoint | /app/rest/builds/{buildLocator}/{field}
|
Produces |
|
Parameters |
|
Response |
|