Get Report

GET 
/api/v1/reports/:report_id

Get Report

Request

Path Parameters

report_id stringrequired

Responses

200

OK

application/json

Schema

Schema

data

object

areaToImprove integernullable

Areas to improve

assessmentExecution

object

Information on the execution of the assessment

ableToCompleteCase boolean

Is able to complete the case

ableToReject boolean

Is able to reject the assessment

ableToReopenCase boolean

Is able to reopen the case

ableToRequestAssessment boolean

Is able to request a self-assessment

ableToRequestVerification boolean

Is able to request a verification assessment

assessmentDueDate date-timenullable

Due date of the assessment

assessmentId stringnullable

Unique identifier of the assessment

assessmentRequestDate date-timenullable

Request date of the assessment

assessmentStartDate date-timenullable

Start date of the assessment

assessmentSubmitDate date-timenullable

Submit date of the assessment

assignedUsers

object[]

nullable

Information of the assigned user

Array [

email stringnullable

Email of the assigned user

firstName stringnullable

Firstname of the assigned user

id stringnullable

Id of the assigned user

lastName stringnullable

Lastname of the assigned user

]

assignee

object

Information of the organization

id stringnullable

Unique identifier of the organization

name stringnullable

Name of the organization

type stringnullable

Type of the organization, e.g. RETAILER, FACTORY, PARTNER, etc.

uid stringnullable

Unique technical identifier of the organization

auditEndDate datenullable

The date ended auditing

auditStartDate datenullable

The date started auditing

auditors

object[]

nullable

List of auditor for this assessment

Array [

auditorId stringnullable

Id of the auditor

email stringnullable

Email of the auditor

name stringnullable

Name of the auditor

phoneNumber stringnullable

Phone number of the auditor

]

case

object

Case of the assessment

dueDate date-timenullable

Due date of the case

history

object

History of the case

comment stringnullable

Comment of the update

reasons string[]nullable

Reasons set by user for the case history update

updatedDate date-timenullable

Updated data of the case

updatedValidityDuration stringnullable

Validity Duration set by user or calculated using Expiration Date

id stringnullable

Unique identifier of the case

status stringnullable

Status of the case, e.g. OPEN, REOPEN, CLOSED

uid stringnullable

Unique technical identifier of the case

caseIndex integernullable

Case index of the assessment representing the order of the assessments

confidentialNote

object

List of confidential notes

description stringnullable

Description

declineReasons string[]nullable

The reason for which the report is declined

escalations

object[]

nullable

List of escalations of the assessment

Array [

createdDate date-timenullable

Date when the Escalation was created

escalatedBy

object

Information of the user

email stringnullable

Email address of the user

firstName stringnullable

First name of the user

id stringnullable

Unique identifier of the user

lastName stringnullable

Last name of the user

escalatedTo

object[]

nullable

The user who receives the escalation

Array [

email stringnullable

Email address of the user

firstName stringnullable

First name of the user

id stringnullable

Unique identifier of the user

lastName stringnullable

Last name of the user

]

escalationNote stringnullable

Escalation note

resolvedByUser

object

Information of the user

email stringnullable

Email address of the user

firstName stringnullable

First name of the user

id stringnullable

Unique identifier of the user

lastName stringnullable

Last name of the user

resolvedDate date-timenullable

Resolution date of the escalation

status stringnullable

Status of the escalation

]

executionLocations string[]nullable

List of locations of the execution

id string

Unique technical identifier of the assessment execution information

nextAssessment

object

Next follow up assessment

assessmentDueDate stringnullable

The date by which the next follow-up assessment should be submitted

assessmentLocation stringnullable

The location where the next follow-up assessment will be conducted

followUpType stringnullable

The type of the next follow-up assessment

reason

object

Information on the reason of the assessment

id stringnullable

Unique identifier

name stringnullable

Name

requestee

object

Information of the organization who has received the assessment

address stringnullable

Address of the organization who submitted the assessment

city stringnullable

City of the organization who submitted the assessment

country stringnullable

Country of the organization who submitted the assessment

email stringnullable

