BuildTypeApi

getAllBuildTypes

Get all build configurations.


Endpoint	/app/rest/buildTypes
Produces	`application/xml` `application/json`
Parameters	`locator: string<BuildTypeLocator>` `fields: string`
Response	`BuildTypes`

createBuildType

Create a new build configuration.


Endpoint	/app/rest/buildTypes
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`body: BuildType` `fields: string`
Response	`BuildType`

deleteBuildType

Delete build configuration matching the locator.


Endpoint	/app/rest/buildTypes/{btLocator}
Parameters	`btLocator: string<BuildTypeLocator>`

getBuildType

Get build configuration matching the locator.


Endpoint	/app/rest/buildTypes/{btLocator}
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string`
Response	`BuildType`

getAllAgentRequirements

Get all agent requirements of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/agent-requirements
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string`
Response	`AgentRequirements`

addAgentRequirementToBuildType

Add an agent requirement to the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/agent-requirements
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string` `body: AgentRequirement`
Response	`AgentRequirement`

replaceAllAgentRequirements

Update all agent requirements of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/agent-requirements
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string` `body: AgentRequirements`
Response	`AgentRequirements`

deleteAgentRequirement

Remove an agent requirement of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}
Parameters	`btLocator: string<BuildTypeLocator>` `agentRequirementLocator: string`

getAgentRequirement

Get an agent requirement of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `agentRequirementLocator: string` `fields: string`
Response	`AgentRequirement`

replaceAgentRequirement

Update an agent requirement of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `agentRequirementLocator: string` `fields: string` `body: AgentRequirement`
Response	`AgentRequirement`

getAgentRequirementParameter

Get a setting of an agent requirement of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}/{fieldName}
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `agentRequirementLocator: string` `fieldName: string`
Response	`string`

setAgentRequirementParameter

Update a parameter of an agent requirement of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/agent-requirements/{agentRequirementLocator}/{fieldName}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `agentRequirementLocator: string` `fieldName: string` `body: string`
Response	`string`

getAliases

Get external IDs of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/aliases
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `field: string`
Response	`Items`

getAllArtifactDependencies

Get all artifact dependencies of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/artifact-dependencies
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string`
Response	`ArtifactDependencies`

addArtifactDependencyToBuildType

Add an artifact dependency to the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/artifact-dependencies
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string` `body: ArtifactDependency`
Response	`ArtifactDependency`

replaceAllArtifactDependencies

Update all artifact dependencies of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/artifact-dependencies
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string` `body: ArtifactDependencies`
Response	`ArtifactDependencies`

deleteArtifactDependency

Remove an artifact dependency from the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}
Parameters	`btLocator: string<BuildTypeLocator>` `artifactDepLocator: string`

getArtifactDependency

Get an artifact dependency of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `artifactDepLocator: string` `fields: string`
Response	`ArtifactDependency`

replaceArtifactDependency

Update an artifact dependency of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `artifactDepLocator: string` `fields: string` `body: ArtifactDependency`
Response	`ArtifactDependency`

getArtifactDependencyParameter

Get a parameter of an artifact dependency of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}/{fieldName}
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `artifactDepLocator: string` `fieldName: string`
Response	`string`

setArtifactDependencyParameter

Update a parameter of an artifact dependency of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/artifact-dependencies/{artifactDepLocator}/{fieldName}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `artifactDepLocator: string` `fieldName: string` `body: string`
Response	`string`

getAllBranchesOfBuildType

Get all branches of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/branches
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `locator: string` `fields: string`
Response	`Branches`

getBuildTypeBuildTags

Get tags of builds of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/buildTags
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `field: string`
Response	`Tags`

getBuildTypeBuilds

Get builds of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/builds
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string`
Response	`Builds`

getAllBuildFeatures

Get all build features of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/features
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string`
Response	`Features`

addBuildFeatureToBuildType

Add build feature to the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/features
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string` `body: Feature`
Response	`Feature`

replaceAllBuildFeatures

