Sign in

v1

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

Submit Responses

Use this API to submit responses for an assessment. The assessment will be updated with the submitted response.

🗒 Things to Know

  • Responses cannot be added to assessments that have already been completed.
post/api/assessment/v2/assessments/{assessmentId}/responses

Path parameters

assessmentIdstring uuid required

UUID of the assessment to submit responses for

Query parameters

filter'ALL_QUESTIONS' | 'UNANSWERED_QUESTIONS' | 'REQUIRED_QUESTIONS' | 'REQUIRED_UNANSWERED_QUESTIONS' | 'EFFECTIVENESS_SCALE_QUESTIONS'

Filter to apply when retrieving questions

Request body

assessmentIdstring uuid required

Unique identifier of the assessment for which responses are being submitted

sectionIdstring uuid required

Unique identifier of the section containing the question being answered

questionIdstring uuid required

Unique identifier of the question being answered

parentAssessmentDetailIdstring uuid

Unique identifier of the parent assessment detail for attribute questions. Required for attribute questions only.

parentPersonalDataDetailIdstring uuid

Unique identifier of the parent personal data detail for personal data relationship attribute questions. Required for personal data relationship attribute questions only.

responseProvidedForOthersboolean

Example request

[
  {
    "assessmentId": "550e8400-e29b-41d4-a716-446655440000",
    "sectionId": "550e8400-e29b-41d4-a716-446655440001",
    "questionId": "550e8400-e29b-41d4-a716-446655440002",
    "parentAssessmentDetailId": "550e8400-e29b-41d4-a716-446655440003",
    "parentPersonalDataDetailId": "550e8400-e29b-41d4-a716-446655440004",
    "responses": [
      {
        "type": "SINGLE_SELECT",
        "response": "Yes",
        "responseId": "550e8400-e29b-41d4-a716-446655440003"
      }
    ]
  }
]

Response

Accepted

assessment idstring uuid
assessment numberinteger
assessment namestring
assessment descriptionstring
template id to which assessment was originally assigned tostring uuid
assessment stage'NOT_STARTED' | 'IN_PROGRESS' | 'UNDER_REVIEW' | 'COMPLETED'
assessment resultstring
created date timestring date-time
deadline to complete the assessment, format - YYYY-MM-DDTHH:MM:SS.FFFZstring date-time
reminder to be sent the number of days before the deadline denoted by this valueinteger
indicates if the assessment or sections can be submittedboolean
indicates if the assessment can be approvedboolean
assessment display state. Used only by our own use interface'REFRESH_NONE, REFRESH_ALL, REFRESH_PARTIAL'
indicates if it has request informationboolean
map containing invalid questions and the associated risksobject
List of laws associated with the assessmentstring[]
Complexity level of Assessment' response'BASIC' | 'ADVANCED' | 'EXPERT'
reviewChangedResponsesboolean
assessment id from where this assessment is copiedstring uuid
editAllResponsesWhenInProgressboolean
primaryInventoryNamestring
primaryInventoryNumberinteger
userAssignmentMode'ASSESSMENT' | 'SECTION'
viewerboolean
welcomeSectionboolean
firstSectionboolean
lastSectionboolean
welcomeTextstring

Example response

{
  "assessment org group": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Entity Name",
    "nameKey": "EntityName"
  },
  "created by user id": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Entity Name",
    "nameKey": "EntityName"
  },
  "list of sections": [
    {
      "effectivenessQuestionIds": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    }
  ],
  "current section information": {
    "submittedBy": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Entity Name",
      "nameKey": "EntityName"
    }
  },
  "List of respondents for this assessment": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Entity Name",
      "nameKey": "EntityName"
    }
  ],
  "reminder to be sent the number of days before the deadline denoted by these values": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "assessmentId": "8f14e45f-ea9e-4d1b-9b5f-42d5f6a8b9c1",
      "sectionId": "9a1b2c3d-4e5f-6789-abcd-ef0123456789",
      "reminderInterval": 7,
      "reminderReceiverEntityType": "RESPONDENT"
    }
  ],
  "List of tags associated with the assessment": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "option": "High Priority"
    }
  ]
}