Sign in

v1

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

Reassess Assessment

Use this API to launch a reassessment of an existing assessment. The reassessment will use the latest published template version.

🗒 Things to Know

  • Basic assessment details, such as name, organization, deadline, reminder, approver, and respondent, can be copied from the source assessment to the new assessment if the copyAssessmentMetadata parameter is set to true. Otherwise, assessmentMetadata can be passed through the API when the copyAssessmentMetadata parameter is set to false.
  • The responses, comments, attachments, notes, and linked risks from the original assessment can also be copied to the new assessment using this API.
  • The archiveSourceAssessment parameter can be used to indicate whether to archive the source assessment or not.
post/api/assessment/v2/assessments/{id}/reassess

Path parameters

idstring uuid required

Unique identifier of the assessment to be reassessed

Request body

deadlinestring date-time

Deadline (date) to complete the assessment

reminderinteger

Use this field to input the number of days before the deadline to send a automatic notification to the respondent. Deadline must be set for this field to be enabled.Note: Either 'reminder' or 'reminderSchedules' should be provided. If both are present, 'reminder' takes precedence and will be converted to a reminderSchedule for RESPONDENT notification.

copyAttachmentsboolean

This field will copy over the attachments linked to the source assessment.

copyResponsesboolean

This field will copy over the question responses from the source assessment.

copyNotesboolean

This field will copy over the user notes from the source assessment.

copyCommentsboolean

This field will copy over the comments from the source assessment.

linkRisksboolean

Any risk rules created based on the template risk rules for the original assessment will be linked to the newly created assessment upon submission.

copyAssessmentMetadataboolean

This field will copy assessment name, description, organisation, approver, respondent details from source assessment to new assessment.

archiveSourceAssessmentboolean

Use this field to provide a "true" or a "false" value to archive the original assessment. When reassessing, setting it to "true" will archive the original assessment and setting it to "false" will not archive the original assessment

Example request

{
  "assessmentMetadata": {
    "approvers": [
      {
        "approverId": "550e8400-e29b-41d4-a716-446655440000",
        "approverName": "John Doe",
        "comment": "Primary approver",
        "workflowStageIds": [
          "550e8400-e29b-41d4-a716-446655440000"
        ]
      }
    ],
    "respondents": [
      {
        "respondentId": "550e8400-e29b-41d4-a716-446655440000",
        "respondentName": "John Doe",
        "comment": "Assessment respondent added",
        "sectionIds": [
          "550e8400-e29b-41d4-a716-446655661111"
        ]
      }
    ]
  },
  "deadline": "2025-12-31T23:59:59Z",
  "reminder": 7,
  "Reminder Schedules": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "assessmentId": "8f14e45f-ea9e-4d1b-9b5f-42d5f6a8b9c1",
      "sectionId": "9a1b2c3d-4e5f-6789-abcd-ef0123456789",
      "reminderInterval": 7,
      "reminderReceiverEntityType": "RESPONDENT"
    }
  ],
  "copyAttachments": true,
  "copyResponses": true,
  "copyNotes": true,
  "copyComments": true,
  "linkRisks": true,
  "copyAssessmentMetadata": true
}

Response

Created

string uuid required