Retrieve the details of a specific UI Template

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

Retrieve a list of all UI Templates

GET /seiapi/v3/UITemplates

Insert or Update the details of a specific UI Template

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

Bulk Insert or Update the details of specific UI Templates

PUT /seiapi/v3/UITemplates

Delete a specific UI Template

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

Retrieve the details of a specific UI Template

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

This REST API will return a list of all UI 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 UI Template Object. 

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

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

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

Insert or Update the details of a specific UI Template

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

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

URL

HTTP Request Body

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

Bulk Insert or Update the details of specific UI Templates

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

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

URL

HTTP Request Body

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

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

Delete a specific UI Template

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

URL

HTTP Request Body

This request does not require a request body.