Skip to main content

V1AssessmentListItem

idstring

Unique assessment execution ID

Example: 5c40e755-3ab0-4fa9-9a44-f76a95f0e87d
assessmentIdstring

Assessment ID (displays in UI)

Example: 100000-2
caseIdstring

Case ID (displays in UI)

Example: 100000
reportIdstringnullable

Associated report ID (if report exists)

Example: 5c40e755-3ab0-4fa9-9a44-f76a95f0e87d
statusstring

Assessment Status (New, Aborted, Submitted ...)

Example: Submitted
typestring

Assessment type

Possible values: [Verification Assessment, Self Assessment]

Example: Verification Assessment
reasonstringnullable

Assessment Reasons (optional - depending on the configuration in each standard)

Example: Annual Audit
workflowNamestringnullable

Selected Workflow for the assessment

Example: Factory Information
standard object

The Standard used for the Assessment

namestringnullable

Name

versionstringnullable

Version

ratingstringnullable

Rating of the assessment. Calculated based on the rule setting of the standard and the score/issues found in the assessment.

Example: Good
scorestringnullable

Score of the Assessment. Calculated based on the number of issue found or the selected answers in the assessment.

Example: 8/10
scoreInPercentagestringnullable

Score of the Assessment in percentage. Calculated based on the number of issue found or the selected answers in the assessment compare to the maximum score.

Example: 80%
totalFindings object[]

List of findings. Only contains value if the assessment is issue-based.

  • Array [
  • severitystring

    Finding severity level

    Example: Critical
    findingsinteger

    Number of findings at this severity level

    Example: 5
  • ]
  • numberOfAreaToImprovesinteger

    The total count of area to improves after the assessment is completed.

    Example: 12
    assessmentDueDatestring<date-time>nullable

    Due date of the assessment

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

    Start date of the Assessment Window

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

    End date of the Assessment Window

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

    Actual Audit Start date (This field has value only when the configuration is enabled in the standard)

    Example: 2024-09-30
    auditEndDatestring<date>nullable

    Actual Audit End date (This field has value only when the configuration is enabled in the standard)

    Example: 2024-09-30
    assessmentSubmitDatestring<date-time>nullable

    Assessment Submitted date. This is also Report Generated date.

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

    The start date of the Assessment

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

    The date the case was completed

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

    The date the case was reopened

    Example: 2024-09-30T10:36:56.057000+00:00
    stakeholders object

    Stakeholders information

    assessedOrg object

    The organization being assessed (list view - simplified)

    idstringnullable

    Unique identifier

    namestringnullable

    Name

    typestringnullable

    Type

    addressstringnullable

    Address

    Example: 123 Main Street
    citystringnullable

    City

    Example: Abbeville
    statestringnullable

    State

    Example: Alabama
    postalstringnullable

    Postal code

    Example: 36310
    countrystringnullable

    Country

    Example: US
    requester object

    The organization who requested the assessment

    idstringnullable

    Unique identifier

    namestringnullable

    Name

    typestringnullable

    Type

    executors object[]nullable

    The organizations who execute the assessment

  • Array [
  • idstringnullable

    Unique identifier

    namestringnullable

    Name

    typestringnullable

    Type

    contactPersons object[]nullable

    Executor contact persons

  • Array [
  • namestringnullable

    Contact person name

    Example: John Doe
    titlestringnullable

    Contact person title

    Example: Factory Manager
    emailstringnullable

    Contact person email

    phoneNumberstringnullable

    Contact person phone number

    Example: 1234567890
  • ]
  • isPlaceholderbooleannullable

    Whether this is a placeholder executor

    Example: false
    ableToSubmitAssessmentbooleannullable

    Whether this executor can submit the assessment

    Example: true
  • ]
  • selectedPartners object[]nullable

    The partners associated with the assessed organization

  • Array [
  • idstringnullable

    Unique identifier

    namestringnullable

    Name

    typestringnullable

    Type

  • ]
  • capa objectnullable

    Information of the CAPA, Corrective Action and Preventive Action (basic info only in list view)

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

    Label field name

    Example: Priority
    valuestring

    Label value

    Example: High
  • ]
  • dueDatestring<date-time>nullable

    The date by which the CAPA should be submitted by the requestee organization

    Example: 2025-01-29T00:00:00.000000+00:00
    schedulingStatusstringnullable

    Scheduling status of the assessment

    Example: Scheduled
    updatedDatestring<date-time>nullable

    System updated date. This field will be updated based on the changes in the Assessment and CAPA.

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

    Client's specific attributes

    V1AssessmentListItem
    {
    "id": "5c40e755-3ab0-4fa9-9a44-f76a95f0e87d",
    "assessmentId": "100000-2",
    "caseId": 100000,
    "reportId": "5c40e755-3ab0-4fa9-9a44-f76a95f0e87d",
    "status": "Submitted",
    "type": "Verification Assessment",
    "reason": "Annual Audit",
    "workflowName": "Factory Information",
    "standard": {
    "name": "string",
    "version": "string"
    },
    "rating": "Good",
    "score": "8/10",
    "scoreInPercentage": "80%",
    "totalFindings": [
    {
    "severity": "Critical",
    "findings": 5
    }
    ],
    "numberOfAreaToImproves": 12,
    "assessmentDueDate": "2024-09-30T10:36:56.057000+00:00",
    "assessmentWindowStart": "2024-09-30T10:36:56.057000+00:00",
    "assessmentWindowEnd": "2024-09-30T10:36:56.057000+00:00",
    "auditStartDate": "2024-09-30",
    "auditEndDate": "2024-09-30",
    "assessmentSubmitDate": "2024-09-30T10:36:56.057000+00:00",
    "assessmentStartDate": "2024-09-30T10:36:56.057000+00:00",
    "completeCaseDate": "2024-09-30T10:36:56.057000+00:00",
    "reopenCaseDate": "2024-09-30T10:36:56.057000+00:00",
    "stakeholders": {
    "assessedOrg": {
    "id": "string",
    "name": "string",
    "type": "string",
    "address": "123 Main Street",
    "city": "Abbeville",
    "state": "Alabama",
    "postal": "36310",
    "country": "US"
    },
    "requester": {
    "id": "string",
    "name": "string",
    "type": "string"
    },
    "executors": [
    {
    "id": "string",
    "name": "string",
    "type": "string",
    "contactPersons": [
    {
    "name": "John Doe",
    "title": "Factory Manager",
    "email": "[email protected]",
    "phoneNumber": 1234567890
    }
    ],
    "isPlaceholder": false,
    "ableToSubmitAssessment": true
    }
    ],
    "selectedPartners": [
    {
    "id": "string",
    "name": "string",
    "type": "string"
    }
    ]
    },
    "capa": {
    "id": "1235330e-b74b-4be6-8d8a-cb0560effc11",
    "status": "New",
    "capaLabels": [
    {
    "fieldName": "Priority",
    "value": "High"
    }
    ],
    "dueDate": "2025-01-29T00:00:00.000000+00:00"
    },
    "schedulingStatus": "Scheduled",
    "updatedDate": "2024-09-30T10:36:56.057000+00:00",
    "customFields": {}
    }