ONonetrust
Assessment Actions

Submit Child Question Responses

Use this API to submit responses for the child questions associated with a parent assessment question. The response confirms the submitted answers and updates the assessment accordingly.

🗒 Things to Know

  • Supported parent question types include ATTRIBUTE, CONTROL, CONTRACT, and ENGAGEMENT.
  • Responses cannot be submitted to assessments that have already been completed.
post/api/assessment/v2/assessments/{assessmentId}/questions/{parentQuestionId}/children/responses

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/assessment/v2/assessments/{assessmentId}/questions/{parentQuestionId}/children/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 child responses for

parentQuestionIdstring uuid required

UUID of the parent question whose children are being answered

Query parameters

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

Which questions in the section to include after submission. Case-insensitive.

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

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

Current stage of the assessment

sectionIdToQuestionsMapobject

Map of section ID to the questions within that section

Example response

{
  "orgGroup": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Entity Name",
    "nameKey": "EntityName"
  }
}

Changes

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