Inspectorio REPORT API

openapi: 3.0.3
info:
  title: File Management ANALYTICS REPORT API
  version: v3
servers:
- description: Production Environment
  url: https://files-integration.inspectorio.com
- description: Pre-Production Environment
  url: https://files-integration.pre.inspectorio.com
tags:
- name: REPORT
paths:
  /api/v1/reports:
    get:
      summary: List Reports
      description: List Reports
      parameters:
      - description: Style ID of items included in reports
        in: query
        name: style_id
        required: false
        schema:
          example: Style_1
          type: string
      - description: limit number of results per page
        in: query
        name: limit
        required: false
        schema:
          default: 10
          maximum: 200
          minimum: 1
          type: integer
      - description: End date of the range when reports were created
        in: query
        name: created_to
        required: false
        schema:
          example: '2021-12-31T23:59:59Z'
          format: date-time
          type: string
      - description: End date of the range when reports were updated
        in: query
        name: updated_to
        required: false
        schema:
          example: '2021-12-31T23:59:59Z'
          format: date-time
          type: string
      - description: Start date of the range when reports were updated by the system (including both client actions and actions taken by Inspectorio on behalf of the client)
        in: query
        name: system_updated_from
        required: false
        schema:
          example: '2021-01-31T00:00:00Z'
          format: date-time
          type: string
      - description: Order of reports in response by report creation date in descending or ascending
        in: query
        name: order
        required: false
        schema:
          default: created_date:desc
          example: created_date:desc|asc
          type: string
      - description: CAPA status of the report
        in: query
        name: capa_status
        required: false
        schema:
          enum:
          - Waiting for Response
          - Submitted
          - Submitted by Reviewer
          - Rejected
          - Re-inspection Requested (Solved)
          - Re-inspection Requested (Unsolved)
          - Approved
          example: Waiting for Response
          type: string
      - in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: Start date of the range when reports were updated
        in: query
        name: updated_from
        required: false
        schema:
          example: '2021-01-31T00:00:00Z'
          format: date-time
          type: string
      - description: Start date of the range when reports were created
        in: query
        name: created_from
        required: false
        schema:
          example: '2021-01-31T00:00:00Z'
          format: date-time
          type: string
      - description: Status of reports
        in: query
        name: status
        required: false
        schema:
          enum:
          - in-progress
          - pending
          - completed
          example: in-progress
          type: string
      - description: End date of the range when reports were updated by the system (including both client actions and actions taken by Inspectorio on behalf of the client)
        in: query
        name: system_updated_to
        required: false
        schema:
          example: '2021-12-31T23:59:59Z'
          format: date-time
          type: string
      - description: End date of the range of inspection date in reports
        in: query
        name: inspection_date_to
        required: false
        schema:
          example: '2021-12-31T23:59:59Z'
          format: date-time
          type: string
      - description: Start date of the range of inspection date in reports
        in: query
        name: inspection_date_from
        required: false
        schema:
          example: '2021-01-31T00:00:00Z'
          format: date-time
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportListResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestApiError'
          description: Bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedApiError'
          description: Unauthorized
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateApiError'
          description: Validation Error
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyResponsesApiError'
          description: Rate-limiting Error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalApiError'
          description: Internal Error
      tags:
      - REPORT
  /api/v1/reports/{report_id}:
    get:
      summary: Get Report
      description: Get Report
      parameters:
      - in: path
        name: report_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestApiError'
          description: Bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedApiError'
          description: Unauthorized
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateApiError'
          description: Validation Error
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyResponsesApiError'
          description: Rate-limiting Error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalApiError'
          description: Internal Error
      tags:
      - REPORT
  /api/v1/reports/{report_id}/steps/{step_id}:
    get:
      description: Get Step Execution
      operationId: getStepExecution
      parameters:
      - in: path
        name: step_id
        required: true
        schema:
          type: string
      - in: path
        name: report_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StepExecutionResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestApiError'
          description: Bad request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedApiError'
          description: Unauthorized
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateApiError'
          description: Validation Error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalApiError'
          description: Internal Error
      summary: Get Step Execution
      tags:
      - REPORT
