ProjectApi

getAllProjects

Get all projects.


Endpoint	/app/rest/projects
Produces	`application/xml` `application/json`
Parameters	`locator: string` `fields: string`
Response	`Projects`

addProject

Create a new project.


Endpoint	/app/rest/projects
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`body: NewProjectDescription`
Response	`Project`

deleteProject

Delete project matching the locator.


Endpoint	/app/rest/projects/{projectLocator}
Parameters	`projectLocator: string<ProjectLocator>`

getProject

Get project matching the locator.


Endpoint	/app/rest/projects/{projectLocator}
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `fields: string`
Response	`Project`

getAgentPoolsProject

Get agent pools appointed to the matching project.


Endpoint	/app/rest/projects/{projectLocator}/agentPools
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `fields: string`
Response	`AgentPools`

addAgentPoolsProject

Assign the matching project to the agent pool.


Endpoint	/app/rest/projects/{projectLocator}/agentPools
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `body: AgentPool`
Response	`AgentPool`

setAgentPoolsProject

Update agent pools apppointed to the matching project.


Endpoint	/app/rest/projects/{projectLocator}/agentPools
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `body: AgentPools` `fields: string`
Response	`AgentPools`

removeProjectFromAgentPool

Unassign a project from the matching agent pool.


Endpoint	/app/rest/projects/{projectLocator}/agentPools/{agentPoolLocator}
Parameters	`projectLocator: string<ProjectLocator>` `agentPoolLocator: string`

getAllBranches

Get all branches of the matching project.


Endpoint	/app/rest/projects/{projectLocator}/branches
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `locator: string` `fields: string`
Response	`Branches`

addBuildType

Add a build configuration to the matching project.


Endpoint	/app/rest/projects/{projectLocator}/buildTypes
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `body: NewBuildTypeDescription` `fields: string`
Response	`BuildType`

removeDefaultTemplate

Remove the default template from the matching project.


Endpoint	/app/rest/projects/{projectLocator}/defaultTemplate
Parameters	`projectLocator: string<ProjectLocator>` `fields: string`

getDefaultTemplate

Get the default template of the matching project.


Endpoint	/app/rest/projects/{projectLocator}/defaultTemplate
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `fields: string`
Response	`BuildType`

setDefaultTemplate

Update the default template of the matching project.


Endpoint	/app/rest/projects/{projectLocator}/defaultTemplate
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `body: BuildType` `fields: string`
Response	`BuildType`

getDefaultValueSets


Endpoint	/app/rest/projects/{projectLocator}/defaultValueSets
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `fields: string`
Response	`TypedValueSets`

getDeploymentDashboardsInProject

getDeploymentDashboardsInProjet


Endpoint	/app/rest/projects/{projectLocator}/deploymentDashboards
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `fields: string`
Response	`DeploymentDashboards`

getDeploymentDashboardInProject


Endpoint	/app/rest/projects/{projectLocator}/deploymentDashboards/{dashboardLocator}
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `dashboardLocator: string<DeploymentDashboardLocator>` `fields: string`
Response	`DeploymentDashboard`

getAllBuildTypesOrdered

Get all build configurations from the matching project, with custom ordering applied.


Endpoint	/app/rest/projects/{projectLocator}/order/buildTypes
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `field: string`
Response	`BuildTypes`

setBuildTypesOrder

Update custom ordering of build configurations of the matching project.


Endpoint	/app/rest/projects/{projectLocator}/order/buildTypes
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `body: BuildTypes` `field: string`
Response	`BuildTypes`

getAllSubprojectsOrdered

Get all subprojects of the matching project, with custom ordering applied.


Endpoint	/app/rest/projects/{projectLocator}/order/projects
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `field: string`
Response	`Projects`

setSubprojectsOrder

Update custom ordering of subprojects of the matching project.


Endpoint	/app/rest/projects/{projectLocator}/order/projects
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `body: Projects` `field: string`
Response	`Projects`

deleteBuildParameters

Delete all build parameters.


Endpoint	/app/rest/projects/{projectLocator}/parameters
Parameters	`projectLocator: string<ProjectLocator>`

getBuildParameters

Get build parameters.


Endpoint	/app/rest/projects/{projectLocator}/parameters
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `locator: string` `fields: string`
Response	`Properties`

createBuildParameter

Create a build parameter.


Endpoint	/app/rest/projects/{projectLocator}/parameters
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `body: Property` `fields: string`
Response	`Property`

updateBuildParameters

Update build parameters.


Endpoint	/app/rest/projects/{projectLocator}/parameters
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `body: Properties` `fields: string`
Response	`Properties`

deleteBuildParameter

Delete build parameter.


Endpoint	/app/rest/projects/{projectLocator}/parameters/{name}
Parameters	`name: string` `projectLocator: string<ProjectLocator>`

getBuildParameter

Get build parameter.


Endpoint	/app/rest/projects/{projectLocator}/parameters/{name}
Produces	`application/xml` `application/json`
Parameters	`name: string` `projectLocator: string<ProjectLocator>` `fields: string`
Response	`Property`

