DeploymentsResource

A RESTful resource for managing change set deployments. Note: the root-resource path specifies the pipeline ID and environment ID.

The following resources are applicable:

• /pipelines/{pipe}/environments/{env}/deployments
• /pipelines/{pipe}/environments/{env}/deployments/{csid}

/pipelines/{pipe}/environments/{env}/deployments

Mount Point: /pipelines/{pipe}/environments/{env}/deployments

GET

Get the list of change sets deployed to the specified pipeline and environment.

Parameters

name	description	type	default
pipe	the pipeline that the environment is associated with	path
env	the environment in the pipeline to retrieve the deployment for	path

Response Body

element:	deployments
media types:	application/xml text/xml application/json

the list of change set deployments associated with the specified pipeline environment

POST

Creates a change set deployment in the specified pipeline-environment.

Parameters

name	description	type	default
JSESSIONID	The ID of the user session requesting the change set deployment	cookie
pipe	The pipeline id this resource is managing	path
env	The environment in the pipeline to deploy the change set to	path

Request Body

element:	deployment
media types:	application/xml text/xml application/json

The deployment to insert

Response Body

element:	deployment
media types:	application/xml text/xml application/json

The deployment for the specified change set

/pipelines/{pipe}/environments/{env}/deployments/{csid}

Mount Point: /pipelines/{pipe}/environments/{env}/deployments/{csid}

The following operations are supported on this resource:

• GET
• PUT
• DELETE

GET

Get the deployment for the specified change set with the specified pipeline and environment.

Parameters

name	description	type	default
pipe	the pipeline id this resource is managing	path
env	the environment in the pipeline to retrieve the deployment for	path
csid	the change set id to search for	path

Response Body

element:	deployment
media types:	application/xml text/xml application/json

the deployment for the specified change set associated with the specified pipeline environment

PUT

Modifies a change set deployment from the specified pipeline-environment.

Parameters

name	description	type	default
JSESSIONID	The ID of the user session requesting the change set deployment	cookie
pipe	The pipeline id this resource is managing	path
env	The environment in the pipeline to retrieve the deployment for	path
csid	The change set to modify the deployment for	path

Request Body

element:	deployment
media types:	application/xml text/xml application/json

The deployment to update

DELETE

Deletes a change set deployment from the specified pipeline-environment.

Parameters

name	description	type	default
JSESSIONID	The ID of the user session requesting the change set deployment	cookie
pipe	The pipeline ID this resource is managing	path
env	The environment in the pipeline to retrieve the deployment for	path
csid	The change set to unschedule	path