Inspectorio REPORT-V2 API

openapi: 3.2.0
info:
  title: File Management ANALYTICS REPORT V2 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-V2
paths:
  /api/v2/reports:
    get:
      operationId: listReportsV2
      description: List Reports V2 with additional data about report and CAPA
      parameters:
      - description: Type of the assessment between "Self Assessment" or "Verification Assessment"
        in: query
        name: assessment_type
        required: false
        schema:
          enum:
          - Self Assessment
          - Verification Assessment
          example: Self Assessment
          type: string
      - description: Status of the reports
        in: query
        name: report_status
        required: false
        schema:
          enum:
          - New
          - Verification Requested
          - Declined
          - Case Completed
          - Assessment Canceled
          example: New
          type: string
      - description: Requestee ID
        in: query
        name: requestee_id
        required: false
        schema:
          example: F_123
          type: string
      - description: Status of the CAPA
        in: query
        name: capa_status
        required: false
        schema:
          enum:
          - New
          - In-Progress
          - Assessment Requested
          - Submitted
          - In Review
          - Declined
          - Closed
          - Assessment Canceled
          - Reopened
          - Approved
          example: New
          type: string
      - description: Earliest date of the report date range
        in: query
        name: report_generate_date_from
        required: false
        schema:
          example: '2020-01-01'
          format: date
          type: string
      - description: From the date reports are updated
        in: query
        name: updated_date_from
        required: false
        schema:
          example: '2020-01-01'
          format: date
          type: string
      - description: Limit result of list
        in: query
        name: limit
        required: false
        schema:
          default: 10
          maximum: 100
          minimum: 1
          type: integer
      - description: To the date reports are updated
        in: query
        name: updated_date_to
        required: false
        schema:
          example: '2020-01-02'
          format: date
          type: string
      - description: Latest date of the report date range
        in: query
        name: report_generate_date_to
        required: false
        schema:
          example: '2020-01-02'
          format: date
          type: string
      - description: Order used to sort the reports whether ascending or descending
        in: query
        name: order
        required: false
        schema:
          default: report_generate_date:desc
          example: report_generate_date:desc
          type: string
      - in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ReportListResponse'
          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: List reports
      tags:
      - REPORT-V2
  /api/v2/reports/{report_id}:
    get:
      description: Get Report V2 with additional data about report and CAPA
      operationId: getReportV2
      parameters:
      - in: path
        name: report_id
        required: true
        schema:
          type: string
      - in: query
        name: capa_details
        required: false
        schema:
          type: boolean
        description: Get additional information about CAPA
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ReportDetailResponse'
          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 Report
      tags:
      - REPORT-V2
  /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-V2