Update all build features of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/features
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string` `body: Features`
Response	`Features`

deleteFeatureOfBuildType

Remove a build feature of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/features/{featureId}
Parameters	`btLocator: string<BuildTypeLocator>` `featureId: string`

getBuildFeature

Get a build feature of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/features/{featureId}
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `featureId: string` `fields: string`
Response	`Feature`

replaceBuildFeature

Update a build feature of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/features/{featureId}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `featureId: string` `fields: string` `body: Feature`
Response	`Feature`

getAllBuildFeatureParameters

Get all parameters of a build feature of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/features/{featureId}/parameters
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `featureId: string` `fields: string`
Response	`Properties`

replaceBuildFeatureParameters

Update a parameter of a build feature of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/features/{featureId}/parameters
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `featureId: string` `body: Properties` `fields: string`
Response	`Properties`

getBuildFeatureParameter

Get a parameter of a build feature of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/features/{featureId}/parameters/{parameterName}
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `featureId: string` `parameterName: string`
Response	`string`

addParameterToBuildFeature

Update build feature parameter for the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/features/{featureId}/parameters/{parameterName}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `featureId: string` `parameterName: string` `body: string`
Response	`string`

getBuildFeatureSetting

Get the setting of a build feature of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/features/{featureId}/{name}
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `featureId: string` `name: string`
Response	`string`

setBuildFeatureParameter

Update a parameter of a build feature of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/features/{featureId}/{name}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `featureId: string` `name: string` `body: string`
Response	`string`

getAllInvestigationsOfBuildType

Get all investigations of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/investigations
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string`
Response	`Investigations`

deleteBuildParametersOfBuildType

Delete all build parameters.


Endpoint	/app/rest/buildTypes/{btLocator}/parameters
Parameters	`btLocator: string<BuildTypeLocator>`

getBuildParametersOfBuildType

Get build parameters.


Endpoint	/app/rest/buildTypes/{btLocator}/parameters
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `locator: string` `fields: string`
Response	`Properties`

createBuildParameterOfBuildType

Create a build parameter.


Endpoint	/app/rest/buildTypes/{btLocator}/parameters
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `body: Property` `fields: string`
Response	`Property`

updateBuildParametersOfBuildType

Update build parameters.


Endpoint	/app/rest/buildTypes/{btLocator}/parameters
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `body: Properties` `fields: string`
Response	`Properties`

deleteBuildParameterOfBuildType

Delete build parameter.


Endpoint	/app/rest/buildTypes/{btLocator}/parameters/{name}
Parameters	`name: string` `btLocator: string<BuildTypeLocator>`

getBuildParameterOfBuildType

Get build parameter.


Endpoint	/app/rest/buildTypes/{btLocator}/parameters/{name}
Produces	`application/xml` `application/json`
Parameters	`name: string` `btLocator: string<BuildTypeLocator>` `fields: string`
Response	`Property`

updateBuildParameterOfBuildType

Update build parameter.


Endpoint	/app/rest/buildTypes/{btLocator}/parameters/{name}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`name: string` `btLocator: string<BuildTypeLocator>` `body: Property` `fields: string`
Response	`Property`

getBuildParameterTypeOfBuildType

Get type of build parameter.


Endpoint	/app/rest/buildTypes/{btLocator}/parameters/{name}/type
Produces	`application/xml` `application/json`
Parameters	`name: string` `btLocator: string<BuildTypeLocator>`
Response	`Type`

updateBuildParameterTypeOfBuildType

Update type of build parameter.


Endpoint	/app/rest/buildTypes/{btLocator}/parameters/{name}/type
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`name: string` `btLocator: string<BuildTypeLocator>` `body: Type`
Response	`Type`

getBuildParameterSpecificationOfBuildType

Get build parameter specification.


Endpoint	/app/rest/buildTypes/{btLocator}/parameters/{name}/type/rawValue
Produces	`text/plain`
Parameters	`name: string` `btLocator: string<BuildTypeLocator>`
Response	`string`

updateBuildParameterSpecificationOfBuildType

Update build parameter specification.


Endpoint	/app/rest/buildTypes/{btLocator}/parameters/{name}/type/rawValue
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`name: string` `btLocator: string<BuildTypeLocator>` `body: string`
Response	`string`

getBuildParameterValueOfBuildType

Get value of build parameter.


Endpoint	/app/rest/buildTypes/{btLocator}/parameters/{name}/value
Produces	`text/plain`
Parameters	`name: string` `btLocator: string<BuildTypeLocator>`
Response	`string`

updateBuildParameterValueOfBuildType

