ONonetrust
Assessments

Get Assessment Question Section

Use this API to retrieve a section of assessment questions. The response includes the questions within the requested section, available response options, and any previously submitted responses. Questions hidden by navigation rules are not returned.

🗒 Things to Know

  • By default, only required unanswered questions are returned.
  • To retrieve all questions in the section, specify filter=ALL_QUESTIONS as a query parameter.
  • To retrieve the assessment's welcome or introduction content instead of assessment questions, specify direction=WELCOME as a query parameter. If no welcome content is configured, specify direction=FIRST.
  • Each question includes available response options and any previously submitted responses. Response option identifiers can be used when submitting responses through the Submit Responses API.
get/api/assessment/v2/assessments/{assessmentId}/sections/navigate

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/assessment/v2/assessments/{assessmentId}/sections/navigate
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: ASSESSMENT_READ, ASSESSMENT

Path parameters

assessmentIdstring uuid required

UUID of the assessment to fetch a section from

Query parameters

direction'WELCOME' | 'FIRST' | 'CURRENT' | 'NEXT' | 'PREVIOUS' required

Which section to fetch relative to sectionId. WELCOME and FIRST both ignore sectionId; CURRENT/NEXT/PREVIOUS all require it. Case-insensitive.

sectionIdstring uuid

Section to navigate relative to. Required for CURRENT/NEXT/PREVIOUS; ignored for WELCOME/FIRST. Comes from a previous call to this endpoint.

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

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

Response

OK

sectionIdstring uuid

UUID to use as sectionId in subsequent navigation/submission calls.

sectionNamestring

Display name of the section.

sectionDescriptionstring

Optional longer description of the section.

sectionSequenceinteger

1-based position of this section within the assessment.

isFirstSectionboolean

Whether this is the first section in the assessment.

isLastSectionboolean

Whether this is the last section in the assessment.

totalQuestionsinteger

Total number of questions across the whole assessment (not just this section).

respondedQuestionsinteger

Number of questions answered so far across the whole assessment (not just this section).

Changes

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