Contact email of the organization who submitted the assessment

id stringnullable

Unique identifier of the organization who submitted the assessment

name stringnullable

Name of the organization who submitted the assessment

province stringnullable

Province of the organization who submitted the assessment

type stringnullable

Type of the organization who submitted the assessment

uid stringnullable

Unique technical identifier of the organization who submitted the assessment

sourceAssessmentExecId stringnullable

Unique identifier of the source of the assessment execution

status stringnullable

Status of the assessment

type stringnullable

Type of the assessment

workflow

object

Information of the workflow

id stringnullable

Unique identifier of the workflow

name stringnullable

Name of the workflow

standard

object

Information of the standard of the workflow

createdDate date-timenullable

Creation date of the standard

id stringnullable

Unique identifier of the standard

name stringnullable

Name of the standard

owner

object

Information of the owner of the standard

id stringnullable

Unique identifier of the organization

name stringnullable

Name of the organization

type stringnullable

Type of the organization, e.g. RETAILER, FACTORY, PARTNER, etc.

uid stringnullable

Unique technical identifier of the organization

type stringnullable

Type of the standard

version numbernullable

The standard version of the report

capa

object

CAPA report information

dueDate date-timenullable

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

followUpType stringnullable

Follow-up type of the CAPA

id stringnullable

Unique identifier of the CAPA

resolutionDate date-timenullable

Resolution date

rootCauses string[]nullable

List of root causes

status stringnullable

Status of the CAPA

completionEvent

object

Information on the completion of the events

id stringnullable

Unique identifier of an event

updatedByOrg

object

Information of the organization who last updated the event

id stringnullable

Unique identifier of the organization

name stringnullable

Name of the organization

type stringnullable

Type of the organization, e.g. RETAILER, FACTORY, PARTNER, etc.

uid stringnullable

Unique technical identifier of the organization

updatedByUser

object

Information of the user who last updated the event

email stringnullable

Email address of the user

firstName stringnullable

First name of the user

id stringnullable

Unique identifier of the user

lastName stringnullable

Last name of the user

updatedDate date-timenullable

Updated date

createdDate date-timenullable

Creation date of the report

exception stringnullable

Exception of the report

expirationDate date-timenullable

Expiration date set by the user or calculated using Validity Duration

id string

Unique identifier of the report

isHidePreview boolean

Indicates whether the preview of the score is hidden

isHideScore boolean

Indicates whether the score is hidden

isLastInCase boolean

Indicates whether this report is last in the case

isNonCompliant boolean

Indicates whether the report is non-compliant

labels

object[]

nullable

Labels

Array [

label stringnullable

Type of label assigned in the assignment/report/CAPA

value stringnullable

Label assigned in the assignment/report/CAPA

]

reportName stringnullable

Name of the report

status stringnullable

Status of the report

stepExecutions

object[]

nullable

Information on the execution of the steps

Array [

assessmentExeId stringnullable

Unique identifier of the assessment

id stringnullable

Unique technical identifier

questionnaire

object

Information on the questionnaire

id stringnullable

Unique identifier

name stringnullable

Name

report

object

Information on the report

createdDate date-timenullable

Creation date of the step

id stringnullable

Unique identifier of the step

isHideScore boolean

Indicates whether the score is hidden

maxScore numbernullable

Maximum score of the step

ratingLabel

object

Rating label

id stringnullable

Unique identifier

name stringnullable

Name

score numbernullable

Score of the step

sections

object[]

nullable

List of sections

Array [

id stringnullable

Unique identifier of the section

improvements

object[]

nullable

List of improvements of the section

Array [

answerId stringnullable

Unique identifier of the answer of the improvement

content stringnullable

Content of the improvement

customTags

object[]

nullable

List of custom tags of the improvement

Array [

id stringnullable

Unique identifier

name stringnullable

Name

]

id stringnullable

Unique identifier of the improvement

]

level integernullable

Level of the section

maxScore numbernullable

Maximum score as an float

name stringnullable

Name of the section

parentId stringnullable

Unique identifier of the parent of the section

path string[]nullable

Path of the section

score numbernullable

Score of the section as an float

]

stepExeId stringnullable

Unique technical identifier of the step

step

object

Information on the step

id stringnullable

Unique identifier of the step

name stringnullable

Name of the step

order integernullable

Order of the step

]

