Skip to main content

V2ReportDetailCapa

idstringnullable

Unique identifier of the CAPA

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

Status of the CAPA

Example: NEW
capaLabels object[]nullable

List of CAPA labels

  • Array [
  • namestringnullable

    Name

    valuestringnullable

    Value

  • ]
  • updatedDatestring<date-time>nullable

    System updated date of the CAPA only (only returned if [capa_details] query parameter is true)

    Example: 2024-09-30T10:36:56.057000+00:00
    updatedByUserstringnullable

    The user who last updated the CAPA (only returned if [capa_details] query parameter is true)

    approvedDatestring<date-time>nullable

    The date the CAPA was approved (only returned if [capa_details] query parameter is true)

    Example: 2024-09-30T10:36:56.057000+00:00
    createdDatestring<date-time>nullable

    The date the CAPA was created, this is also Report Generated date (only returned if [capa_details] query parameter is true)

    Example: 2024-09-30T10:36:56.057000+00:00
    dueDatestring<date-time>nullable

    The date by which the CAPA should be submitted by the requestee (only returned if [capa_details] query parameter is true) organization

    Example: 2025-01-29T00:00:00.000000+00:00
    areaToImproves object[]nullable

    List of area to improve (ATI) (only returned if [capa_details] query parameter is true)

  • Array [
  • idstring

    ATI custom ID

    Example: RI03EAE430
    updatedDatestring<date-time>nullable

    Last updated date of area to improve

    Example: 2024-09-30T10:36:56.057000+00:00
    titlestring

    Title of the ATI

    Example: The factory doesnt utilize renewable energy
    categorystringnullable

    Category of the ATI

    Example: Environmental
    subCategorystringnullable

    Sub-category of the ATI

    Example: Renewable energy
    requiredCorrectionboolean

    ATI required correction set by executor

    Example: true
    recommendationstringnullable

    ATI recommendation set by executor

    Example: Recommendation from auditor
    statusstring

    Status of the ATI

    Possible values: [New, Completed, Incomplete, Resolved, auto-resolved, auto-incomplete]

    Example: New
    rootCauses object[]nullable

    Rootcause of the ATI, input by the requestee

  • Array [
  • textstring

    Text

    createdByUserstring

    Email of the user who input the text

    createdByOrgstring

    Organization name of the user who input the text

  • ]
  • resolutions object[]nullable

    List of ATI resolutions

  • Array [
  • textstring

    Text

    createdByUserstring

    Email of the user who input the text

    createdByOrgstring

    Organization name of the user who input the text

  • ]
  • personInChargestringnullable

    Person in charge of the ATI, input by the requestee

    Example: John Doe
    completionDatestring<date-time>nullable

    The completion date of the ATI

    Example: 2024-09-30T10:36:56.057000+00:00
    resolvedDatestring<date-time>nullable

    The resolved date the ATI

    Example: 2024-09-30T10:36:56.057000+00:00
    referenceIdstringnullable

    Linked finding reference ID. This only have value when the assessment is linked to an external report.

    linkedFindings object[]nullable

    List of linked findings

  • Array [
  • schemastringnullable

    Scheme that is linked to the current Area To Improve

    Possible values: [Higg, SLCP, SMETA]

    Example: SMETA
    titlestringnullable

    Linked finding title. This can have value when the assessment is linked to an external report or the questionnaire is issue-based.

    Example: 10s
    severitystring

    Severity of the linked findings

    Possible values: [Critical, Major, Minor]

    Example: Major
    categorystringnullable

    Linked finding category

    subCategorystringnullable

    Linked finding sub-category

    issueNumberstringnullable

    Linked finding issue number

    descriptionstringnullable

    Linked finding description

    schemeData objectnullable

    Linked finding scheme data

    oneOf
    statusstringnullable

    Sedex issue status

    verificationMethodstringnullable

    Sedex issue verification method

    parentAuditFindingstringnullable

    Sedex issue parent audit finding

    rootAuditFindingstringnullable

    Sedex issue root audit finding

    typestringnullable

    Sedex issue type

    verificationOnstringnullable

    Sedex issue verification date

    createOriginstringnullable

    Sedex issue create origin

  • ]
  • areaToImproveLabels object[]nullable

    List of ATI labels

  • Array [
  • namestringnullable

    Name

    valuestringnullable

    Value

  • ]
  • customFields object
    expectedCompletionDatestring<date-time>nullable

    ATI expected completion date, set by the retailer

    Example: 2024-09-30T10:36:56.057000+00:00
    ncDueDatestring<date-time>nullable

    NC due date, set by the auditor

    Example: 2024-09-30T10:36:56.057000+00:00
    ncFindDatestring<date-time>nullable

    NC find date, set by the auditor

    Example: 2024-09-30T10:36:56.057000+00:00
    ncSourcestringnullable

    Source of the NC

    Example: Third party
    inScopeCheckstringnullable

    In scope check value

    Example: In Scope
    descriptionstringnullable

    Issue description

    Example: During the audit we noticed that...
    severitystringnullable

    Issue severity

    Example: Major
    reasonToUpdateSeveritystringnullable

    Reason to update severity

    comments object[]nullable

    List of comments

  • Array [
  • textstring

    The comment for ATI

    createdByUserstring

    User email from retailer who input the comment for ATI

  • ]
  • uploadFiles object[]nullable

    The evidence file for ATI

  • Array [
  • urlstring

    The file URL

    createdByUserstring

    Email of the user who uploaded the file

  • ]
  • fields object[]
  • Array [
  • improvementAreaIdstring

    UUID of the improvement area

    Example: b701705f-146d-4313-a071-039b659aa33e
    fieldIdstring

    UUID of the field

    Example: 0e18e415-1ab0-40f1-aff4-a3716f064b3b
    field object
    idstring

    UUID of the field

    Example: 0e18e415-1ab0-40f1-aff4-a3716f064b3b
    fieldNamestring

    Name of the ATI field

    Example: Resolutions
    descriptionstringnullable

    Description of the ATI field

    Example: This is the description of resolutions field
    enabledboolean

    Whether the ATI field is enabled or not

    Example: true
    responseTypestring

    Response type of the ATI field

    Possible values: [PARAGRAPH, DATE, FILE_UPLOAD, MULTIPLE_TEXT_ENTRIES, SINGLE_CHOICE]

    Example: PARAGRAPH
    requirementstring

    Requirement of the ATI field

    Possible values: [OPTIONAL, REQUIRED_WHEN_ATI_MANDATORY]

    Example: OPTIONAL
    systemKeystringnullable

    System key of the ATI field

    Possible values: [ROOT_CAUSES, RESOLUTIONS, PERSON_IN_CHARGE, COMPLETION_DATE, UPLOAD_FILES]

    Example: ROOT_CAUSES
    settingsobjectnullable

    Whether the ATI field is enabled or not

    Example: {"doNotAllowPastDates":true,"doNotAllowFutureDates":true}
    orderinteger

    Order of the ATI field

    Example: 2
    choices object[]
  • Array [
  • idstring

    UUID of the choice

    Example: ae141de4-888d-49cd-9442-1dc997c5fe31
    valuestring

    Value of the choice

    Example: option-1
    createdAtstring<date-time>

    Creation date of the choice

    Example: 2024-09-30T10:36:56.057000+00:00
    updatedAtstring<date-time>

    Update date of the choice

    Example: 2024-10-30T10:36:56.057000+00:00
  • ]
  • createdAtstring<date-time>

    Creation date of the field

    Example: 2024-09-30T10:36:56.057000+00:00
    updatedAtstring<date-time>

    Update date of the field

    Example: 2024-10-30T10:36:56.057000+00:00
    answer objectnullable
    valuestringnullable

    Value of the answer

    Example: option-1
    choices object[]
  • Array [
  • idstring

    UUID of the choice

    Example: ae141de4-888d-49cd-9442-1dc997c5fe31
    valuestring

    Value of the choice

    Example: option-1
  • ]
  • textAreas object[]
  • Array [
  • idstring

    UUID of the text area type field

    Example: 7c0d0a5d-1c8b-41ba-b0ef-3d459e758a92
    capaImprovementAreaAnswerIdstring

    UUID of the ATI answer

    Example: 7c0d0a5d-1c8b-41ba-b0ef-3d459e758a93
    contentstringnullable

    Content of the text area

    Example: test content
    user object
    idstring

    UUID of the user

    Example: 9f1b8e6d-4c3b-4f5a-9f1b-8e6d4c3b4f5a
    firstNamestring

    First name of the user

    Example: John
    lastNamestring

    Last name of the user who

    Example: Doe
    emailstring

    Email of the user who input the text area content

    organization object
    idstring

    UUID of the organization

    Example: 9f1b8e6d-4c3b-4f5a-9f1b-8e6d4c3b4f5b
    namestring

    Name of the organization

    Example: Test org
    typestring

    Type of the organization

    Example: RETAILER
    createdAtnumbernullable

    Creation date of the text area content

    Example: 1763375353109
    updatedAtnumbernullable

    Update date of the text area content

    Example: 1763375353110
    recommendationIdstringnullable

    UUID of the recommendation

    Example: 9f1b8e6d-4c3b-4f5a-9f1b-8e6d4c3b4f5c
    recommendation objectnullable
    idstring

    UUID of the recommendation

    Example: 9f1b8e6d-4c3b-4f5a-9f1b-8e6d4c3b4f5c
    contentstring

    Content of the recommendation

    Example: test content
  • ]
  • attachments object[]
  • Array [
  • idstring

    UUID of the attachment

    Example: d4f5a9f1-b8e6-4c3b-9f1b-8e6d4c3b4f5d
  • ]
  • ]
  • ]
  • V2ReportDetailCapa
    {
    "id": "1235330e-b74b-4be6-8d8a-cb0560effc11",
    "status": "NEW",
    "capaLabels": [
    {
    "name": "string",
    "value": "string"
    }
    ],
    "updatedDate": "2024-09-30T10:36:56.057000+00:00",
    "updatedByUser": "[email protected]",
    "approvedDate": "2024-09-30T10:36:56.057000+00:00",
    "createdDate": "2024-09-30T10:36:56.057000+00:00",
    "dueDate": "2025-01-29T00:00:00.000000+00:00",
    "areaToImproves": [
    {
    "id": "RI03EAE430",
    "updatedDate": "2024-09-30T10:36:56.057000+00:00",
    "title": "The factory doesnt utilize renewable energy",
    "category": "Environmental",
    "subCategory": "Renewable energy",
    "requiredCorrection": true,
    "recommendation": "Recommendation from auditor",
    "status": "New",
    "rootCauses": [
    {
    "text": "string",
    "createdByUser": "string",
    "createdByOrg": "string"
    }
    ],
    "resolutions": [
    {
    "text": "string",
    "createdByUser": "string",
    "createdByOrg": "string"
    }
    ],
    "personInCharge": "John Doe",
    "completionDate": "2024-09-30T10:36:56.057000+00:00",
    "resolvedDate": "2024-09-30T10:36:56.057000+00:00",
    "referenceId": "string",
    "linkedFindings": [
    {
    "schema": "SMETA",
    "title": "10s",
    "severity": "Major",
    "category": "string",
    "subCategory": "string",
    "issueNumber": "string",
    "description": "string",
    "schemeData": {
    "status": "string",
    "verificationMethod": "string",
    "parentAuditFinding": "string",
    "rootAuditFinding": "string",
    "type": "string",
    "verificationOn": "string",
    "createOrigin": "string"
    }
    }
    ],
    "areaToImproveLabels": [
    {
    "name": "string",
    "value": "string"
    }
    ],
    "customFields": {
    "expectedCompletionDate": "2024-09-30T10:36:56.057000+00:00",
    "ncDueDate": "2024-09-30T10:36:56.057000+00:00",
    "ncFindDate": "2024-09-30T10:36:56.057000+00:00",
    "ncSource": "Third party",
    "inScopeCheck": "In Scope",
    "description": "During the audit we noticed that...",
    "severity": "Major",
    "reasonToUpdateSeverity": "string"
    },
    "comments": [
    {
    "text": "string",
    "createdByUser": "[email protected]"
    }
    ],
    "uploadFiles": [
    {
    "url": "string",
    "createdByUser": "string"
    }
    ],
    "fields": [
    {
    "improvementAreaId": "b701705f-146d-4313-a071-039b659aa33e",
    "fieldId": "0e18e415-1ab0-40f1-aff4-a3716f064b3b",
    "field": {
    "id": "0e18e415-1ab0-40f1-aff4-a3716f064b3b",
    "fieldName": "Resolutions",
    "description": "This is the description of resolutions field",
    "enabled": true,
    "responseType": "PARAGRAPH",
    "requirement": "OPTIONAL",
    "systemKey": "ROOT_CAUSES",
    "settings": {
    "doNotAllowPastDates": true,
    "doNotAllowFutureDates": true
    },
    "order": 2,
    "choices": [
    {
    "id": "ae141de4-888d-49cd-9442-1dc997c5fe31",
    "value": "option-1",
    "createdAt": "2024-09-30T10:36:56.057000+00:00",
    "updatedAt": "2024-10-30T10:36:56.057000+00:00"
    }
    ],
    "createdAt": "2024-09-30T10:36:56.057000+00:00",
    "updatedAt": "2024-10-30T10:36:56.057000+00:00"
    },
    "answer": {
    "value": "option-1",
    "choices": [
    {
    "id": "ae141de4-888d-49cd-9442-1dc997c5fe31",
    "value": "option-1"
    }
    ],
    "textAreas": [
    {
    "id": "7c0d0a5d-1c8b-41ba-b0ef-3d459e758a92",
    "capaImprovementAreaAnswerId": "7c0d0a5d-1c8b-41ba-b0ef-3d459e758a93",
    "content": "test content",
    "user": {
    "id": "9f1b8e6d-4c3b-4f5a-9f1b-8e6d4c3b4f5a",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]"
    },
    "organization": {
    "id": "9f1b8e6d-4c3b-4f5a-9f1b-8e6d4c3b4f5b",
    "name": "Test org",
    "type": "RETAILER"
    },
    "createdAt": 1763375353109,
    "updatedAt": 1763375353110,
    "recommendationId": "9f1b8e6d-4c3b-4f5a-9f1b-8e6d4c3b4f5c",
    "recommendation": {
    "id": "9f1b8e6d-4c3b-4f5a-9f1b-8e6d4c3b4f5c",
    "content": "test content"
    }
    }
    ],
    "attachments": [
    {
    "id": "d4f5a9f1-b8e6-4c3b-9f1b-8e6d4c3b4f5d"
    }
    ]
    }
    }
    ]
    }
    ]
    }