Skip to main content

Capa

idstring

Unique identifier of the CAPA

Example: 1235330e-b74b-4be6-8d8a-cb0560effc11
statusstring

Status of the CAPA

Example: New
capaLabels undefined[]

List of CAPA labels

  • Array [
  • namestring

    Label field name

    Example: Priority
    valuestring

    Label value

    Example: High
  • ]
  • updatedDatestring<date-time>

    Last update date of the CAPA (available when capa_details=true)

    Example: 2025-12-12T10:48:07.191000+00:00
    updatedByUserstringnullable

    User who last updated the CAPA (available when capa_details=true)

    approvedDatestring<date-time>nullable

    Date when CAPA was approved (available when capa_details=true)

    Example: 2025-12-12T10:48:07.191000+00:00
    createdDatestring<date-time>

    Creation date of the CAPA (available when capa_details=true)

    Example: 2025-12-12T10:48:07.191000+00:00
    dueDatestring<date-time>nullable

    Due date for CAPA completion (available when capa_details=true)

    Example: 2025-12-31T00:00:00.000000+00:00
    areaToImproves object[]

    List of area to improves in this CAPA (available when capa_details=true)

  • Array [
  • idstring

    Unique identifier of the area to improve

    Example: RI0DCKDYR0
    updatedDatestring<date-time>

    Last update date

    Example: 2025-10-21T15:30:56.214000+00:00
    titlestring

    Title of the area to improve

    Example: The general condition of the dormitories need improvement.
    categorystringnullable

    Category of the area to improve

    Example: Drinking Water
    subCategorystringnullable

    Sub-category of the area to improve

    Example: Social
    descriptionstringnullable

    Detailed description

    Example: The facility needs better ventilation
    requiredCorrectionboolean

    Whether correction is required

    Example: false
    recommendationstringnullable

    Recommendation for improvement

    Example: Install new equipment
    statusstring

    Status of the area to improve

    Example: new
    rootCausesstring[]

    List of root causes

    resolutionsstring[]

    List of resolutions

    personInChargestringnullable

    Person responsible for the improvement

    Example: John Doe
    completionDatestring<date-time>nullable

    Target completion date

    Example: 2025-12-15T10:36:56.057000+00:00
    resolvedDatestring<date-time>nullable

    Date when the issue was resolved

    Example: 2025-12-15T10:36:56.057000+00:00
    referenceIdstringnullable

    Reference identifier

    Example: tutest-issue-4-2
    linkedFindings object[]

    List of linked findings

  • Array [
  • schemestringnullable

    Scheme

    severitystringnullable

    Severity value

    Example: Informational
    titlestringnullable

    Title

    Example: Testing finding description
    categorystringnullable

    Category

    Example: Section 1
    subCategorystringnullable

    Sub-category

    Example: Section 1.1
    issueNumberstringnullable

    Issue number

    Example: 376882
    descriptionstringnullable

    Issue description

    Example: This is a detailed description of the issue.
    schemeDataobjectnullable

    Scheme data

  • ]
  • customFieldsobjectnullable

    Custom fields data

    comments object[]

    List of comments

  • Array [
  • textstring

    Comment text

    Example: This is a comment.
    createdByUserstringnullable

    User who created the comment

  • ]
  • uploadedFilesobject[]

    List of uploaded files

    areaToImproveLabels object[]

    Labels associated with this area to improve

  • Array [
  • namestring

    Name of the label

    valuestring

    Value of the label

  • ]
  • fields object[]

    Custom fields with questions and answers

  • Array [
  • 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

    textAreasobject[]

    Text area responses

    attachmentsobject[]

    Attached files

  • ]
  • ]
  • Capa
    {
    "id": "1235330e-b74b-4be6-8d8a-cb0560effc11",
    "status": "New",
    "capaLabels": [
    {
    "name": "Priority",
    "value": "High"
    }
    ],
    "updatedDate": "2025-12-12T10:48:07.191000+00:00",
    "updatedByUser": "[email protected]",
    "approvedDate": "2025-12-12T10:48:07.191000+00:00",
    "createdDate": "2025-12-12T10:48:07.191000+00:00",
    "dueDate": "2025-12-31T00:00:00.000000+00:00",
    "areaToImproves": [
    {
    "id": "RI0DCKDYR0",
    "updatedDate": "2025-10-21T15:30:56.214000+00:00",
    "title": "The general condition of the dormitories need improvement.",
    "category": "Drinking Water",
    "subCategory": "Social",
    "description": "The facility needs better ventilation",
    "requiredCorrection": false,
    "recommendation": "Install new equipment",
    "status": "new",
    "rootCauses": [
    "string"
    ],
    "resolutions": [
    "string"
    ],
    "personInCharge": "John Doe",
    "completionDate": "2025-12-15T10:36:56.057000+00:00",
    "resolvedDate": "2025-12-15T10:36:56.057000+00:00",
    "referenceId": "tutest-issue-4-2",
    "linkedFindings": [
    {
    "scheme": "string",
    "severity": "Informational",
    "title": "Testing finding description",
    "category": "Section 1",
    "subCategory": "Section 1.1",
    "issueNumber": 376882,
    "description": "This is a detailed description of the issue.",
    "schemeData": {}
    }
    ],
    "customFields": {},
    "comments": [
    {
    "text": "This is a comment.",
    "createdByUser": "[email protected]"
    }
    ],
    "uploadedFiles": [
    {}
    ],
    "areaToImproveLabels": [
    {
    "name": "string",
    "value": "string"
    }
    ],
    "fields": [
    {
    "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": [
    {}
    ],
    "attachments": [
    {}
    ]
    }
    }
    ]
    }
    ]
    }