Complete Assessment

post

https://customer-my-onetrust-com.ezproxy.lincoln.ac.nz/api/assessment/v1/assessments/{assessmentId}/review

Use this API to complete review of an assessment using any active result option. This action will move the assessment to the Completed stage.

🗒
Things to Know

The assessment must first be submitted for review before using this API. This can be done using the Submit Assessment API.

Only active assessment result options can be used to complete assessments.

Path Params

assessmentId

string

required

ID of the assessment. assessmentId can be
retrieved by calling the Get Assessment
Results
API.

Body Params

Assessment Closure Request

closureComment

string

The comment about the assessment result.

excludeRules

boolean

Flag that indicates if the template-level rules will be triggered or not upon invoking the APIs, i.e. Create Risk or Send Assessment.

forceOverride

boolean

This should be used if there are multiple approvers on the assessment. If true, this will bypass other approver’s reviews and move the assessment to Completed status.

resultId

string

required

ID of the assessment result option used to complete the assessment. Only Active result options can be used to complete assessments. This value is obtained from the Get List of Assessment Results API.

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found