Perform Assessment Workflow Action

Use this API to perform a workflow action on an assessment. The response reflects the updated workflow state of the assessment.

🗒

Things to Know

  • Supported actions include SUBMIT, REVIEW, REJECT, and REOPEN.
Path Params
uuid
required

UUID of the assessment to transition

Body Params
string
enum
required

The workflow transition to perform.

Allowed:
string

Comment associated with the transition. Applies to SUBMIT (submission comment), REVIEW/REJECT (closure comment), and REOPEN (notification email comment).

string

Display name of the result option to apply, e.g. "Approved" or "Rejected" (or a custom result name defined for the assessment's template). Matched case-insensitively against the active, non-internal result options available for this assessment and resolved to the underlying result ID internally - callers don't need to look up the ID first. Required when action is REVIEW; ignored otherwise.

boolean
Defaults to false

Flag to force override validation errors during closure. Applies to REVIEW and REJECT only.

boolean
Defaults to false

Flag to exclude rule execution during closure. Applies to REVIEW and REJECT only.

boolean
Defaults to false

Flag indicating whether attestation is required for closure. Applies to REVIEW and REJECT only.

boolean
Defaults to false

Indicates whether the submitter has accepted the assessment submission disclaimer. Applies to SUBMIT only.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Choose an example:
application/json
*/*