updateBuildParameter

Update build parameter.


Endpoint	/app/rest/projects/{projectLocator}/parameters/{name}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`name: string` `projectLocator: string<ProjectLocator>` `body: Property` `fields: string`
Response	`Property`

getBuildParameterType

Get type of build parameter.


Endpoint	/app/rest/projects/{projectLocator}/parameters/{name}/type
Produces	`application/xml` `application/json`
Parameters	`name: string` `projectLocator: string<ProjectLocator>`
Response	`Type`

updateBuildParameterType

Update type of build parameter.


Endpoint	/app/rest/projects/{projectLocator}/parameters/{name}/type
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`name: string` `projectLocator: string<ProjectLocator>` `body: Type`
Response	`Type`

getBuildParameterSpecification

Get build parameter specification.


Endpoint	/app/rest/projects/{projectLocator}/parameters/{name}/type/rawValue
Produces	`text/plain`
Parameters	`name: string` `projectLocator: string<ProjectLocator>`
Response	`string`

updateBuildParameterSpecification

Update build parameter specification.


Endpoint	/app/rest/projects/{projectLocator}/parameters/{name}/type/rawValue
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`name: string` `projectLocator: string<ProjectLocator>` `body: string`
Response	`string`

getBuildParameterValue

Get value of build parameter.


Endpoint	/app/rest/projects/{projectLocator}/parameters/{name}/value
Produces	`text/plain`
Parameters	`name: string` `projectLocator: string<ProjectLocator>`
Response	`string`

updateBuildParameterValue

Update value of build parameter.


Endpoint	/app/rest/projects/{projectLocator}/parameters/{name}/value
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`name: string` `projectLocator: string<ProjectLocator>` `body: string`
Response	`string`

getProjectParentProject

Get the parent project of the matching project.


Endpoint	/app/rest/projects/{projectLocator}/parentProject
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `fields: string`
Response	`Project`

setParentProject

Update the parent project of the matching project.


Endpoint	/app/rest/projects/{projectLocator}/parentProject
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `body: Project` `fields: string`
Response	`Project`

getFeatures

Get all features.


Endpoint	/app/rest/projects/{projectLocator}/projectFeatures
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `locator: string` `fields: string`
Response	`object`

addFeature

Add a feature.


Endpoint	/app/rest/projects/{projectLocator}/projectFeatures
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `body: ProjectFeature` `fields: string`
Response	`object`

updateFeatures

Update all features.


Endpoint	/app/rest/projects/{projectLocator}/projectFeatures
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `body: ProjectFeatures` `fields: string`
Response	`object`

deleteFeature

Delete a matching feature.


Endpoint	/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}
Parameters	`featureLocator: string` `projectLocator: string<ProjectLocator>`

getFeature

Get a matching feature.


Endpoint	/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}
Produces	`application/xml` `application/json`
Parameters	`featureLocator: string` `projectLocator: string<ProjectLocator>` `fields: string`
Response	`object`

updateFeature

Update a matching feature.


Endpoint	/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`featureLocator: string` `projectLocator: string<ProjectLocator>` `body: ProjectFeature` `fields: string`
Response	`object`

addSecureToken

Creates a new secure token to store the sensitive value passed in the request body. Returns the scrambled value that is the new token name. This operation is available only for users with the EDIT_PROJECT permission (included in the Project Administrator role by default).


Endpoint	/app/rest/projects/{projectLocator}/secure/tokens
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`projectLocator: string<ProjectLocator>` `body: string`
Response	`string`

getSecureValue

Returns the value of the given secure token.This operation is available only for users with the CHANGE_SERVER_SETTINGS permission (included only in System Administrator role by default).


Endpoint	/app/rest/projects/{projectLocator}/secure/values/{token}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`projectLocator: string<ProjectLocator>` `token: string`
Response	`string`

getProjectSettingsFile

Get the settings file of the matching build configuration.


Endpoint	/app/rest/projects/{projectLocator}/settingsFile
Produces	`text/plain`
Parameters	`projectLocator: string<ProjectLocator>`
Response	`string`

getProjectTemplates

Get all templates of the matching project.


Endpoint	/app/rest/projects/{projectLocator}/templates
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `fields: string`
Response	`BuildTypes`

addTemplate

Add a build configuration template to the matching project.


Endpoint	/app/rest/projects/{projectLocator}/templates
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`projectLocator: string<ProjectLocator>` `body: NewBuildTypeDescription` `fields: string`
Response	`BuildType`

getProjectField

Get a field of the matching project.


Endpoint	/app/rest/projects/{projectLocator}/{field}
Produces	`text/plain`
Parameters	`projectLocator: string<ProjectLocator>` `field: string`
Response	`string`

setProjectField

Update a field of the matching project.


Endpoint	/app/rest/projects/{projectLocator}/{field}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`projectLocator: string<ProjectLocator>` `field: string` `body: string`
Response	`string`

Last modified: 04 July 2024