v1

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

Reassign Assessment

Use this API to reassign the organization, approvers, and/or respondents of an assessment. The assessment will be updated with the new organization, approvers, and/or respondents provided in the request body.

🗒 Things to Know

  • If the assessment is in Completed stage, reassignments made using this API will be ignored.

  • The reassigned respondents and/or approvers should exist in the orgGroupId provided in the request.

  • New respondents that do not already exist in the application will be created as Invited Users unless PROJECT_RESPONDENT is specified in the respondentCreationType parameter.

  • If an update is made using this API, an event will be shown in the Assessment Activity.

  • This API can update assessments of the following types: PIA, Vendor, ITRM, Control, Exchange, and Incident.

  • The stageId parameter values returned in the Get Assessment Workflow Stages API response can be used to reassign approvers to different stages of an assessment.

put/api/assessment/v2/assessments/{assessmentId}/reassign

Path parameters

assessmentIdstring uuid required

UUID of the assessment to reassign

Request body

orgGroupIdstring uuid

The ID of the organization that the assessment should be reassigned to

respondentCreationType'INVITED' | 'PROJECT_RESPONDENT'

If adding new users that don't already exist, this is the type of user they will be created as

Example request

{
  "orgGroupId": "550e8400-e29b-41d4-a716-446655440000",
  "approvers": [
    {
      "approverId": "550e8400-e29b-41d4-a716-446655440001",
      "approverName": "John Doe",
      "comment": "Primary approver"
    }
  ],
  "respondents": [
    {
      "respondentId": "550e8400-e29b-41d4-a716-446655440002",
      "respondentName": "Jane Smith",
      "comment": "Main respondent",
      "sectionIds": [
        "550e8400-e29b-41d4-a716-446655440003"
      ],
      "isRespondentOfApproverSection": false
    }
  ],
  "respondentCreationType": "INVITED"
}

Response

No Content