Retrieve a list of all Deployment Groups

GET /seiapi/v3/trans/DeploymentGroup

Retrieve the details of a specific Deployment Group

GET /seiapi/v3/trans/DeploymentGroup/${DeploymentGroupID}

Insert or Update the details of a specific Deployment Group

POST /seiapi/v3/trans/DeploymentGroup/${DeploymentGroupID}

Retrieve a list of all Deployment Groups

This REST API will return a list of all Deployment Groups that exist in the system.

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success, an HTTP response code of 200 will be returned, and the response body will contain a collection of Deployment Group Objects. 

 It is possible for the returned collection to be empty if there are no Deployment Groups that exist in the system. 

{
	"DeploymentGroups" : [
		// A collection of zero or more deployment group object.
	]
}

Retrieve the details of a specific Deployment Group

This REST API will return a Deployment Group with the specified ID. The Deployment Group with the specified ID must already exist in the system.

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain a Deployment Group Object. Otherwise, on error, the response body will contain a descriptive reason for the error. 

{
  "DGroupID": "Default",
  "Desc": {
    "en": "Default"
  }
}

Insert or Update the details of a specific Deployment Group

This REST API will insert a new Deployment Group with the specified ID into the system, if a Deployment Group with the specified ID does not already exist in the system.

If, however, the Deployment Group with the specified ID does already exist in the system, then this REST API will update (i.e. replace) the already existing Deployment Group with the specified ID with the details of the Deployment Group supplied in the HTTP Request Body.

URL

HTTP Request Body

The HTTP request body must contain a valid Deployment Group Object.

HTTP Response

On success the API will return a response code of 200.