ProjectApi

Last modified: 04 July 2024

getAllProjects

Get all projects.

Endpoint

GET
/app/rest/projects

Produces

  • application/xml

  • application/json

Parameters

  • locator: string

  • fields: string

Response

Projects

addProject

Create a new project.

Endpoint

POST
/app/rest/projects

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Project

deleteProject

Delete project matching the locator.

Endpoint

DELETE
/app/rest/projects/{projectLocator}

Parameters

getProject

Get project matching the locator.

Endpoint

GET
/app/rest/projects/{projectLocator}

Produces

  • application/xml

  • application/json

Parameters

Response

Project

getAgentPoolsProject

Get agent pools appointed to the matching project.

Endpoint

GET
/app/rest/projects/{projectLocator}/agentPools

Produces

  • application/xml

  • application/json

Parameters

Response

AgentPools

addAgentPoolsProject

Assign the matching project to the agent pool.

Endpoint

POST
/app/rest/projects/{projectLocator}/agentPools

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

AgentPool

setAgentPoolsProject

Update agent pools apppointed to the matching project.

Endpoint

PUT
/app/rest/projects/{projectLocator}/agentPools

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

AgentPools

removeProjectFromAgentPool

Unassign a project from the matching agent pool.

Endpoint

DELETE
/app/rest/projects/{projectLocator}/agentPools/{agentPoolLocator}

Parameters

getAllBranches

Get all branches of the matching project.

Endpoint

GET
/app/rest/projects/{projectLocator}/branches

Produces

  • application/xml

  • application/json

Parameters

Response

Branches

addBuildType

Add a build configuration to the matching project.

Endpoint

POST
/app/rest/projects/{projectLocator}/buildTypes

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

BuildType

removeDefaultTemplate

Remove the default template from the matching project.

Endpoint

DELETE
/app/rest/projects/{projectLocator}/defaultTemplate

Parameters

getDefaultTemplate

Get the default template of the matching project.

Endpoint

GET
/app/rest/projects/{projectLocator}/defaultTemplate

Produces

  • application/xml

  • application/json

Parameters

Response

BuildType

setDefaultTemplate

Update the default template of the matching project.

Endpoint

PUT
/app/rest/projects/{projectLocator}/defaultTemplate

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

BuildType

getDefaultValueSets

getDefaultValueSets

Endpoint

GET
/app/rest/projects/{projectLocator}/defaultValueSets

Produces

  • application/xml

  • application/json

Parameters

Response

TypedValueSets

getDeploymentDashboardsInProject

getDeploymentDashboardsInProjet

Endpoint

GET
/app/rest/projects/{projectLocator}/deploymentDashboards

Produces

  • application/xml

  • application/json

Parameters

Response

DeploymentDashboards

getDeploymentDashboardInProject

getDeploymentDashboardInProject

Endpoint

GET
/app/rest/projects/{projectLocator}/deploymentDashboards/{dashboardLocator}

Produces

  • application/xml

  • application/json

Parameters

Response

DeploymentDashboard

getAllBuildTypesOrdered

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

Endpoint

GET
/app/rest/projects/{projectLocator}/order/buildTypes

Produces

  • application/xml

  • application/json

Parameters

Response

BuildTypes

setBuildTypesOrder

Update custom ordering of build configurations of the matching project.

Endpoint

PUT
/app/rest/projects/{projectLocator}/order/buildTypes

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

BuildTypes

getAllSubprojectsOrdered

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

Endpoint

GET
/app/rest/projects/{projectLocator}/order/projects

Produces

  • application/xml

  • application/json

Parameters

Response

Projects

setSubprojectsOrder

Update custom ordering of subprojects of the matching project.

Endpoint

PUT
/app/rest/projects/{projectLocator}/order/projects

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Projects

deleteBuildParameters

Delete all build parameters.

Endpoint

DELETE
/app/rest/projects/{projectLocator}/parameters

Parameters

getBuildParameters

Get build parameters.

Endpoint

GET
/app/rest/projects/{projectLocator}/parameters

Produces

  • application/xml

  • application/json

Parameters

Response

Properties

createBuildParameter

Create a build parameter.

Endpoint

