ONonetrust
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

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/assessment/v2/assessments/{assessmentId}/responses
  • 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 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": "DEFAULT",
        "response": "Yes",
        "responseId": "550e8400-e29b-41d4-a716-446655440003"
      }
    ]
  }
]

Response

Accepted

assessmentIdstring uuid

UUID of the assessment

assessmentNumberinteger

Number of the assessment

namestring

Name of the assessment

descriptionstring

Description of the assessment

firstAssignedTemplateIdstring uuid

Template ID to which the assessment was originally assigned

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

Current stage of the assessment

resultstring

Result of the assessment

createdDTstring date-time

Date and time the assessment was created

deadlinestring date-time

Deadline to complete the assessment (format: YYYY-MM-DDTHH:MM:SS.FFFZ)

reminderinteger

Number of days before the deadline when the reminder should be sent

canSubmitboolean

Indicates if the assessment or sections can be submitted

canApproveAssessmentboolean

Indicates if the assessment can be approved

displayState'REFRESH_NONE' | 'REFRESH_ALL' | 'REFRESH_PARTIAL'

Assessment display state, used only by the OneTrust user interface

hasRequestInformationboolean

Indicates if the assessment has request information

invalidQuestionToRiskIdMapobject

Map of invalid question IDs to their associated risk IDs

invalidQuestionToIssueIdMapobject

Map of invalid question IDs to their associated issue IDs

lawsstring[]

List of laws associated with the assessment

maturityType'BASIC' | 'ADVANCED' | 'EXPERT'

Complexity level of the assessment's response

reviewChangedResponsesboolean
parentAssessmentIdstring uuid

UUID of the assessment from which this assessment is copied

editAllResponsesWhenInProgressboolean
primaryInventoryNamestring
primaryInventoryNumberinteger
userAssignmentMode'ASSESSMENT' | 'SECTION'
viewerboolean
welcomeSectionboolean
firstSectionboolean
lastSectionboolean
welcomeTextstring

Example response

{
  "orgGroup": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Entity Name",
    "nameKey": "EntityName"
  },
  "createdBy": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Entity Name",
    "nameKey": "EntityName"
  },
  "sectionHeaders": [
    {
      "effectivenessQuestionIds": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    }
  ],
  "section": {
    "submittedBy": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Entity Name",
      "nameKey": "EntityName"
    }
  },
  "approvers": [
    {
      "approverAssignedDate": "2026-08-24T22:02:24.517+00:00"
    }
  ],
  "respondents": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Entity Name",
      "nameKey": "EntityName"
    }
  ],
  "reminderSchedules": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "assessmentId": "8f14e45f-ea9e-4d1b-9b5f-42d5f6a8b9c1",
      "sectionId": "9a1b2c3d-4e5f-6789-abcd-ef0123456789",
      "reminderInterval": 7,
      "reminderReceiverEntityType": "RESPONDENT"
    }
  ],
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "option": "High Priority"
    }
  ]
}

Changes

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