Templates

Retrieve templates data.

Deprecated

List templates

get

This API version is deprecated and will be removed in future releases. We recommend you to use the V2 version of this API, which is available at /rest/assessments/v2. Returns a list of all available templates. The templates are sorted by name in alphabetical order.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

This API requires Basic HTTP authentication.

Query parameters

namestringOptional

The name of the template.

The value is case-insensitive and it returns results that contain this value.

statusstringOptional

The status of the template.

Possible values are: DRAFT, PUBLISHED or OBSOLETE. The value is case-insensitive. An invalid value results in an error response.

assetTypeIdstring · uuidOptional

The ID of the asset type.

latestVersionOnlybooleanOptional

Whether it should only return the latest version of each template. The interaction with the status parameter is as follows:

• If the status parameter is not set, it returns the latest version of each template regardless of the status.
• If the status parameter is set to PUBLISHED, it returns the latest published version of each template.
• If the status parameter is set to DRAFT, it returns the latest draft version of each template.
• If the status parameter is set to OBSOLETE, it returns the latest obsolete version of each template.

limitinteger · min: 1 · max: 50Optional

The maximum number of resources to retrieve.

If not set, the default limit of 10 is be used. The maximum value for this parameter is 50.

Default: 10

cursorstringOptional

The cursor pointing to the first resource to be included in the response. This cursor cannot be created and must have been extracted from a response returned by a previous API call.

If this parameter is missing, the API returns the resources starting from the first available resource, at index 0.

Responses

200

Example of a response for listing templates.

application/json

A page object containing templates.

nextCursorstringOptional

The cursor pointing to the next page. If the cursor is missing, there are no additional pages of resources available after the current one.

Example: Y3Vyc29yV2hlblRoZXJlSXNNb3JlRGF0YQo

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

500

There was an error processing the request.

application/json

get/templates

HTTPcURLJavaScriptPython

GET /rest/assessments/v1/templates HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "results": []
}

Deprecated

Get Template by ID

get

This API version is deprecated and will be removed in future releases. We recommend you to use the V2 version of this API, which is available at /rest/assessments/v2. Returns the latest published version of a template for the specified template Id.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

This API requires Basic HTTP authentication.

Path parameters

idstring · uuidRequired

The ID of the template.

Responses

200

Example of a response for get template.

application/json

A base template object.

idstring · uuidRequired

The ID of the template.

Example: c8643d4d-f9f8-4484-b9c2-d0f3432e295f

namestringRequired

The name of the template.

Example: Legal Checks

versionintegerRequired

The version of the template.

Example: 1

statusstringRequired

The status of the template.

Example: PUBLISHED

notificationbooleanOptional

Flag to indicate if notifications are on or off for the template.

Example: true

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

There was an error processing the request.

application/json

get/templates/{id}

HTTPcURLJavaScriptPython

GET /rest/assessments/v1/templates/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "c8643d4d-f9f8-4484-b9c2-d0f3432e295f",
  "name": "Legal Checks",
  "version": 1,
  "status": "PUBLISHED",
  "notification": true,
  "assetType": {
    "id": "0b781899-3dd2-4746-bc98-65daef8f1efa",
    "name": "Business Process"
  }
}