POST
/app/rest/projects/{projectLocator}/parameters

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Property

updateBuildParameters

Update build parameters.

Endpoint

PUT
/app/rest/projects/{projectLocator}/parameters

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Properties

deleteBuildParameter

Delete build parameter.

Endpoint

DELETE
/app/rest/projects/{projectLocator}/parameters/{name}

Parameters

getBuildParameter

Get build parameter.

Endpoint

GET
/app/rest/projects/{projectLocator}/parameters/{name}

Produces

  • application/xml

  • application/json

Parameters

Response

Property

updateBuildParameter

Update build parameter.

Endpoint

PUT
/app/rest/projects/{projectLocator}/parameters/{name}

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Property

getBuildParameterType

Get type of build parameter.

Endpoint

GET
/app/rest/projects/{projectLocator}/parameters/{name}/type

Produces

  • application/xml

  • application/json

Parameters

Response

Type

updateBuildParameterType

Update type of build parameter.

Endpoint

PUT
/app/rest/projects/{projectLocator}/parameters/{name}/type

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Type

getBuildParameterSpecification

Get build parameter specification.

Endpoint

GET
/app/rest/projects/{projectLocator}/parameters/{name}/type/rawValue

Produces

  • text/plain

Parameters

Response

string

updateBuildParameterSpecification

Update build parameter specification.

Endpoint

PUT
/app/rest/projects/{projectLocator}/parameters/{name}/type/rawValue

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

getBuildParameterValue

Get value of build parameter.

Endpoint

GET
/app/rest/projects/{projectLocator}/parameters/{name}/value

Produces

  • text/plain

Parameters

Response

string

updateBuildParameterValue

Update value of build parameter.

Endpoint

PUT
/app/rest/projects/{projectLocator}/parameters/{name}/value

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

getProjectParentProject

Get the parent project of the matching project.

Endpoint

GET
/app/rest/projects/{projectLocator}/parentProject

Produces

  • application/xml

  • application/json

Parameters

Response

Project

setParentProject

Update the parent project of the matching project.

Endpoint

PUT
/app/rest/projects/{projectLocator}/parentProject

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

Project

getFeatures

Get all features.

Endpoint

GET
/app/rest/projects/{projectLocator}/projectFeatures

Produces

  • application/xml

  • application/json

Parameters

Response

object

addFeature

Add a feature.

Endpoint

POST
/app/rest/projects/{projectLocator}/projectFeatures

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

object

updateFeatures

Update all features.

Endpoint

PUT
/app/rest/projects/{projectLocator}/projectFeatures

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

object

deleteFeature

Delete a matching feature.

Endpoint

DELETE
/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}

Parameters

getFeature

Get a matching feature.

Endpoint

GET
/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}

Produces

  • application/xml

  • application/json

Parameters

Response

object

updateFeature

Update a matching feature.

Endpoint

PUT
/app/rest/projects/{projectLocator}/projectFeatures/{featureLocator}

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

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

POST
/app/rest/projects/{projectLocator}/secure/tokens

Consumes

  • text/plain

Produces

  • text/plain

Parameters

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

GET
/app/rest/projects/{projectLocator}/secure/values/{token}

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string

getProjectSettingsFile

Get the settings file of the matching build configuration.

Endpoint

GET
/app/rest/projects/{projectLocator}/settingsFile

Produces

  • text/plain

Parameters

Response

string

getProjectTemplates

Get all templates of the matching project.

Endpoint

GET
/app/rest/projects/{projectLocator}/templates

Produces

  • application/xml

  • application/json

Parameters

Response

BuildTypes

addTemplate

Add a build configuration template to the matching project.

Endpoint

POST
/app/rest/projects/{projectLocator}/templates

Consumes

  • application/xml

  • application/json

Produces

  • application/xml

  • application/json

Parameters

Response

BuildType

getProjectField

Get a field of the matching project.

Endpoint

GET
/app/rest/projects/{projectLocator}/{field}

Produces

  • text/plain

Parameters

Response

string

setProjectField

Update a field of the matching project.

Endpoint

PUT
/app/rest/projects/{projectLocator}/{field}

Consumes

  • text/plain

Produces

  • text/plain

Parameters

Response

string