V1AssessmentQuestionAnswer

idstring

Answer unique identifier

questionIdstring

Question unique identifier

sectionIdstringnullable

Effective containing section identifier. A subquestion inherits its parent question's section. Null when legacy data cannot be linked to a section.

parentQuestionIdstringnullable

Parent question identifier for a nested subquestion answer

parentChoiceIdstringnullable

Parent answer-choice identifier for a nested subquestion answer

isNotApplicableboolean

Whether the answer is not applicable

scorenumbernullable

Computed score contribution. Null when uncalculated, non-scoreable, or hidden.

maxScorenumbernullable

Maximum score. Null for deductions, uncalculated or non-scoreable answers, or when hidden.

scoreInPercentagenumbernullable

Computed score percentage. Null when maxScore is zero or unavailable, or when hidden.

question object

Question information

idstring

Question ID

Example: 74fad70b-679a-46cc-9e98-ec8aca9b44f8

contentstring

Question content/text

Example: Q2.2.1

indexinteger

Answer display order. This is not an identifier or a score.

Example: 1

textstringnullable

Text answer

Example: Some answer text

numbernumbernullable

Numeric answer

Example: 42

value object

Value answer (we plan to migrate to this field in future). Currently only some question types using it.

oneOf

• string
• number
• boolean
• object
• []

stringnullable

tableValues object[]

Table answer values for questions with table response type

Array [

idstring

columnIdstring

columnNamestring

rowNumberinteger

rowLabelstringnullable

value object

oneOf

• string
• number
• boolean
• object
• []

stringnullable

choicesstring[]

files object[]

Array [

idstring

Attachment unique identifier

namestringnullable

Original file name

signedUrlstringnullable

Temporary signed URL for downloading the attachment

]

]

choices object[]

Selected choice(s)

Array [

idstring

Choice ID

Example: 67e04318-e69c-4224-84f3-aff1d4089b80

contentstring

Choice content

Example: 3

textstringnullable

Sub answer "paragraph" for the choice (if applicable)

Example: test

files object[]

Sub answer "files" for the choice (if applicable)

Array [

idstring

Attachment unique identifier

namestringnullable

Original file name

signedUrlstringnullable

Temporary signed URL for downloading the attachment

]

subQuestionAnswers []

Answers to questions conditionally nested under this selected choice

Array [

circular(V1AssessmentQuestionAnswer)

]

]

files object[]

Files attached directly to the answer; comment attachments are returned under comments[].attachments

Array [

idstring

Attachment unique identifier

namestringnullable

Original file name

signedUrlstringnullable

Temporary signed URL for downloading the attachment

]

comments object[]

Question comments (available when include_question_comments=true)

Array [

idstring

Comment unique identifier

contentstringnullable

Comment content

createdDatestring<date-time>nullable

Comment creation timestamp

isEditedboolean

Whether the comment has been edited

user objectnullable

Comment author, subject to assessment confidentiality rules

idstring

emailstring

firstNamestringnullable

lastNamestringnullable

organization objectnullable

Author organization, subject to assessment confidentiality rules

idstring

externalIdstringnullable

namestringnullable

typestring

attachments object[]

Attachments belonging to this comment; these are not included in questionAnswer.files

Array [

idstring

Attachment unique identifier

namestringnullable

Original file name

signedUrlstringnullable

Temporary signed URL for downloading the attachment

]

]

V1AssessmentQuestionAnswer

{
  "id": "string",
  "questionId": "string",
  "sectionId": "string",
  "parentQuestionId": "string",
  "parentChoiceId": "string",
  "isNotApplicable": true,
  "score": 0,
  "maxScore": 0,
  "scoreInPercentage": 0,
  "question": {
    "id": "74fad70b-679a-46cc-9e98-ec8aca9b44f8",
    "content": "Q2.2.1"
  },
  "index": 1,
  "text": "Some answer text",
  "number": 42,
  "value": 42,
  "tableValues": [
    {
      "id": "string",
      "columnId": "string",
      "columnName": "string",
      "rowNumber": 0,
      "rowLabel": "string",
      "value": "string",
      "choices": [
        "string"
      ],
      "files": [
        {
          "id": "string",
          "name": "string",
          "signedUrl": "string"
        }
      ]
    }
  ],
  "choices": [
    {
      "id": "67e04318-e69c-4224-84f3-aff1d4089b80",
      "content": "3",
      "text": "test",
      "files": [
        {
          "id": "string",
          "name": "string",
          "signedUrl": "string"
        }
      ],
      "subQuestionAnswers": [
        null
      ]
    }
  ],
  "files": [
    {
      "id": "string",
      "name": "string",
      "signedUrl": "string"
    }
  ],
  "comments": [
    {
      "id": "string",
      "content": "string",
      "createdDate": "2024-07-29T15:51:28.071Z",
      "isEdited": true,
      "user": {
        "id": "string",
        "email": "string",
        "firstName": "string",
        "lastName": "string"
      },
      "organization": {
        "id": "string",
        "externalId": "string",
        "name": "string",
        "type": "string"
      },
      "attachments": [
        {
          "id": "string",
          "name": "string",
          "signedUrl": "string"
        }
      ]
    }
  ]
}