latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

Assessments

List assessments

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 assessments that you created; and the assessments that you are permitted to view. The assessments are sorted by lastModifiedOn in descending order, with the most recent first.

get/assessments

Query parameters

namestring

The name of the assessment.

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

statusstring

The status of the assessment.

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

lastModifiedFromstring date-time

The date and time that defines the start of the period when the assessment was last updated, including this timestamp.

lastModifiedUntilstring date-time

The date and time that defines the end of the period when the assessment was last updated, excluding this timestamp.

templateIdstring uuid

The ID of the template.

templateVersionstring

The version of the template.

Use LATEST to retrieve assessments that are on the latest version of a particular templateId. For other values, it returns results that have an exact match.

assetIdstring uuid

The ID of the asset the assessment relates to.

limitinteger

This is the maximum number of results that may be returned. Fewer may be returned than the value of <code>limit</code>.

Do not depend on the number of results being fewer than the <code>limit</code> value to indicate that your query reached the end of the list of data, use the absence of <code>after</code> (see Cursors) instead. For example, if you set <code>limit</code> to 10 and 9 results are returned, there may be more data available.

If not set, the default limit (limit = <code>25</code>) will be used. The maximum value for this parameter is <code>500</code>.

cursorstring

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.

Response

Example of a response for listing assessments.

nextCursorstring

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