Skip to main content

V1AssessmentAreaToImproveField

improvementAreaIdstring

ID of the improvement area

Example: 07e1d9ef-aebe-4901-b26c-941cb5983832
fieldIdstring

ID of the field

Example: b62ca36f-fa86-4ee0-ae96-bad52c2c46b2
field object

Field definition

idstring

Field ID

Example: b62ca36f-fa86-4ee0-ae96-bad52c2c46b2
fieldNamestring

Name of the field

Example: Root Causes
descriptionstring

Field description

Example: Describe the root causes
enabledboolean

Whether the field is enabled

Example: true
responseTypestring

Type of response expected

Example: MULTIPLE_TEXT_ENTRIES
requirementstring

Field requirement level

Example: REQUIRED_WHEN_ATI_MANDATORY
systemKeystringnullable

System key for the field

Example: ROOT_CAUSES
settingsobjectnullable

Additional settings

orderinteger

Display order

Example: 0
choicesobject[]

Available choices for the field

createdAtstring<date-time>

Creation timestamp

Example: 2025-11-03T14:40:34.815Z
updatedAtstring<date-time>

Last update timestamp

Example: 2025-11-03T14:40:34.815Z
answer object

Answer to the field

valuestringnullable

Answer value

Example: Some text answer
choicesstring[]

Selected choices

textAreasstring[]

Text area responses

attachmentsobject[]

Attached files

V1AssessmentAreaToImproveField
{
"improvementAreaId": "07e1d9ef-aebe-4901-b26c-941cb5983832",
"fieldId": "b62ca36f-fa86-4ee0-ae96-bad52c2c46b2",
"field": {
"id": "b62ca36f-fa86-4ee0-ae96-bad52c2c46b2",
"fieldName": "Root Causes",
"description": "Describe the root causes",
"enabled": true,
"responseType": "MULTIPLE_TEXT_ENTRIES",
"requirement": "REQUIRED_WHEN_ATI_MANDATORY",
"systemKey": "ROOT_CAUSES",
"settings": {},
"order": 0,
"choices": [
{}
],
"createdAt": "2025-11-03T14:40:34.815Z",
"updatedAt": "2025-11-03T14:40:34.815Z"
},
"answer": {
"value": "Some text answer",
"choices": [
"string"
],
"textAreas": [
"string"
],
"attachments": [
{}
]
}
}