Update value of build parameter.


Endpoint	/app/rest/buildTypes/{btLocator}/parameters/{name}/value
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`name: string` `btLocator: string<BuildTypeLocator>` `body: string`
Response	`string`

getBuildTypeSettingsFile

Get the settings file of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/settingsFile
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>`
Response	`string`

getAllSnapshotDependencies

Get all snapshot dependencies of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/snapshot-dependencies
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string`
Response	`SnapshotDependencies`

addSnapshotDependencyToBuildType

Add a snapshot dependency to the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/snapshot-dependencies
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string` `body: SnapshotDependency`
Response	`SnapshotDependency`

replaceAllSnapshotDependencies

Update all snapshot dependencies of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/snapshot-dependencies
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string` `body: SnapshotDependencies`
Response	`SnapshotDependencies`

deleteSnapshotDependency

Delete a snapshot dependency of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/snapshot-dependencies/{snapshotDepLocator}
Parameters	`btLocator: string<BuildTypeLocator>` `snapshotDepLocator: string`

getSnapshotDependency

Get a snapshot dependency of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/snapshot-dependencies/{snapshotDepLocator}
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `snapshotDepLocator: string` `fields: string`
Response	`SnapshotDependency`

replaceSnapshotDependency

Update a snapshot dependency of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/snapshot-dependencies/{snapshotDepLocator}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `snapshotDepLocator: string` `fields: string` `body: SnapshotDependency`
Response	`SnapshotDependency`

getAllBuildSteps

Get all build steps of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/steps
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string`
Response	`Steps`

addBuildStepToBuildType

Add a build step to the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/steps
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string` `body: Step`
Response	`Step`

replaceAllBuildSteps

Update all build steps of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/steps
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string` `body: Steps`
Response	`Steps`

deleteBuildStep

Delete a build step of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/steps/{stepId}
Parameters	`btLocator: string<BuildTypeLocator>` `stepId: string`

getBuildStep

Get a build step of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/steps/{stepId}
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `stepId: string` `fields: string`
Response	`Step`

replaceBuildStep

Replace a build step of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/steps/{stepId}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `stepId: string` `fields: string` `body: Step`
Response	`Step`

getAllBuildStepParameters

Get all parameters of a build step of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `stepId: string` `fields: string`
Response	`Properties`

deleteBuildStepParameters

Update a parameter of a build step of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `stepId: string` `body: Properties` `fields: string`
Response	`Properties`

getBuildStepParameter

Get a parameter of a build step of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters/{parameterName}
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `stepId: string` `parameterName: string`
Response	`string`

addParameterToBuildStep

Add a parameter to a build step of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/steps/{stepId}/parameters/{parameterName}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `stepId: string` `parameterName: string` `body: string`
Response	`string`

getBuildStepSetting

Get the setting of a build step of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/steps/{stepId}/{fieldName}
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `stepId: string` `fieldName: string`
Response	`string`

setBuildStepParameter

Update a parameter of a build step of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/steps/{stepId}/{fieldName}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `stepId: string` `fieldName: string` `body: string`
Response	`string`

removeAllTemplates

Detach all templates from the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/templates
Parameters	`btLocator: string<BuildTypeLocator>` `inlineSettings: boolean`

getAllBuildTemplates

Get all build templates of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/templates
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string`
Response	`BuildTypes`

addBuildTemplate

Add a build template to the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/templates
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `body: BuildType` `optimizeSettings: boolean` `fields: string`
Response	`BuildType`

setBuildTypeTemplates

Update all templates of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/templates
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `body: BuildTypes` `optimizeSettings: boolean` `fields: string`
Response	`BuildTypes`

removeTemplate

Detach a template from the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/templates/{templateLocator}
Parameters	`btLocator: string<BuildTypeLocator>` `templateLocator: string<BuildTypeLocator>` `inlineSettings: boolean`

getBuildTemplate

Get a template of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/templates/{templateLocator}
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `templateLocator: string<BuildTypeLocator>` `fields: string`
Response	`BuildType`

getAllTriggers

Get all triggers of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/triggers
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string`
Response	`Triggers`

addTriggerToBuildType

Add a trigger to the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/triggers
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string` `body: Trigger`
Response	`Trigger`

replaceAllTriggers

