Skip to main content

V2AreaToImprove

idstring

ATI custom ID

Example: RI03EAE430
updatedDatedate-timenullable

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
    completionDatedate-timenullable

    The completion date of the ATI

    Example: 2024-09-30T10:36:56.057000+00:00
    resolvedDatedate-timenullable

    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
    expectedCompletionDatedate-timenullable

    ATI expected completion date, set by the retailer

    Example: 2024-09-30T10:36:56.057000+00:00
    ncDueDatedate-timenullable

    NC due date, set by the auditor

    Example: 2024-09-30T10:36:56.057000+00:00
    ncFindDatedate-timenullable

    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

  • ]
  • V2AreaToImprove
    {
    "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"
    }
    ]
    }