components:
  schemas:
    StepExecutionAnswerChoiceSubQuestionAnswer:
      properties:
        choices:
          description: List of choices for the question
          items:
            $ref: '#/components/schemas/StepExecutionAnswerChoiceSubQuestionAnswerChoice'
          nullable: true
          type: array
        files:
          description: Files attached to the question
          items:
            type: object
          nullable: true
          type: array
        id:
          description: Unique identifier of the question in the question/answer set
          nullable: true
          type: string
        isNotApplicable:
          description: Indicates whether the answer was set to 'Not Applicable'
          type: boolean
        mappedIssues:
          description: List of mapped issues of the question
          items:
            $ref: '#/components/schemas/StepExecutionAnswerChoiceSubQuestionAnswerMappedIssue'
          nullable: true
          type: array
        number:
          description: Number of the question
          nullable: true
          type: integer
        parentId:
          description: Unique identifier of the parent question
          nullable: true
          type: string
        questionId:
          description: Unique identifier of the question
          nullable: true
          type: string
        text:
          description: Text describes the question
          nullable: true
          type: string
      type: object
    InspectionQuestionsOptions:
      properties:
        actions:
          description: List of actions per question
          items:
            $ref: '#/components/schemas/InspectionQuestionsOptionsActions'
          type: array
        failResponse:
          description: Boolean indicating whether the option, if selected, will make the overall inspection result fail
          example: 'false'
          type: boolean
        id:
          description: Unique identifier of the option
          example: chk__97
          type: string
        selected:
          description: Boolean indicating whether the option has been selected
          example: 'true'
          type: boolean
        value:
          description: Label of the option displayed to the user
          example: 'YES'
          type: string
      type: object
    IdName:
      properties:
        id:
          description: Unique identifier
          nullable: true
          type: string
        name:
          description: Name
          nullable: true
          type: string
      type: object
    TooManyResponsesApiError:
      properties:
        errorCode:
          example: Generic
          type: string
        message:
          example: Too many requests
          type: string
      type: object
    InspectionPhotosFile:
      properties:
        description:
          description: Description of the photo, if any
          example: photo_1
          type: string
        fileType:
          description: Type of the file
          example: image
          type: string
        rotateAngle:
          description: Angle of rotation of the photo
          example: '0'
          type: string
        source:
          description: Direct URL to the photo
          example: https://.../.../.../1a2b3c4d-1a2b-1a2b-1a2b3c4d_eb77a158.jpg
          type: string
      type: object
    InspectionMeasurement:
      properties:
        caption:
          minLength: 1
          type: string
        isPomCritical:
          description: Measurement is critical or not
          example: 'true'
          nullable: true
          type: boolean
        pom:
          minLength: 1
          type: string
        sizes:
          items:
            $ref: '#/components/schemas/BookingMeasurementItemDetail'
          type: array
        tolerance:
          type: string
        toleranceLower:
          description: Accepted lower limit between the expected measure (standard) and the actual measure
          example: 1
          nullable: true
          type: number
        toleranceUpper:
          description: Accepted upper limit between the expected measure (standard) and the actual measure
          example: 1
          nullable: true
          type: number
        unit:
          enum:
          - inch
          - cm
          - mm
          type: string
      required:
      - caption
      - pom
      - tolerance
      - unit
      type: object
    InspectionStandards:
      properties:
        aql:
          $ref: '#/components/schemas/InspectionStandardsAql'
          description: Information on the AQL table
        availableQuantity:
          description: Total of available quantity to inspect
          example: '72'
          type: integer
        countedForAql:
          $ref: '#/components/schemas/InspectionStandardsCountedForAql'
          description: Number of defects found that counted for AQL per classification
          nullable: true
        defectFound:
          $ref: '#/components/schemas/InspectionStandardsDefectFound'
          description: Number of defects found per classification, e.g. 0 Minor, 2 Major, 0 Critical
        defectiveUnitActivate:
          description: Boolean indicating whether defective unit was activated
          example: 'false'
          nullable: true
          type: boolean
        determineDesc:
          description: Determine Desc
          example: AQL Standard
          type: string
        determineType:
          description: Determine Type
          example: aqlTable
          type: string
        determineValue:
          description: Determine Value
          example: '0'
          type: integer
        doubleSampling:
          description: Boolean indicating whether double sampling was activated
          example: 'false'
          type: boolean
        failReason:
          description: Reason for the failure
          example: critical
          type: string
        group:
          description: Group of the defect, e.g. Workmanship, Packaging
          example: workmanship
          type: string
        inspectionId:
          description: Unique identifier of the report
          example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
          type: string
        maxAllowed:
          $ref: '#/components/schemas/InspectionStandardsMaxAllowed'
          description: List of maximum allowed defect per classification, e.g. 0 Minor, 1 Major, 0 Critical
        maximumSampleSize:
          description: Maximum sample size
          example: '8'
          type: integer
        minimumSampleSize:
          description: Minimum sample size
          example: '13'
          type: integer
        noOfDefectiveItems:
          description: Number of defective items
          example: '1'
          type: integer
        noOfDefectiveUnits:
          description: Number of defective units
          example: '2'
          type: integer
        organizationId:
          description: Unique identifier of the organization who executed the inspection
          example: '200373'
          type: string
        packingType:
          description: List of all packing types
          example: Solid; Assortment
          type: string
        sampleSizeCategory:
          description: Information on the sample size category
          items:
            $ref: '#/components/schemas/InspectionStandardsSampleSizeCategory'
          type: array
        totalDefects:
          description: Total defects found
          example: '2'
          type: string
        totalItems:
          description: Total items
          example: '2'
          type: integer
      type: object
    ReportResponse:
      properties:
        inspectionDefectList:
          description: Defect list of the report
          items:
            $ref: '#/components/schemas/InspectionDefectList'
          type: array
        inspectionEsignatures:
          description: Information on the eSignature
          items:
            $ref: '#/components/schemas/ReportResponseSchemaInspectionEsignatures'
          nullable: true
          type: array
        inspectionGeneral:
          $ref: '#/components/schemas/InspectionGeneral'
          description: General information of the report
        inspectionMeasurementDimensions:
          description: Measurement dimensions
          items:
            $ref: '#/components/schemas/InspectionMeasurementDimensions'
          type: array
        inspectionPhotos:
          description: List of photos taken during the inspection
          items:
            $ref: '#/components/schemas/InspectionPhotos'
          type: array
        inspectionQuestions:
          description: List of questions followed by the inspector
          items:
            $ref: '#/components/schemas/InspectionQuestions'
          type: array
        inspectionRFID:
          description: Result of the RFID step taken during the inspection
          items:
            $ref: '#/components/schemas/InspectionRfid'
          type: array
        inspectionResult:
          description: Result of each section of the report
          items:
            $ref: '#/components/schemas/InspectionResult'
          type: array
        inspectionSampleSelection:
          description: Details of the sample selection calculation
          items:
            $ref: '#/components/schemas/InspectionSampleSelection'
          type: array
        inspectionSampleSelectionSamples:
          description: Details of the samples selected by the inspector
          items:
            $ref: '#/components/schemas/InspectionSampleSelectionSamples'
          type: array
        inspectionSpecialAttentionPoint:
          description: List of special attention points raised by the inspector
          items:
            $ref: '#/components/schemas/InspectionSpecialAttentionPoint'
          type: array
        inspectionStandards:
          description: Information on the inspection standards followed by the inspector
          items:
            $ref: '#/components/schemas/InspectionStandards'
          type: array
        itemAttributes:
          description: List of item attribute
          items:
            $ref: '#/components/schemas/ItemAttributes'
          nullable: true
          type: array
      type: object
    StepExecutionStep:
      properties:
        formSchema:
          allOf:
          - $ref: '#/components/schemas/StepExecutionForm'
          description: Form Schema that describes the schema of forms included in the report step
        id:
          description: Unique identifier of the report step
          example: 123ce62d-892c-4e54-a8c3-3b6f52f0d915
          nullable: true
          type: string
        name:
          description: Name of the report step
          example: Factory Information
          nullable: true
          type: string
      type: object
    ReportDetailSection:
      properties:
        id:
          description: Unique identifier of the section
          example: 123b8df5-6174-4b88-abb7-74b183ec1e70
          nullable: true
          type: string
        improvements:
          description: List of improvements of the section
          items:
            $ref: '#/components/schemas/ReportDetailImprovement'
          nullable: true
          type: array
        level:
          description: Level of the section
          example: 0
          nullable: true
          type: integer
        maxScore:
          description: Maximum score as an float
          example: 7.5
          nullable: true
          type: number
        name:
          description: Name of the section
          example: Manufacturing Control Plan
          nullable: true
          type: string
        parentId:
          description: Unique identifier of the parent of the section
          example: 123f99a2-b857-4b9c-986d-54a224cad9ec
          nullable: true
          type: string
        path:
          description: Path of the section
          example: 123f99a2-b857-4b9c-986d-54a224cad9ec
          items:
            type: string
          nullable: true
          type: array
        score:
          description: Score of the section as an float
          example: 6
          nullable: true
          type: number
      type: object
    BookingAssortmentItem:
      properties:
        availableQuantity:
          nullable: true
          readOnly: true
          type: integer
        brandId:
          description: 'Precondition: must be configured in your Inspectorio''s account.'
          example: brand_1
          nullable: true
          type: string
        brandName:
          minLength: 1
          readOnly: true
          type: string
        classId:
          example: class_id_1
          nullable: true
          type: string
        color:
          minLength: 1
          type: string
        configuration:
          minimum: 1
          type: integer
        departmentId:
          example: department_id_1
          nullable: true
          type: string
        id:
          nullable: true
          type: string
        itemId:
          minLength: 1
          type: string
        quantity:
          readOnly: true
          type: integer
        shipmentTerm:
          example: shipment_term_1
          nullable: true
          type: string
        size:
          minLength: 1
          type: string
      required:
      - color
      - configuration
      - itemId
      - size
      type: object
    BookingInspectionInformation:
      properties:
        typeOfInspection:
          example: FRI
          type: string
        typeOfInspectionName:
          example: Final Random Inspection
          type: string
      type: object
    InspectionStandardsAql:
      properties:
        aqlId:
          description: Unique identifier of the AQL table
          example: 31ade06c-1a0b-11e9-83b2-320fe256275a
          type: string
        aqlLevel:
          description: Inspection level
          example: ii
          nullable: true
          type: string
        aqlName:
          description: The name of the AQL table
          example: Packaging
          type: string
        critical:
          description: The threshold used for critical defects
          example: '0.010'
          type: string
        major:
          description: The threshold used for major defects
          example: '2.5'
          type: string
        minor:
          description: The threshold used for minor defects
          example: '2.5'
          type: string
        source:
          description: The source of the AQL table
          example: 'null'
          type: string
      type: object
    ReportListInspectionGeneral:
      properties:
        actualInspectionDate:
          description: Date when the inspection was started on mobile
          example: '2021-06-03T00:00:00+00:00'
          format: date-time
          nullable: true
          type: string
        bookingType:
          description: Type of the booking, e.g. Normal
          example: normal
          type: string
        capaStatus:
          description: Status of the CAPA
          example: Waiting for Response
          type: string
        caseNumber:
          description: Case number of the report generated based on a configurable rule
          example: 5832DUPRO2019-00537345TESTMTTestInspectorioFactoryASOLID-ASSORTMENT2019-12-095832IS
          type: string
        client:
          $ref: '#/components/schemas/InspectionGeneralOrganizationWithLocalId'
          description: Information on the brand/retailer
          nullable: true
        country:
          description: Country of shipment
          example: VN
          type: string
        createdDate:
          description: Date and time when the inspection started
          example: '2021-06-03 07:18:05.372000+00:00'
          type: string
        creator:
          $ref: '#/components/schemas/User'
          description: Information on the user who generated the report
          nullable: true
        executor:
          $ref: '#/components/schemas/InspectionGeneralOrganization'
          description: Information on the executor of the report
          nullable: true
        expectedDate:
          description: Expected date of inspection that was selected when creating a new inspection
          example: '2021-06-03 00:00:00+00:00'
          type: string
        factory:
          $ref: '#/components/schemas/InspectionGeneralOrganizationWithLocalId'
          description: Information on the factory of the report
          nullable: true
        inspectionDate:
          description: Date and time when the inspection completed
          example: '2021-06-03 08:27:20.624000+00:00'
          type: string
        inspectionId:
          description: Unique identifier of the inspection's report
          example: 123a456b-abcd-efgh-ijk1-a88aa05d7c86
          type: string
        inspectionForm:
          description: The name of the inspection form used
          example: FIForm
          type: string
        inspectionLocation:
          $ref: '#/components/schemas/InspectionGeneralOrganizationWithLocalId'
          description: The location of the inspection
          example: 'null'
          nullable: true
        inspectionResult:
          description: Overall result of the inspection
          example: fail
          type: string
        inspector:
          $ref: '#/components/schemas/Inspector'
          description: Information on the inspector
          nullable: true
        isReferenceSample:
          description: Indicates whether a reference sample had been provided
          example: 'null'
          type: integer
        opoNumber:
          description: Original PO Number of the report
          example: 123-456
          type: string
        oversightOffice:
          $ref: '#/components/schemas/InspectionGeneralOversightOffice'
          description: Oversight office
          nullable: true
        pdfUrl:
          description: Direct URL to the report in PDF format
          example: https://.../.../.../.../case-number_123a456b-abcd-efgh-ijk1-a88aa05d7c86.pdf
          type: string
        poNumber:
          description: PO Number of the report
          example: 123-456-L001
          type: string
        productCategories:
          description: List of unique identifiers of all the product categories
          items:
            type: string
          nullable: true
          type: array
        productLineId:
          description: Unique identifier of the product line
          example: '100991'
          type: string
        productLineName:
          description: Name of the product line
          example: APPAREL
          type: string
        productOrders:
          description: List of all the PO numbers
          items:
            type: string
          nullable: true
          type: array
        productStyles:
          description: List of all the styles with items and measurements
          items:
            $ref: '#/components/schemas/ReportListProductStyle'
          nullable: true
          type: array
        status:
          description: Status of the report, e.g. In-Progress, Completed
          example: completed
          type: string
        systemUpdatedAt:
          description: Date and time the report was last updated by the system (including both client actions and actions taken by Inspectorio on behalf of the client)
          example: '2021-06-03 08:27:21.316000+00:00'
          type: string
        tags:
          description: Labels attached to the report giving other information, e.g. 1st re-inspection
          example: 'null'
          items:
            type: string
          nullable: true
          type: array
        type:
          $ref: '#/components/schemas/BookingInspectionInformation'
          description: Information on the type of inspection
          nullable: true
        updatedDate:
          description: Date and time the report was last updated
          example: '2021-06-03 08:27:21.316000+00:00'
          type: string
        vendor:
          $ref: '#/components/schemas/InspectionGeneralOrganizationWithLocalId'
          description: Information on the supplier of the report
          nullable: true
        workflowName:
          description: Name of workflow
          example: DUPRO Apparel workflow
          nullable: true
          type: string
      type: object
    ReportListResponse:
      properties:
        data:
          description: List of reports data
          items:
            $ref: '#/components/schemas/ReportListInspectionGeneral'
          type: array
        limit:
          maximum: 100
          minimum: 1
          type: integer
        offset:
          minimum: 0
          type: integer
        total:
          type: integer
      required:
      - limit
      - offset
      - total
      type: object
    StepExecution:
      properties:
        appTestResults:
          description: App test results in the step execution
          items:
            $ref: '#/components/schemas/StepExecutionAppTestResult'
          nullable: true
          type: array
        assessmentExecution:
          allOf:
          - $ref: '#/components/schemas/StepExecutionSchemaAssessmentExecution'
          description: Information on the execution of the assessment
        formData:
          allOf:
          - $ref: '#/components/schemas/StepExecutionFormData'
          description: Detailed data of the form in the step execution
        id:
          description: Unique identifier of the step execution
          example: 123d1b06-c172-4cc3-a905-64840ec0a020
          nullable: true
          type: string
        issues:
          description: List of Issues in the step execution
          items:
            $ref: '#/components/schemas/StepExecutionIssue'
          nullable: true
          type: array
        questionAnswers:
          description: List of Questions/Answers in the step execution
          items:
            $ref: '#/components/schemas/StepExecutionQuestionAnswer'
          nullable: true
          type: array
        questionnaire:
          allOf:
          - $ref: '#/components/schemas/StepExecutionQuestionnaire'
          description: Questionnaire information
        report:
          allOf:
          - $ref: '#/components/schemas/ReportDetailStepExecutionReport'
          description: Information of the report
        status:
          description: Status of the step execution
          example: COMPLETED
          nullable: true
          type: string
        step:
          allOf:
          - $ref: '#/components/schemas/StepExecutionStep'
          description: Information of the step execution
        stepId:
          description: Unique identifier of the step execution
          example: 123ce62d-892c-4e54-a8c3-3b6f52f0d915
          nullable: true
          type: string
        updatedBy:
          allOf:
          - $ref: '#/components/schemas/ReportDetailUser'
          description: Information of the user who last updated the step execution
        updatedDate:
          description: Last updated date of the step execution
          example: '2021-06-24T15:04:28.402000+00:00'
          format: date-time
          nullable: true
          type: string
      type: object
    InspectionGeneralPos:
      properties:
        poNumber:
          description: PO Number of the report
          example: PO123
          type: string
      type: object
    InspectionResult:
      properties:
        groupName:
          description: Name of the group of results
          example: Check In
          type: string
        includeInReport:
          description: Boolean indicating if the result is included in the report
          example: 'true'
          type: boolean
        inspectionId:
          description: Unique identifier of the report
          example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
          type: string
        organizationId:
          description: Unique identifier of the organization who executed the inspection
          example: '200373'
          type: string
        resultId:
          description: Unique identifier of the result
          example: 7384b63c-bc99-43f0-b1b5-600959220e19_6e451830-1d61-4a14-a5e7-03ce20704f52
          type: string
        status:
          description: Status of the result
          example: non-applicable
          type: string
      type: object
    InspectionAssortment:
      properties:
        assortmentId:
          minLength: 1
          type: string
        availableCartonQuantity:
          nullable: true
          readOnly: tru

# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/inspectorio/refs/heads/main/openapi/inspectorio-report-api-openapi.yml