ONonetrust
Assessment Actions

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

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/assessment/v2/assessments/{assessmentId}/actions
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: ASSESSMENT

Path parameters

assessmentIdstring uuid required

UUID of the assessment to transition

Request body

action'SUBMIT' | 'REVIEW' | 'REJECT' | 'REOPEN' required

The workflow transition to perform.

commentstring

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

resultstring

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.

forceOverrideboolean

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

excludeRulesboolean

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

attestationRequiredboolean

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

disclaimerAcceptedboolean

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

Example request

{
  "action": "SUBMIT",
  "comment": "Submitting for review",
  "disclaimerAccepted": true
}

Response

OK

assessmentIdstring uuid
action'SUBMIT' | 'REVIEW' | 'REJECT' | 'REOPEN'

The action that was performed.

status'NOT_STARTED' | 'IN_PROGRESS' | 'UNDER_REVIEW' | 'COMPLETED'

The assessment's status after the transition ran.

Changes

No recorded changes to this operation across all 1 revision of this API.