Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Assessment Actions

Complete Assessment

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.
post/api/assessment/v1/assessments/{assessmentId}/review

Path parameters

assessmentIdstring uuid required

UUID of the assessment to complete

Request body

forceOverrideboolean

Flag to force override any validation errors during closure

excludeRulesboolean

Flag to exclude rule execution during closure

closureCommentstring

Comment to include with the assessment closure

resultIdstring uuid

Identifier of the result option to apply to the assessment

attestationRequiredboolean

Flag indicating whether attestation is required for closure

Example request

{
  "closureComment": "Approved after thorough review. All requirements have been met.",
  "resultId": "550e8400-e29b-41d4-a716-446655440000"
}

Response

No Content