components:
  schemas:
    ReportDetailAssessmentExecutionConfidentialNote:
      properties:
        content:
          description: Note content
          example: Confidential information about assessment
          type: string
        createdBy:
          description: User who created the note
          example: Jane Auditor
          type:
          - string
          - 'null'
        createdDate:
          description: Creation date
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          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
    ReportDetailUser:
      description: Information of the user
      properties:
        email:
          description: Email address of the user
          example: john@acme.com
          type:
          - string
          - 'null'
        firstName:
          description: First name of the user
          example: John
          type:
          - string
          - 'null'
        id:
          description: Unique identifier of the user
          example: cc94fc4e-dcbe-44a5-863e-3255281e02ca
          type:
          - string
          - 'null'
        lastName:
          description: Last name of the user
          example: Doe
          type:
          - string
          - 'null'
      type: object
    StepExecutionQuestionnaire:
      properties:
        description:
          description: Description of the questionnaire
          type:
          - string
          - 'null'
        flattenSections:
          description: Sections of the questionnaire
          items:
            $ref: '#/components/schemas/StepExecutionFlattenSection'
          type:
          - array
          - 'null'
        id:
          description: Unique identifier of the questionnaire
          type:
          - string
          - 'null'
        name:
          description: Name of the questionnaire
          type:
          - string
          - 'null'
      type: object
    CustomLabel:
      properties:
        name:
          description: Name of the label
          type: string
        value:
          description: Value of the label
          type: string
      type: object
    StepExecutionResult:
      properties:
        numberOfAreaToImproves:
          description: Number of areas to improve
          example: 3
          type: integer
        score:
          description: Step score
          example: 7/10
          type:
          - string
          - 'null'
        rating:
          description: Step rating
          example: Good
          type:
          - string
          - 'null'
        scoreInPercentage:
          description: Score in percentage
          example: 70%
          type:
          - string
          - 'null'
        createdAt:
          description: Creation timestamp
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        sections:
          description: Sections data
          items:
            type: object
          type: array
      type: object
    ExecutorAssignedRole:
      properties:
        name:
          description: Assigned role name
          example: Lead Auditor
          type: string
      type: object
    V2ReportDetailResponse:
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/V2ReportDetail'
          description: Report data
      type: object
    V2ReportEscalation:
      properties:
        createdDate:
          description: Date when the Escalation was created
          format: date-time
          example: '2024-09-30T10:36:56.057000+00:00'
          type: string
        status:
          description: Status of the escalation
          type: string
        resolvedDate:
          description: Resolution date of the escalation
          format: date-time
          example: '2024-09-30T10:36:56.057000+00:00'
          type:
          - string
          - 'null'
        escalatedTo:
          description: The user who received the escalation
          items:
            $ref: '#/components/schemas/V2ReportDetailUser'
          type: array
        escalatedBy:
          $ref: '#/components/schemas/V2ReportDetailUser'
        resolvedByUser:
          $ref: '#/components/schemas/V2ReportDetailUser'
        note:
          description: Escalation note
          type: string
        reasons:
          description: Escalation reason
          items:
            type: string
          type: array
        exceptionReasons:
          description: Escalation exception reason
          items:
            type: string
          type: array
        reviewerComment:
          description: Reviewer comment
          type:
          - string
          - 'null'
      type: object
    V2ReportListItem:
      properties:
        id:
          description: Unique report ID
          example: 5c40e755-3ab0-4fa9-9a44-f76a95f0e87d
          type: string
        caseId:
          description: Case ID (displays in UI)
          example: 100000
          type: string
        assessmentId:
          description: Assessment ID (displays in UI)
          example: 100000-2
          type: string
        status:
          description: Report Status (New, Assessment Cancelled, ...)
          example: New
          type: string
        reason:
          description: Assessment Reasons (optional - depending on the configuration in each standard)
          example: Annual Audit
          type:
          - string
          - 'null'
        workflowName:
          description: Selected Workflow for the assessment report
          example: Factory Information
          type: string
        executionLocations:
          description: Execution Location (optional - depending on the configuration in each standard)
          example: '[Desktop Review]'
          items:
            type: string
          type: array
        updatedDate:
          description: System updated date. This field will be updated based on the changes in the Report and CAPA.
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type: string
        type:
          description: Assessment type
          example: Verification Assessment
          enum:
          - Verification Assessment
          - Self Assessment
          type: string
        announcementType:
          description: Announcement type
          example: Announced
          enum:
          - Announced
          - Semi-Announced
          - Private
          - Unannounced
          type: string
        assessmentStatus:
          description: Assessment Status (New, Aborted, Submitted ...)
          example: Aborted
          type: string
        assessmentWindowStart:
          description: Start date of the Assessment Window
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        assessmentWindowEnd:
          description: End date of the Assessment Window
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        assessmentDueDate:
          description: Due date of the assessment
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        assessmentRequestDate:
          description: Request date of the assessment
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type: string
        assessmentSubmitDate:
          description: Assessment Submitted date. This is also Report Generated date.
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        auditStartDate:
          description: Actual Audit Start date (This field has value only when the configuration is enabled in the standard)
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        auditEndDate:
          description: Actual Audit End date (This field has value only when the configuration is enabled in the standard)
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        auditTimeSpent:
          description: The time spent by Auditor (This field has value only when the configuration is enabled in the standard)
          example: 12
          type:
          - integer
          - 'null'
        auditors:
          description: Auditors of the Assessment
          items:
            $ref: '#/components/schemas/V2ReportAuditor'
          type: array
        assignedUsers:
          description: Information of the assigned user
          items:
            $ref: '#/components/schemas/V2ReportDetailUser'
          type: array
        assignedRoles:
          description: Information of the assigned roles
          items:
            $ref: '#/components/schemas/V2ReportAssignedRole'
          type: array
        assessmentStartDate:
          description: The start date of the Assessment
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        completeCaseDate:
          description: The date the case was completed
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        reopenCaseDate:
          description: The date the case was reopen
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        reportGenerateDate:
          description: The date the report was generated
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type: string
        caseExpirationDate:
          description: Expiration date of the Case
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        customFields:
          description: Client's specific attributes
          type:
          - object
          - 'null'
        standard:
          description: The Standard used for the Report
          allOf:
          - $ref: '#/components/schemas/NameVersion'
        stakeholders:
          description: Stakeholders information
          properties:
            requester:
              description: The organization who requested the assessment
              allOf:
              - $ref: '#/components/schemas/IdNameTypeOrgId'
              - properties:
                  contactPersons:
                    description: Requester contact persons
                    items:
                      $ref: '#/components/schemas/ContactPerson'
                    type: array
              type: object
            executors:
              description: The organization who executed the assessment
              items:
                allOf:
                - $ref: '#/components/schemas/Executor'
              type: array
            requestee:
              description: The organization who is the target of the assessment
              allOf:
              - $ref: '#/components/schemas/IdNameTypeOrgId'
              - $ref: '#/components/schemas/OrgLocationAddress'
              - properties:
                  contactPersons:
                    description: Requester contact persons
                    items:
                      $ref: '#/components/schemas/ContactPerson'
                    type: array
              type: object
            selectedPartners:
              description: The supplier who assciated with the requestee (only contains value if the standard setting - Assessment setting select "Requestee and partners")
              items:
                allOf:
                - $ref: '#/components/schemas/IdNameTypeOrgId'
                - properties:
                    contactPersons:
                      description: Partner contact persons
                      items:
                        $ref: '#/components/schemas/ContactPerson'
                      type: array
                    address:
                      description: Address
                      example: 123 Main Street
                      type:
                      - string
                      - 'null'
                    country:
                      description: Country
                      example: US
                      type:
                      - string
                      - 'null'
              type: array
          type: object
        totalFindings:
          description: List of findings. Only contains value if the report is issue-based.
          items:
            $ref: '#/components/schemas/V2ReportDetailFindings'
          type: array
        rating:
          description: Rating of the report. Calculated based on the rule setting of the standard and the score/issues found in the assessment.
          example: Good
          type:
          - string
          - 'null'
        score:
          description: Score of the Report. Calculated based on the number of issue found or the selected answers in the assessment.
          example: 8/10
          type:
          - string
          - 'null'
        scoreInPercentage:
          description: Score of the Report in percentage. Calculated based on the number of issue found or the selected answers in the assessment compare to the maximum score.
          example: 80%
          type:
          - string
          - 'null'
        numberOfAreaToImproves:
          description: The total count of area to improves after the assessment is completed.
          example: 12
          type: integer
        reportLabels:
          description: Labels of the report
          items:
            $ref: '#/components/schemas/V2ReportLabel'
          type: array
        escalations:
          description: List of escalations of the assessment
          items:
            $ref: '#/components/schemas/V2ReportEscalation'
          type: array
        capa:
          allOf:
          - $ref: '#/components/schemas/V2ReportListCapa'
          description: Information of the CAPA, Corrective Action and Preventive Action
          type:
          - object
          - 'null'
      type: object
    V2ReportListResponse:
      properties:
        data:
          description: Report data
          items:
            $ref: '#/components/schemas/V2ReportListItem'
          type: array
        limit:
          default: 10
          description: Limit result of list
          maximum: 100
          minimum: 1
          type: integer
        offset:
          default: 0
          description: Number of items are skipped
          minimum: 0
          type: integer
        total:
          type: integer
      required:
      - total
      type: object
    StepExecutionQuestionAnswerFindingsIssuesSeverity:
      properties:
        color:
          description: Color of the severity
          type:
          - string
          - 'null'
        id:
          description: Unique identifier of the severity
          type:
          - string
          - 'null'
        name:
          description: Name of the severity
          type:
          - string
          - 'null'
      type: object
    StepExecutionOption:
      properties:
        actions:
          description: List of actions
          items:
            $ref: '#/components/schemas/StepExecutionOptionAction'
          type:
          - array
          - 'null'
        content:
          description: Content of the option
          type:
          - string
          - 'null'
        id:
          description: Unique identifier of the option
          type:
          - string
          - 'null'
        isNoneOfTheAbove:
          description: Is 'true' if 'None of the above' has been selected, 'false' otherwise
          type: boolean
      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
    DetailedAreaToImprove:
      properties:
        id:
          description: Unique identifier of the area to improve
          example: RI0DCKDYR0
          type: string
        updatedDate:
          description: Last update date
          example: '2025-10-21T15:30:56.214000+00:00'
          format: date-time
          type: string
        title:
          description: Title of the area to improve
          example: The general condition of the dormitories need improvement.
          type: string
        category:
          description: Category of the area to improve
          example: Drinking Water
          type:
          - string
          - 'null'
        subCategory:
          description: Sub-category of the area to improve
          example: Social
          type:
          - string
          - 'null'
        description:
          description: Detailed description
          example: The facility needs better ventilation
          type:
          - string
          - 'null'
        requiredCorrection:
          description: Whether correction is required
          example: false
          type: boolean
        recommendation:
          description: Recommendation for improvement
          example: Install new equipment
          type:
          - string
          - 'null'
        status:
          description: Status of the area to improve
          example: new
          type: string
        rootCauses:
          description: List of root causes
          items:
            type: string
          type: array
        resolutions:
          description: List of resolutions
          items:
            type: string
          type: array
        personInCharge:
          description: Person responsible for the improvement
          example: John Doe
          type:
          - string
          - 'null'
        completionDate:
          description: Target completion date
          example: '2025-12-15T10:36:56.057000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        resolvedDate:
          description: Date when the issue was resolved
          example: '2025-12-15T10:36:56.057000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        referenceId:
          description: Reference identifier
          example: tutest-issue-4-2
          type:
          - string
          - 'null'
        linkedFindings:
          description: List of linked findings
          items:
            $ref: '#/components/schemas/AtiLinkedFinding'
          type: array
        customFields:
          description: Custom fields data
          type:
          - object
          - 'null'
        comments:
          description: List of comments
          items:
            $ref: '#/components/schemas/AtiComment'
          type: array
        uploadedFiles:
          description: List of uploaded files
          items:
            type: object
          type: array
        areaToImproveLabels:
          description: Labels associated with this area to improve
          items:
            $ref: '#/components/schemas/CustomLabel'
          type: array
        fields:
          description: Custom fields with questions and answers
          items:
            $ref: '#/components/schemas/AreaToImproveField'
          type: array
      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
    V2ReportDetailFindings:
      properties:
        severity:
          description: Severity of the issue founded in the report
          example: Major
          enum:
          - Critical
          - Major
          - Minor
          type: string
        findings:
          description: Number of findings of the same severity in the report
          example: 2
          type: integer
      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
          type:
          - string
          - 'null'
        name:
          description: Name of the report step
          example: Factory Information
          type:
          - string
          - 'null'
      type: object
    IdName:
      properties:
        id:
          description: Unique identifier
          type:
          - string
          - 'null'
        name:
          description: Name
          type:
          - string
          - 'null'
      type: object
    Questionnaire:
      properties:
        id:
          description: Questionnaire ID
          example: cb66f153-712f-4582-848d-1811901ef37d
          type: string
        name:
          description: Questionnaire name
          example: '[tutest] Mapping Issue List - Schemes'
          type: string
      type: object
    StepExecutionQuestion:
      properties:
        content:
          description: Content of the question
          type:
          - string
          - 'null'
        externalId:
          description: External unique identifier of the question
          type:
          - string
          - 'null'
        extraInformation:
          description: Extra information of the question
          type: object
        id:
          description: Unique identifier of the question
          type:
          - string
          - 'null'
        options:
          description: List of options available for the question
          items:
            $ref: '#/components/schemas/StepExecutionOption'
          type:
          - array
          - 'null'
        parentId:
          description: Unique identifier of the parent of the question
          type:
          - string
          - 'null'
        responseType:
          description: Type of response
          type:
          - string
          - 'null'
        responseTypeConfig:
          description: Configuration of the type of response
          type: object
        type:
          description: Type of question
          type:
          - string
          - 'null'
        order:
          description: Order of the question
          example: 0
          type:
          - integer
          - 'null'
      type: object
    BadRequestApiError:
      properties:
        errorCode:
          example: Generic
          type: string
        message:
          example: Bad Request
          type: string
      type: object
    ContactPerson:
      properties:
        name:
          description: Contact person name
          example: John Doe
          type: string
        title:
          description: Contact person title
          example: Factory Manager
          type:
          - string
          - 'null'
        email:
          description: Contact person email
          example: john.doe@example.com
          type: string
        phoneNumber:
          description: Contact person phone number
          example: 1234567890
          type: string
      type: object
    AtiLinkedFinding:
      properties:
        scheme:
          description: Scheme
          type:
          - string
          - 'null'
        severity:
          description: Severity value
          example: Informational
          type:
          - string
          - 'null'
        title:
          description: Title
          example: Testing finding description
          type:
          - string
          - 'null'
        category:
          description: Category
          example: Section 1
          type:
          - string
          - 'null'
        subCategory:
          description: Sub-category
          example: Section 1.1
          type:
          - string
          - 'null'
        issueNumber:
          description: Issue number
          example: 376882
          type:
          - string
          - 'null'
        description:
          description: Issue description
          example: This is a detailed description of the issue.
          type:
          - string
          - 'null'
        schemeData:
          description: Scheme data
    

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