BuildTypeApi
getAllBuildTypes
Get all build configurations.
Endpoint | /app/rest/buildTypes |
Produces |
|
Parameters |
|
Response |
createBuildType
Create a new build configuration.
deleteBuildType
Delete build configuration matching the locator.
Endpoint | /app/rest/buildTypes/{btLocator} |
Parameters |
|
getBuildType
Get build configuration matching the locator.
Endpoint | /app/rest/buildTypes/{btLocator} |
Produces |
|
Parameters |
|
Response |
getAllAgentRequirements
Get all agent requirements of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/agent-requirements |
Produces |
|
Parameters |
|
Response |
addAgentRequirementToBuildType
Add an agent requirement to the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/agent-requirements |
Consumes |
|
Produces |
|
Parameters |
|
Response |
replaceAllAgentRequirements
Update all agent requirements of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/agent-requirements |
Consumes |
|
Produces |
|
Parameters |
|
Response |
deleteAgentRequirement
Remove an agent requirement of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator} |
Parameters |
|
getAgentRequirement
Get an agent requirement of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator} |
Produces |
|
Parameters |
|
Response |
replaceAgentRequirement
Update an agent requirement of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
getAgentRequirementParameter
Get a setting of an agent requirement of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}/{fieldName} |
Produces |
|
Parameters |
|
Response |
|
setAgentRequirementParameter
Update a parameter of an agent requirement of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}/{fieldName} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
|
getAliases
Get external IDs of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/aliases |
Produces |
|
Parameters |
|
Response |
getAllArtifactDependencies
Get all artifact dependencies of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/artifact-dependencies |
Produces |
|
Parameters |
|
Response |
addArtifactDependencyToBuildType
Add an artifact dependency to the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/artifact-dependencies |
Consumes |
|
Produces |
|
Parameters |
|
Response |
replaceAllArtifactDependencies
Update all artifact dependencies of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/artifact-dependencies |
Consumes |
|
Produces |
|
Parameters |
|
Response |
deleteArtifactDependency
Remove an artifact dependency from the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator} |
Parameters |
|
getArtifactDependency
Get an artifact dependency of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator} |
Produces |
|
Parameters |
|
Response |
replaceArtifactDependency
Update an artifact dependency of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
getArtifactDependencyParameter
Get a parameter of an artifact dependency of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}/{fieldName} |
Produces |
|
Parameters |
|
Response |
|
setArtifactDependencyParameter
Update a parameter of an artifact dependency of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}/{fieldName} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
|
getAllBranchesOfBuildType
Get all branches of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/branches |
Produces |
|
Parameters |
|
Response |
getBuildTypeBuildTags
Get tags of builds of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/buildTags |
Produces |
|
Parameters |
|
Response |
getBuildTypeBuilds
Get builds of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/builds |
Produces |
|
Parameters |
|
Response |
getAllBuildFeatures
Get all build features of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/features |
Produces |
|
Parameters |
|
Response |
addBuildFeatureToBuildType
Add build feature to the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/features |
Consumes |
|
Produces |
|
Parameters |
|
Response |
replaceAllBuildFeatures
Update all build features of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/features |
Consumes |
|
Produces |
|
Parameters |
|
Response |
deleteFeatureOfBuildType
Remove a build feature of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/features/{featureId} |
Parameters |
|
getBuildFeature
Get a build feature of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/features/{featureId} |
Produces |
|
Parameters |
|
Response |
replaceBuildFeature
Update a build feature of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/features/{featureId} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
getAllBuildFeatureParameters
Get all parameters of a build feature of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/features/{featureId}/parameters |
Produces |
|
Parameters |
|
Response |
replaceBuildFeatureParameters
Update a parameter of a build feature of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/features/{featureId}/parameters |
Consumes |
|
Produces |
|
Parameters |
|
Response |
getBuildFeatureParameter
Get a parameter of a build feature of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/features/{featureId}/parameters/{parameterName} |
Produces |
|
Parameters |
|
Response |
|
addParameterToBuildFeature
Update build feature parameter for the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/features/{featureId}/parameters/{parameterName} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
|
getBuildFeatureSetting
Get the setting of a build feature of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/features/{featureId}/{name} |
Produces |
|
Parameters |
|
Response |
|
setBuildFeatureParameter
Update a parameter of a build feature of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/features/{featureId}/{name} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
|
getAllInvestigationsOfBuildType
Get all investigations of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/investigations |
Produces |
|
Parameters |
|
Response |
moveBuildType
Move build type to another project.
Endpoint | /app/rest/buildTypes/{btLocator}/move |
Produces |
|
Parameters |
|
deleteBuildParametersOfBuildType
Delete all build parameters.
Endpoint | /app/rest/buildTypes/{btLocator}/parameters |
Parameters |
|
getBuildParametersOfBuildType
Get build parameters.
Endpoint | /app/rest/buildTypes/{btLocator}/parameters |
Produces |
|
Parameters |
|
Response |
createBuildParameterOfBuildType
Create a build parameter.
Endpoint | /app/rest/buildTypes/{btLocator}/parameters |
Consumes |
|
Produces |
|
Parameters |
|
Response |
updateBuildParametersOfBuildType
Update build parameters.
Endpoint | /app/rest/buildTypes/{btLocator}/parameters |
Consumes |
|
Produces |
|
Parameters |
|
Response |
deleteBuildParameterOfBuildType
Delete build parameter.
Endpoint | /app/rest/buildTypes/{btLocator}/parameters/{name} |
Parameters |
|
getBuildParameterOfBuildType
Get build parameter.
Endpoint | /app/rest/buildTypes/{btLocator}/parameters/{name} |
Produces |
|
Parameters |
|
Response |
updateBuildParameterOfBuildType
Update build parameter.
Endpoint | /app/rest/buildTypes/{btLocator}/parameters/{name} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
getBuildParameterTypeOfBuildType
Get type of build parameter.
Endpoint | /app/rest/buildTypes/{btLocator}/parameters/{name}/type |
Produces |
|
Parameters |
|
Response |
updateBuildParameterTypeOfBuildType
Update type of build parameter.
Endpoint | /app/rest/buildTypes/{btLocator}/parameters/{name}/type |
Consumes |
|
Produces |
|
Parameters |
|
Response |
getBuildParameterSpecificationOfBuildType
Get build parameter specification.
Endpoint | /app/rest/buildTypes/{btLocator}/parameters/{name}/type/rawValue |
Produces |
|
Parameters |
|
Response |
|
updateBuildParameterSpecificationOfBuildType
Update build parameter specification.
Endpoint | /app/rest/buildTypes/{btLocator}/parameters/{name}/type/rawValue |
Consumes |
|
Produces |
|
Parameters |
|
Response |
|
getBuildParameterValueOfBuildType
Get value of build parameter.
Endpoint | /app/rest/buildTypes/{btLocator}/parameters/{name}/value |
Produces |
|
Parameters |
|
Response |
|
updateBuildParameterValueOfBuildType
Update value of build parameter.
Endpoint | /app/rest/buildTypes/{btLocator}/parameters/{name}/value |
Consumes |
|
Produces |
|
Parameters |
|
Response |
|
getBuildTypeSettingsFile
Get the settings file of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/settingsFile |
Produces |
|
Parameters |
|
Response |
|
getAllSnapshotDependencies
Get all snapshot dependencies of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/snapshot-dependencies |
Produces |
|
Parameters |
|
Response |
addSnapshotDependencyToBuildType
Add a snapshot dependency to the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/snapshot-dependencies |
Consumes |
|
Produces |
|
Parameters |
|
Response |
replaceAllSnapshotDependencies
Update all snapshot dependencies of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/snapshot-dependencies |
Consumes |
|
Produces |
|
Parameters |
|
Response |
deleteSnapshotDependency
Delete a snapshot dependency of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/snapshot-dependencies/{snapshotDepLocator} |
Parameters |
|
getSnapshotDependency
Get a snapshot dependency of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/snapshot-dependencies/{snapshotDepLocator} |
Produces |
|
Parameters |
|
Response |
replaceSnapshotDependency
Update a snapshot dependency of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/snapshot-dependencies/{snapshotDepLocator} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
getAllBuildSteps
Get all build steps of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/steps |
Produces |
|
Parameters |
|
Response |
addBuildStepToBuildType
Add a build step to the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/steps |
Consumes |
|
Produces |
|
Parameters |
|
Response |
replaceAllBuildSteps
Update all build steps of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/steps |
Consumes |
|
Produces |
|
Parameters |
|
Response |
deleteBuildStep
Delete a build step of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/steps/{stepId} |
Parameters |
|
getBuildStep
Get a build step of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/steps/{stepId} |
Produces |
|
Parameters |
|
Response |
replaceBuildStep
Replace a build step of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/steps/{stepId} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
getAllBuildStepParameters
Get all parameters of a build step of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters |
Produces |
|
Parameters |
|
Response |
deleteBuildStepParameters
Update a parameter of a build step of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters |
Consumes |
|
Produces |
|
Parameters |
|
Response |
getBuildStepParameter
Get a parameter of a build step of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters/{parameterName} |
Produces |
|
Parameters |
|
Response |
|
addParameterToBuildStep
Add a parameter to a build step of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters/{parameterName} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
|
getBuildStepSetting
Get the setting of a build step of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/steps/{stepId}/{fieldName} |
Produces |
|
Parameters |
|
Response |
|
setBuildStepParameter
Update a parameter of a build step of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/steps/{stepId}/{fieldName} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
|
removeAllTemplates
Detach all templates from the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/templates |
Parameters |
|
getAllBuildTemplates
Get all build templates of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/templates |
Produces |
|
Parameters |
|
Response |
addBuildTemplate
Add a build template to the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/templates |
Consumes |
|
Produces |
|
Parameters |
|
Response |
setBuildTypeTemplates
Update all templates of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/templates |
Consumes |
|
Produces |
|
Parameters |
|
Response |
removeTemplate
Detach a template from the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/templates/{templateLocator} |
Parameters |
|
getBuildTemplate
Get a template of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/templates/{templateLocator} |
Produces |
|
Parameters |
|
Response |
getAllTriggers
Get all triggers of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/triggers |
Produces |
|
Parameters |
|
Response |
addTriggerToBuildType
Add a trigger to the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/triggers |
Consumes |
|
Produces |
|
Parameters |
|
Response |
replaceAllTriggers
Update all triggers of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/triggers |
Consumes |
|
Produces |
|
Parameters |
|
Response |
deleteTrigger
Delete a trigger of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/triggers/{triggerLocator} |
Parameters |
|
getTrigger
Get a trigger of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/triggers/{triggerLocator} |
Produces |
|
Parameters |
|
Response |
replaceTrigger
Update a trigger of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/triggers/{triggerLocator} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
getTriggerParameter
Get a parameter of a trigger of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}/{fieldName} |
Produces |
|
Parameters |
|
Response |
|
setTriggerParameter
Update a parameter of a trigger of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}/{fieldName} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
|
getAllVcsRootsOfBuildType
Get all VCS roots of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/vcs-root-entries |
Produces |
|
Parameters |
|
Response |
addVcsRootToBuildType
Add a VCS root to the matching build.
Endpoint | /app/rest/buildTypes/{btLocator}/vcs-root-entries |
Consumes |
|
Produces |
|
Parameters |
|
Response |
replaceAllVcsRoots
Update all VCS roots of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/vcs-root-entries |
Consumes |
|
Produces |
|
Parameters |
|
Response |
deleteVcsRootOfBuildType
Remove a VCS root of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator} |
Parameters |
|
getVcsRoot
Get a VCS root of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator} |
Produces |
|
Parameters |
|
Response |
updateBuildTypeVcsRoot
Update a VCS root of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
getVcsRootCheckoutRules
Get checkout rules of a VCS root of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}/checkout-rules |
Produces |
|
Parameters |
|
Response |
|
updateBuildTypeVcsRootCheckoutRules
Update checkout rules of a VCS root of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}/checkout-rules |
Consumes |
|
Produces |
|
Parameters |
|
Response |
|
getFilesListOfBuildType
List all files.
Endpoint | /app/rest/buildTypes/{btLocator}/vcs/files/latest |
Produces |
|
Parameters |
|
Response |
getZippedFileOfBuildType
Get specific file zipped.
Endpoint | /app/rest/buildTypes/{btLocator}/vcs/files/latest/archived{path} |
Produces |
|
Parameters |
|
downloadFileOfBuildType
Download specific file.
Endpoint | /app/rest/buildTypes/{btLocator}/vcs/files/latest/files{path} |
Produces |
|
Parameters |
|
getFileMetadataOfBuildType
Get metadata of specific file.
Endpoint | /app/rest/buildTypes/{btLocator}/vcs/files/latest/metadata{path} |
Produces |
|
Parameters |
|
Response |
|
getFilesListForSubpathOfBuildType
List files under this path.
Endpoint | /app/rest/buildTypes/{btLocator}/vcs/files/latest/{path} |
Produces |
|
Parameters |
|
Response |
getVcsRootInstancesOfBuildType
Get all VCS root instances of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/vcsRootInstances |
Produces |
|
Parameters |
|
Response |
getBuildTypeField
Get a field of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/{field} |
Produces |
|
Parameters |
|
Response |
|
setBuildTypeField
Update a field of the matching build configuration.
Endpoint | /app/rest/buildTypes/{btLocator}/{field} |
Consumes |
|
Produces |
|
Parameters |
|
Response |
|