type stringnullable

Type of the report

updatedDate date-timenullable

Update date of the report

Example (from schema)

{
  "data": {
    "areaToImprove": 1,
    "assessmentExecution": {
      "ableToCompleteCase": "true",
      "ableToReject": "false",
      "ableToReopenCase": "false",
      "ableToRequestAssessment": "false",
      "ableToRequestVerification": "false",
      "assessmentDueDate": "2021-06-27T06:04:19+00:00",
      "assessmentId": "12313-2",
      "assessmentRequestDate": "2021-06-23T06:06:19.116000+00:00",
      "assessmentStartDate": "2021-06-23T06:06:35.880000+00:00",
      "assessmentSubmitDate": "2021-06-27T09:35:40.899000+00:00",
      "assignedUsers": [
        {
          "email": "[email protected]",
          "firstName": "John",
          "id": "abc123",
          "lastName": "Doe"
        }
      ],
      "assignee": {
        "id": "abc67433-c8d8-4779-a0f1-3f1490e2dde9",
        "name": "Acme Corp",
        "type": "RETAILER",
        "uid": "V123"
      },
      "auditEndDate": "2022-02-24",
      "auditStartDate": "2022-02-24",
      "auditors": [
        {
          "auditorId": "abc123",
          "email": "[email protected]",
          "name": "John Doe",
          "phoneNumber": "0123456789"
        }
      ],
      "case": {
        "dueDate": "2021-05-31T10:06:39+00:00",
        "history": {
          "comment": "Updated validity duration",
          "reasons": [
            "string"
          ],
          "updatedDate": "2021-05-31T10:06:39+00:00",
          "updatedValidityDuration": "1 Month"
        },
        "id": "abc1eab1-5163-4b52-861e-048de01be509",
        "status": "OPEN",
        "uid": "991072"
      },
      "caseIndex": 2,
      "confidentialNote": {
        "description": "string"
      },
      "declineReasons": [
        "string"
      ],
      "escalations": [
        {
          "createdDate": "2024-09-26T07:09:45.557Z",
          "escalatedBy": {
            "email": "[email protected]",
            "firstName": "John",
            "id": "cc94fc4e-dcbe-44a5-863e-3255281e02ca",
            "lastName": "Doe"
          },
          "escalatedTo": [
            {
              "email": "[email protected]",
              "firstName": "John",
              "id": "cc94fc4e-dcbe-44a5-863e-3255281e02ca",
              "lastName": "Doe"
            }
          ],
          "escalationNote": "string",
          "resolvedByUser": {
            "email": "[email protected]",
            "firstName": "John",
            "id": "cc94fc4e-dcbe-44a5-863e-3255281e02ca",
            "lastName": "Doe"
          },
          "resolvedDate": "2024-09-26T07:09:45.557Z",
          "status": "string"
        }
      ],
      "executionLocations": "Factory Visit",
      "id": "4d9fc6cc-18d9-466c-922c-259843651506",
      "nextAssessment": {
        "assessmentDueDate": "2021-05-31T10:06:39+00:00",
        "assessmentLocation": "string",
        "followUpType": "string"
      },
      "reason": {
        "id": "string",
        "name": "string"
      },
      "requestee": {
        "address": "5 Tao Bao Road",
        "city": "Taizhou",
        "country": "CN",
        "email": "[email protected]",
        "id": "13440bd6-2915-495f-9b34-796fa80e3feb",
        "name": "Lex Corp",
        "province": "Zhejiang",
        "type": "FACTORY",
        "uid": "F123596"
      },
      "sourceAssessmentExecId": "84e969e2-d5a0-4514-9ce2-25ec898ec409",
      "status": "DONE",
      "type": "Verification Assessment",
      "workflow": {
        "id": "a96104b2-9e16-4438-b7be-45cc4a51f066",
        "name": "QAFA Workflow",
        "standard": {
          "createdDate": "2021-06-27T09:35:40.899000+00:00",
          "id": "2d42fee0-f9df-4469-8a13-39032f1d1d37",
          "name": "Quality Assurance Factory Assessment",
          "owner": {
            "id": "abc67433-c8d8-4779-a0f1-3f1490e2dde9",
            "name": "Acme Corp",
            "type": "RETAILER",
            "uid": "V123"
          },
          "type": "PRODUCTION",
          "version": 1.23
        }
      }
    },
    "capa": {
      "dueDate": "2021-05-31T10:06:39+00:00",
      "followUpType": "",
      "id": "1235330e-b74b-4be6-8d8a-cb0560effc11",
      "resolutionDate": "2024-09-26T07:09:45.558Z",
      "rootCauses": [
        "string"
      ],
      "status": "NEW"
    },
    "completionEvent": {
      "id": "123299f1-b5de-4556-823c-75c9efa042a6",
      "updatedByOrg": {
        "id": "abc67433-c8d8-4779-a0f1-3f1490e2dde9",
        "name": "Acme Corp",
        "type": "RETAILER",
        "uid": "V123"
      },
      "updatedByUser": {
        "email": "[email protected]",
        "firstName": "John",
        "id": "cc94fc4e-dcbe-44a5-863e-3255281e02ca",
        "lastName": "Doe"
      },
      "updatedDate": "2021-06-27T09:35:40.899000+00:00"
    },
    "createdDate": "2021-06-24T15:33:23.461000+00:00",
    "exception": "string",
    "expirationDate": "2021-06-02T05:28:49.303000+00:00",
    "id": "123bdb6d-9037-41a3-b0b5-42bdd30a8423",
    "isHidePreview": true,
    "isHideScore": true,
    "isLastInCase": true,
    "isNonCompliant": true,
    "labels": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "reportName": "QAFA123",
    "status": "Verification Requested",
    "stepExecutions": [
      {
        "assessmentExeId": "4d9fc6cc-18d9-466c-922c-259843651506",
        "id": "1232ef21-2ed2-47c2-b969-b308f9e8edb3",
        "questionnaire": {
          "id": "string",
          "name": "string"
        },
        "report": {
          "createdDate": "2021-06-27T09:35:21.380000+00:00",
          "id": "1239c6ab-55ad-47a2-847d-2973ed4b00aa",
          "isHideScore": "false",
          "maxScore": 135,
          "ratingLabel": {
            "id": "string",
            "name": "string"
          },
          "score": 72,
          "sections": [
            {
              "id": "123b8df5-6174-4b88-abb7-74b183ec1e70",
              "improvements": [
                {
                  "answerId": "12372c66-f8ec-40c8-a0c7-355f6205c81e",
                  "content": "Is the facility clean and organized?",
                  "customTags": [
                    {
                      "id": "string",
                      "name": "string"
                    }
                  ],
                  "id": "123df8c5-6b69-4ae2-9cb8-f94fff3ce1f2"
                }
              ],
              "level": 0,
              "maxScore": 7.5,
              "name": "Manufacturing Control Plan",
              "parentId": "123f99a2-b857-4b9c-986d-54a224cad9ec",
              "path": "123f99a2-b857-4b9c-986d-54a224cad9ec",
              "score": 6
            }
          ],
          "stepExeId": "13ccab58-b11f-486b-9dc9-05ced81729d8"
        },
        "step": {
          "id": "66db47a0-2ca8-463a-9ac1-6c8d7830ee74",
          "name": "Overview Instructions",
          "order": 0
        }
      }
    ],
    "type": "internal",
    "updatedDate": "2021-06-24T17:34:25.690000+00:00"
  }
}

400

Bad request

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Cannot retrieve session data because of expired token"
}

422

Validation Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "type": [
      "Input type is not valid"
    ]
  },
  "message": "Validation error"
}

500

Internal Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "system": [
      "Internal error detail message"
    ]
  },
  "message": "Internal server error"
}

Loading...