Update all triggers of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/triggers
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string` `body: Triggers`
Response	`Triggers`

deleteTrigger

Delete a trigger of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}
Parameters	`btLocator: string<BuildTypeLocator>` `triggerLocator: string`

getTrigger

Get a trigger of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `triggerLocator: string` `fields: string`
Response	`Trigger`

replaceTrigger

Update a trigger of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `triggerLocator: string` `fields: string` `body: Trigger`
Response	`Trigger`

getTriggerParameter

Get a parameter of a trigger of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}/{fieldName}
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `triggerLocator: string` `fieldName: string`
Response	`string`

setTriggerParameter

Update a parameter of a trigger of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/triggers/{triggerLocator}/{fieldName}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `triggerLocator: string` `fieldName: string` `body: string`
Response	`string`

getAllVcsRootsOfBuildType

Get all VCS roots of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/vcs-root-entries
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string`
Response	`VcsRootEntries`

addVcsRootToBuildType

Add a VCS root to the matching build.


Endpoint	/app/rest/buildTypes/{btLocator}/vcs-root-entries
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `body: VcsRootEntry` `fields: string`
Response	`VcsRootEntry`

replaceAllVcsRoots

Update all VCS roots of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/vcs-root-entries
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `body: VcsRootEntries` `fields: string`
Response	`VcsRootEntries`

deleteVcsRootOfBuildType

Remove a VCS root of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}
Parameters	`btLocator: string<BuildTypeLocator>` `vcsRootLocator: string<VcsRootLocator>`

getVcsRoot

Get a VCS root of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `vcsRootLocator: string<VcsRootLocator>` `fields: string`
Response	`VcsRootEntry`

updateBuildTypeVcsRoot

Update a VCS root of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/vcs-root-entries/{vcsRootLocator}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `vcsRootLocator: string<VcsRootLocator>` `body: VcsRootEntry` `fields: string`
Response	`VcsRootEntry`

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	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `vcsRootLocator: string<VcsRootLocator>`
Response	`string`

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	`text/plain`
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `vcsRootLocator: string<VcsRootLocator>` `body: string`
Response	`string`

getFilesListOfBuildType

List all files.


Endpoint	/app/rest/buildTypes/{btLocator}/vcs/files/latest
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `basePath: string` `locator: string` `fields: string` `resolveParameters: boolean`
Response	`Files`

getZippedFileOfBuildType

Get specific file zipped.


Endpoint	/app/rest/buildTypes/{btLocator}/vcs/files/latest/archived{path}
Produces	`/`
Parameters	`path: string` `btLocator: string<BuildTypeLocator>` `basePath: string` `locator: string` `name: string` `resolveParameters: boolean`

downloadFileOfBuildType

Download specific file.


Endpoint	/app/rest/buildTypes/{btLocator}/vcs/files/latest/files{path}
Produces	`/`
Parameters	`path: string` `btLocator: string<BuildTypeLocator>` `resolveParameters: boolean`

getFileMetadataOfBuildType

Get metadata of specific file.


Endpoint	/app/rest/buildTypes/{btLocator}/vcs/files/latest/metadata{path}
Produces	`application/xml` `application/json`
Parameters	`path: string` `btLocator: string<BuildTypeLocator>` `fields: string` `resolveParameters: boolean`
Response	`file`

getFilesListForSubpathOfBuildType

List files under this path.


Endpoint	/app/rest/buildTypes/{btLocator}/vcs/files/latest/{path}
Produces	`application/xml` `application/json`
Parameters	`path: string` `btLocator: string<BuildTypeLocator>` `basePath: string` `locator: string` `fields: string` `resolveParameters: boolean`
Response	`Files`

getVcsRootInstancesOfBuildType

Get all VCS root instances of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/vcsRootInstances
Produces	`application/xml` `application/json`
Parameters	`btLocator: string<BuildTypeLocator>` `fields: string`
Response	`VcsRootInstances`

getBuildTypeField

Get a field of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/{field}
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `field: string`
Response	`string`

setBuildTypeField

Update a field of the matching build configuration.


Endpoint	/app/rest/buildTypes/{btLocator}/{field}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`btLocator: string<BuildTypeLocator>` `field: string` `body: string`
Response	`string`

Last modified: 30 March 2022