V1AssessmentAreaToImproveField
improvementAreaIdstring
ID of the improvement area
Example:
07e1d9ef-aebe-4901-b26c-941cb5983832fieldIdstring
ID of the field
Example:
b62ca36f-fa86-4ee0-ae96-bad52c2c46b2field object
Field definition
idstring
Field ID
Example:
b62ca36f-fa86-4ee0-ae96-bad52c2c46b2fieldNamestring
Name of the field
Example:
Root Causesdescriptionstring
Field description
Example:
Describe the root causesenabledboolean
Whether the field is enabled
Example:
trueresponseTypestring
Type of response expected
Example:
MULTIPLE_TEXT_ENTRIESrequirementstring
Field requirement level
Example:
REQUIRED_WHEN_ATI_MANDATORYsystemKeystringnullable
System key for the field
Example:
ROOT_CAUSESsettingsobjectnullable
Additional settings
orderinteger
Display order
Example:
0choicesobject[]
Available choices for the field
createdAtstring<date-time>
Creation timestamp
Example:
2025-11-03T14:40:34.815ZupdatedAtstring<date-time>
Last update timestamp
Example:
2025-11-03T14:40:34.815Zanswer object
Answer to the field
valuestringnullable
Answer value
Example:
Some text answerchoicesstring[]
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": [
{}
]
}
}