Inspectorio REPORT API

openapi: 3.2.0
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:
    InspectionStandardsMaxAllowed:
      properties:
        critical:
          description: The number of critical defects max allowed
          example: '0'
          type: string
        major:
          description: The number of major defects max allowed
          example: '1'
          type: string
        minor:
          description: The number of minor defects max allowed
          example: '1'
          type: string
      type: object
    ValidateApiError:
      properties:
        errorCode:
          example: Generic
          type: string
        errors:
          example:
            type:
            - Input type is not valid
          type: object
        message:
          example: Validation error
          type: string
      type: object
    InspectionAssortment:
      properties:
        assortmentId:
          minLength: 1
          type: string
        availableCartonQuantity:
          readOnly: true
          type:
          - integer
          - 'null'
        cartonQuantity:
          minimum: 0
          type: integer
        items:
          items:
            $ref: '#/components/schemas/InspectionAssortmentItem'
          minItems: 1
          type: array
      required:
      - assortmentId
      - cartonQuantity
      - items
      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
    BookingAssortmentItem:
      properties:
        availableQuantity:
          readOnly: true
          type:
          - integer
          - 'null'
        brandId:
          description: 'Precondition: must be configured in your Inspectorio''s account.'
          example: brand_1
          type:
          - string
          - 'null'
        brandName:
          minLength: 1
          readOnly: true
          type: string
        classId:
          example: class_id_1
          type:
          - string
          - 'null'
        color:
          minLength: 1
          type: string
        configuration:
          minimum: 1
          type: integer
        departmentId:
          example: department_id_1
          type:
          - string
          - 'null'
        id:
          type:
          - string
          - 'null'
        itemId:
          minLength: 1
          type: string
        quantity:
          readOnly: true
          type: integer
        shipmentTerm:
          example: shipment_term_1
          type:
          - string
          - 'null'
        size:
          minLength: 1
          type: string
      required:
      - color
      - configuration
      - itemId
      - size
      type: object
    StepExecutionAnswerChoice:
      properties:
        files:
          description: Files attached to the choice/answer for the question
          items:
            type: object
          type:
          - array
          - 'null'
        id:
          description: Unique identifier of the choice/answer for the question
          example: 12308e4f-67b5-4421-a0a4-2ab365e8a39f
          type:
          - string
          - 'null'
        option:
          allOf:
          - $ref: '#/components/schemas/StepExecutionAnswerChoiceSubQuestionAnswerChoiceOption'
          description: Option selected for the question
          example: 12308e4f-67b5-4421-a0a4-2ab365e8a39f
        optionId:
          description: Unique identifier of the option selected as the answer for the question
          type:
          - string
          - 'null'
        subQuestionAnswers:
          description: List of sub-questions and answers
          items:
            $ref: '#/components/schemas/StepExecutionAnswerChoiceSubQuestionAnswer'
          type:
          - array
          - 'null'
        text:
          description: Text describing the choice/answer for the question
          type:
          - string
          - 'null'
      type: object
    StepExecutionFormData:
      properties:
        data:
          description: Detailed data of the form
          type: object
        id:
          description: Unique identifier of the form data included in the step execution
          type:
          - string
          - 'null'
      type: object
    StepExecutionAnswerChoiceSubQuestionAnswerChoice:
      properties:
        files:
          description: Files attached to the choice/answer for the question
          items:
            type: object
          type:
          - array
          - 'null'
        id:
          description: Unique identifier of the choice/answer for the question
          example: 12308e4f-67b5-4421-a0a4-2ab365e8a39f
          type:
          - string
          - 'null'
        option:
          allOf:
          - $ref: '#/components/schemas/StepExecutionAnswerChoiceSubQuestionAnswerChoiceOption'
          description: Option selected for the question
          example: 12308e4f-67b5-4421-a0a4-2ab365e8a39f
        optionId:
          description: Unique identifier of the option selected as the answer for the question
          type:
          - string
          - 'null'
        text:
          description: Text describing the choice/answer for the question
          type:
          - string
          - 'null'
      type: object
    StepExecutionOptionAction:
      properties:
        description:
          description: Description of the question/answer
          type:
          - string
          - 'null'
        factoryType:
          allOf:
          - $ref: '#/components/schemas/IdName'
          description: Type of factory
        id:
          description: Unique identifier of the question/answer
          example: 1231cddf-1829-49dc-aff4-2d7043d8c1db
          type:
          - string
          - 'null'
        optionId:
          description: Unique identifier of the option of the question/answer
          example: 123f5fed-29ef-42a1-8f0b-eb58dc87b84d
          type:
          - string
          - 'null'
        questionIds:
          description: List of unique identifiers of the questions
          example: 123df8c5-6b69-4ae2-9cb8-f94fff3ce1f2
          items:
            type: string
          type:
          - array
          - 'null'
        questions:
          description: Recursive list of questions in the assessment
          items:
            type: object
          type:
          - array
          - 'null'
        type:
          description: Type of question/answer
          type:
          - string
          - 'null'
      type: object
    InspectionGeneralOrganizationWithLocalId:
      properties:
        address:
          description: Address of the organization
          example: 5 Madison Avenue
          type: string
        city:
          description: City of the organization
          example: New York
          type: string
        contact:
          $ref: '#/components/schemas/OrganizationContact'
          description: Contact information of the organization
        country:
          description: Country of the organization
          example: US
          type: string
        localOrganizationId:
          description: Local Custom ID of the organization
          example: '123'
          type:
          - string
          - 'null'
        localOrganizationIds:
          description: The list of all connected Local Custom IDs of the organization
          example:
          - '123'
          - ABC
          items:
            type: string
          type:
          - array
          - 'null'
        name:
          description: Name of the organization
          example: Acme Corp
          type: string
        organizationId:
          description: Unique Identifier of the organization
          example: '3123123'
          type: string
      type: object
    StepExecutionQuestionAnswer:
      properties:
        choices:
          description: List of choices for a question
          items:
            $ref: '#/components/schemas/StepExecutionAnswerChoice'
          type:
          - array
          - 'null'
        comments:
          description: List of comments in the question/answer set
          items:
            $ref: '#/components/schemas/StepExecutionComment'
          type:
          - array
          - 'null'
        files:
          description: Files attached to the question/answer set
          items:
            type: object
          type:
          - array
          - 'null'
        findingsIssues:
          description: List of finding issues
          items:
            $ref: '#/components/schemas/StepExecutionQuestionAnswerFindingsIssues'
          type:
          - array
          - 'null'
        id:
          description: Unique identifier of the question/answer set in a questionnaire
          type:
          - string
          - 'null'
        index:
          description: Indicates the position/order of the question/answer set in a questionnaire
          type:
          - integer
          - 'null'
        isNotApplicable:
          description: Indicates whether the answer was set to 'Not Applicable'
          type: boolean
        locked:
          description: Indicates whether the question/answer set is locked or can be editable
          type: boolean
        mappedIssues:
          description: List of mapped issues
          items:
            $ref: '#/components/schemas/StepExecutionAnswerChoiceSubQuestionAnswerMappedIssue'
          type:
          - array
          - 'null'
        number:
          description: Number of the question/answer set
          type:
          - integer
          - 'null'
        parentId:
          description: Unique identifier of the parent question
          type:
          - string
          - 'null'
        questionId:
          description: Unique identifier of the question
          type:
          - string
          - 'null'
        text:
          description: Text describes the question/answer set
          type:
          - string
          - 'null'
      type: object
    ReportDetailImprovement:
      properties:
        answerId:
          description: Unique identifier of the answer of the improvement
          example: 12372c66-f8ec-40c8-a0c7-355f6205c81e
          type:
          - string
          - 'null'
        content:
          description: Content of the improvement
          example: Is the facility clean and organized?
          type:
          - string
          - 'null'
        customTags:
          description: List of custom tags of the improvement
          items:
            $ref: '#/components/schemas/IdName'
          type:
          - array
          - 'null'
        id:
          description: Unique identifier of the improvement
          example: 123df8c5-6b69-4ae2-9cb8-f94fff3ce1f2
          type:
          - string
          - 'null'
      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
    BookingInspectionInformation:
      properties:
        typeOfInspection:
          example: FRI
          type: string
        typeOfInspectionName:
          example: Final Random Inspection
          type: string
      type: object
    ReportDetailOrg:
      description: Information of the organization
      properties:
        id:
          description: Unique identifier of the organization
          example: abc67433-c8d8-4779-a0f1-3f1490e2dde9
          type:
          - string
          - 'null'
        name:
          description: Name of the organization
          example: Acme Corp
          type:
          - string
          - 'null'
        type:
          description: Type of the organization, e.g. RETAILER, FACTORY, PARTNER, etc.
          example: RETAILER
          type:
          - string
          - 'null'
        uid:
          description: Unique technical identifier of the organization
          example: V123
          type:
          - string
          - 'null'
      type: object
    InspectionQuestions:
      properties:
        groupId:
          description: Unique identifier of the group of question
          example: 7384b63c-bc99-43f0-b1b5-600959220e19_1e601f70-3c65-4ea8-931f-4976b9c91b3a
          type: string
        inspectionId:
          description: Unique identifier of the report
          example: abcd1234-ab12-ab12-ab12-abcd1234efgh4568
          type: string
        label:
          description: Label of the question
          example: Do we need to pull a Green sealed sample?
          type: string
        options:
          description: Options available to answer the question
          items:
            $ref: '#/components/schemas/InspectionQuestionsOptions'
          type: array
        organizationId:
          description: Unique identifier of the organization
          example: 'null'
          type: string
        questionId:
          description: Unique identifier of the question
          example: 7384b63c-bc99-43f0-b1b5-600959220e19_5689d212-b001-4ad2-89c7-2c39654d4cc3_SyJivf3CA
          type: string
        type:
          description: Type of the question
          example: 'null'
          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
          type:
          - string
          - 'null'
        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
    InternalApiError:
      properties:
        errorCode:
          example: Generic
          type: string
        errors:
          example:
            system:
            - Internal error detail message
          type: object
        message:
          example: Internal server error
          type: string
      type: object
    ReportResponseSchemaInspectionEsignatures:
      properties:
        id:
          description: Unique Identifier of the inspection eSignature
          example: 123456
          type: integer
        name:
          description: Name of the inspector who provided eSignature
          example: Bob
          type:
          - string
          - 'null'
        signature:
          description: Name of the inspector who provided eSignature
          example: https://example.jpg
          type: string
        title:
          description: Title of the inspector who provided eSignature
          example: Factory Representative
          type: string
      type: object
    InspectionGeneralOversightOffice:
      properties:
        id:
          description: Oversight office id
          example: '111'
          type:
          - string
          - 'null'
        name:
          description: Oversight office name
          example: Acme Oversight Office
          type:
          - string
          - 'null'
      type: object
    InspectionSpecialAttentionPoint:
      properties:
        attentionId:
          description: Unique identifier of the special attention point
          example: remark-ee79693e-cd81-45df-af2e-1ee4628b4123-2020-01-15-14-25-13-182
          type: string
        description:
          description: Description of the special attention point
          example: This is a test
          type: string
        group:
          description: Unique identifier of the special attention point's group
          example: remark-ee79693e-cd81-45df-af2e-1ee4628b4123-2020-01-15-14-25-13-182
          type: string
        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
        pictures:
          description: The list of pictures taken for the special attention point
          items:
            $ref: '#/components/schemas/InspectionSpecialAttentionPointPictures'
          type: array
        type:
          description: The type of special attention point
          example: remark
          type: string
      type: object
    StepExecutionComment:
      properties:
        attachments:
          description: Attachments inserted in the comment of the step execution
          items:
            $ref: '#/components/schemas/StepExecutionAttachment'
          type:
          - array
          - 'null'
        canEdit:
          description: Indicates whether or not the comment can be edited
          type: boolean
        content:
          description: Content of the comment of the step execution
          type:
          - string
          - 'null'
        createdDate:
          description: Creation date of the comment of the step execution
          example: '2022-03-02T06:41:19.633000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        id:
          description: Unique identifier of the comment of the step execution
          type:
          - string
          - 'null'
        isEdited:
          description: Indicates whether or not the comment had been edited
          type: boolean
        organization:
          allOf:
          - $ref: '#/components/schemas/ReportDetailOrg'
          description: Organization of the comment
        user:
          allOf:
          - $ref: '#/components/schemas/ReportDetailUser'
          description: User of the comment of the step execution
      type: object
    ItemAttributes:
      properties:
        code:
          description: Code of item attribute
          example: GC Apparel
          type:
          - string
          - 'null'
        items:
          description: List of item
          items:
            $ref: '#/components/schemas/Item'
          type:
          - array
          - 'null'
        name:
          description: Name of item attribute
          example: Group Code Apparel
          type:
          - string
          - 'null'
        type:
          description: Type of item attribute
          example: single_choice
          type:
          - string
          - 'null'
      type: object
    InspectionSpecialAttentionPointPictures:
      properties:
        rotateAngle:
          description: Angle of rotation of the picture
          example: '0'
          type: string
        source:
          description: Direct URL to the picture
          example: https://.../image1.jpg
          type: string
      type: object
    ReportListProductStyle:
      properties:
        assortments:
          items:
            $ref: '#/components/schemas/BookingAssortment'
          type:
          - array
          - 'null'
        measurements:
          items:
            $ref: '#/components/schemas/InspectionMeasurement'
          type: array
        productCategoryId:
          example: product_category_1
          type: string
        productCategoryName:
          minLength: 1
          readOnly: true
          type: string
        solids:
          items:
            $ref: '#/components/schemas/BookingSolidItem'
          type:
          - array
          - 'null'
        styleId:
          example: style_1
          minLength: 1
          type: string
        styleName:
          type:
          - string
          - 'null'
      required:
      - productCategoryId
      - styleId
      type: object
    TooManyResponsesApiError:
      properties:
        errorCode:
          example: Generic
          type: string
        message:
          example: Too many requests
          type: string
      type: object
    StepExecutionQuestionAnswerFindingsUser:
      properties:
        email:
          description: Email address of the user
          example: john@acme.com
          type:
          - string
          - 'null'
        id:
          description: Unique identifier of the user
          example: cc94fc4e-dcbe-44a5-863e-3255281e02ca
          type:
          - string
          - 'null'
        name:
          description: Name of the auditor
          example: John Doe
          type:
          - string
          - 'null'
      type: object
    StepExecutionAppTestResult:
      properties:
        factoryType:
          allOf:
          - $ref: '#/components/schemas/IdName'
          description: Type of factory in the app test result
        sectionId:
          description: Unique identifier of the section of the app test result
          type:
          - string
          - 'null'
      type: object
    ReportDetailSection:
      properties:
        id:
          description: Unique identifier of the section
          example: 123b8df5-6174-4b88-abb7-74b183ec1e70
          type:
          - string
          - 'null'
        improvements:
          description: List of improvements of the section
          items:
            $ref: '#/components/schemas/ReportDetailImprovement'
          type:
          - array
          - 'null'
        level:
          description: Level of the section
          example: 0
          type:
          - integer
          - 'null'
        maxScore:
          description: Maximum score as an float
          example: 7.5
          type:
          - number
          - 'null'
        name:
          description: Name of the section
          example: Manufacturing Control Plan
          type:
          - string
          - 'null'
        parentId:
          description: Unique identifier of the parent of the section
          example: 123f99a2-b857-4b9c-986d-54a224cad9ec
          type:
          - string
          - 'null'
        path:
          description: Path of the section
          example: 123f99a2-b857-4b9c-986d-54a224cad9ec
          items:
            type: string
          type:
          - array
          - 'null'
        score:
          description: Score of the section as an float
          example: 6
          type:
          - number
          - 'null'
      type: object
    InspectionDefectListPhoto:
      properties:
        description:
          description: Description of the defect photo
          example: Mismatch color
          type: string
        rotateAngle:
          description: Angle of rotation of the defect photo
          example: '0'
          type: string
        source:
          description: Source of the defect photo
          example: https://.../image1.jpg
          type: string
      type: object
    BookingSolidItem:
      properties:
        availableCartonQuantity:
          readOnly: true
          type:
          - integer
          - 'null'
        availableQuantity:
          readOnly: true
          type:
          - integer
          - 'null'
        brandId:
          description: 'Precondition: must be configured in your Inspectorio''s account.'
          example: brand_1
          type:
          - string
          - 'null'
        brandName:
          minLength: 1
          readOnly: true
          type: string
        cartonQuantity:
          minimum

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