Retrieve the details of a specific Process Template

GET /seiapi/v3/ProcessTemplates/${TemplateID} 

Retrieve a list of all Process Templates

GET /seiapi/v3/ProcessTemplates

Insert or Update the details of a specific Process Template

PUT /seiapi/v3/ProcessTemplates/${TemplateID}

Bulk Insert or Update the details of specific Process Templates

PUT /seiapi/v3/ProcessTemplates

Delete a specific Process Template

DELETE /seiapi/v3/ProcessTemplates/${TemplateID}

Retrieve the details of a specific Process Template

This REST API will return an Process Template with the specified ID. The Process Template 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 an Process Template Object.

{
	"Desc": {
		"en": ""
	},
	"Seq": 1,
	"TemplateID": "",
	"Template": {},
	"IncludeFields": [],
	"Type": ""
}

Otherwise, on error, the API returns the standard response object.

Retrieve a list of all Process Templates

This REST API will return a list of all Process Templates that exist in the system.

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success, an HTTP status of 200 will be returned, and the response body will contain a collection of Process Template Objects. 

 It is possible for the returned collection to be empty if the system does not have any Process Templates. 

[
	{
		// Process Template Object
	},
	{
		// Process Template Object
	},
	{
		// etc., as required
	}
]

Otherwise, on error, the API returns the standard response object.

Insert or Update the details of a specific Process Template

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

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

URL

HTTP Request Body

The HTTP request body must contain a valid Process Template Object.

Bulk Insert or Update the details of specific Process Templates

This REST API will insert new Process Templates with the specified IDs into the system, if the Process Templates with the specified IDs do not already exist in the system.

If, however, the Process Templates with the specified IDs do already exist in the system, then this REST API will update (i.e. replace) the already existing Process Templates with the specified IDs with the details of the Process Templates supplied in the HTTP Request Body.

URL

HTTP Request Body

The HTTP request body must be a JSON array of one or more Process Template Object definitions.

[
	{
		// Process Template Object
	},
	{
		// Process Template Object
	},
	{
		// etc., as required
	}
]

Delete a specific Process Template

This REST API will delete an Process Template with the specified ID from the system. The Process Template with the specified ID must already exist in the system.

URL

HTTP Request Body

This request does not require a request body.