Inspectorio REPORT-V2 API

openapi: 3.2.0
info:
  title: RSC REPORT V2 API
  version: v1
servers:
- description: Production Environment
  url: https://rise-integration.inspectorio.com
- description: Pre-Production Environment
  url: https://rise-integration.pre.inspectorio.com
security:
- ApiKeyAuth: []
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:
      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:
    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
    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
    StepExecutionAnswerChoiceSubQuestionAnswer:
      properties:
        choices:
          description: List of choices for the question
          items:
            $ref: '#/components/schemas/StepExecutionAnswerChoiceSubQuestionAnswerChoice'
          type:
          - array
          - 'null'
        files:
          description: Files attached to the question
          items:
            type: object
          type:
          - array
          - 'null'
        id:
          description: Unique identifier of the question in the question/answer set
          type:
          - string
          - 'null'
        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'
          type:
          - array
          - 'null'
        number:
          description: Number of the question
          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
          type:
          - string
          - 'null'
      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
    V2ReportAuditor:
      properties:
        email:
          description: Actual auditor's email (This field has value only when the configuration is enabled in the standard)
          example: john.doe@abc.com
          type:
          - string
          - 'null'
        firstName:
          description: Actual Auditor's First Name (This field has value only when the configuration is enabled in the standard)
          example: John
          type:
          - string
          - 'null'
        lastName:
          description: Actual Auditor's Last Name (This field has value only when the configuration is enabled in the standard)
          example: Doe
          type:
          - string
          - 'null'
      type: object
    BasicStepExecutionInfo:
      properties:
        id:
          description: Step execution ID
          example: 4ea094ac-84de-4d50-80c3-fef2ef569f3c
          type: string
        name:
          description: Step name
          example: Questionnaire 1 - Mapping Issue List
          type: string
        order:
          description: Step order
          example: 0
          type: integer
        result:
          description: Step execution result
          allOf:
          - $ref: '#/components/schemas/StepExecutionResult'
          type:
          - object
          - 'null'
        questionnaire:
          description: Questionnaire information
          allOf:
          - $ref: '#/components/schemas/Questionnaire'
          type:
          - object
          - 'null'
        appTestResults:
          description: Application test results
          items:
            type: object
          type: array
      type: object
    V2ReportLabel:
      properties:
        name:
          description: Type of label assigned in the assignment/report/CAPA
          type: string
        value:
          description: Label assigned in the assignment/report/CAPA
          type: string
      type: object
    StepExecutionIssue:
      properties:
        category:
          description: Category of the issue in the step execution
          example: Electrical Safety
          type:
          - string
          - 'null'
        id:
          description: Unique identifier of the issue in the step execution
          example: 123abc
          type:
          - string
          - 'null'
        severity:
          description: Severity of the issue in the step execution
          example: Major
          type:
          - string
          - 'null'
        sovePrinciple:
          description: SOVE Principle
          example: Safety
          type:
          - string
          - 'null'
        text:
          description: Text describing the issue in the step execution
          example: Safety measures of electrical panels are not in place
          type:
          - string
          - 'null'
      type: object
    V2ReportDetail:
      allOf:
      - $ref: '#/components/schemas/V2ReportBasicDetail'
      - properties:
          checkin:
            description: On-site check-in information
            allOf:
            - $ref: '#/components/schemas/CheckIn'
            type:
            - object
            - 'null'
          overallComment:
            description: Overall comment input by the assignee
            example: Please submit the capa by due date.
            type:
            - string
            - 'null'
          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
          stepExecutions:
            description: Information of the execution steps
            items:
              $ref: '#/components/schemas/BasicStepExecutionInfo'
            type: array
          submitEvent:
            $ref: '#/components/schemas/V2ReportDetailSubmitEvent'
          declineReasons:
            description: Reasons input by the retailer when declining the report
            items:
              type: string
            type: array
          capa:
            allOf:
            - $ref: '#/components/schemas/Capa'
            description: Information of the CAPA, Corrective Action and Preventive Action
            type:
            - object
            - 'null'
      type: object
    OrgLocationAddress:
      properties:
        address:
          description: Address
          example: 123 Main Street
          type:
          - string
          - 'null'
        city:
          description: City
          example: Abbeville
          type:
          - string
          - 'null'
        province:
          description: Province
          example: Alabama
          type:
          - string
          - 'null'
        country:
          description: Country
          example: US
          type:
          - string
          - 'null'
      type: object
    NameValue:
      properties:
        name:
          description: Name
          type: string
        value:
          description: Value
          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
    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
    IdName:
      properties:
        id:
          description: Unique identifier
          type:
          - string
          - 'null'
        name:
          description: Name
          type:
          - string
          - 'null'
      type: object
    V2ReportListCapa:
      properties:
        id:
          description: Unique identifier of the CAPA
          example: 1235330e-b74b-4be6-8d8a-cb0560effc11
          type: string
        status:
          description: Status of the CAPA
          example: NEW
          type: string
        capaLabels:
          description: List of CAPA labels
          items:
            $ref: '#/components/schemas/NameValue'
          type: array
      type: object
    StepExecutionQuestionAnswerFindingsIssues:
      properties:
        attachments:
          description: Attachments inserted in the findings issue
          items:
            $ref: '#/components/schemas/StepExecutionQuestionAnswerFindingsAttachment'
          type:
          - array
          - 'null'
        content:
          description: Content of the findings issue
          type:
          - string
          - 'null'
        createdDate:
          description: Creation date of the findings issue
          example: '2022-03-02T06:41:19.633000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        findingsIssuesId:
          description: Unique identifier of the findings issue
          type:
          - string
          - 'null'
        organization:
          allOf:
          - $ref: '#/components/schemas/ReportDetailOrg'
          description: Organization of the findings issue
        severity:
          allOf:
          - $ref: '#/components/schemas/StepExecutionQuestionAnswerFindingsIssuesSeverity'
          description: Severity information
        summary:
          description: Summary of the findings issue
          type:
          - string
          - 'null'
        user:
          allOf:
          - $ref: '#/components/schemas/StepExecutionQuestionAnswerFindingsUser'
          description: User of the findings issue
      type: object
    V2ReportDetailSubmitEvent:
      description: Information on the event submission
      properties:
        submittedByUser:
          allOf:
          - $ref: '#/components/schemas/V2ReportDetailUser'
          type:
          - object
          - 'null'
          description: Information of the user who submitted the assessment
        submitDate:
          description: Submit date
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type: string
        submittedByOrg:
          allOf:
          - $ref: '#/components/schemas/IdNameTypeOrgId'
          description: Information of the organization who submitted the assessment
          type:
          - object
          - 'null'
      type: object
    Executor:
      allOf:
      - $ref: '#/components/schemas/IdNameTypeOrgId'
      - properties:
          contactPersons:
            description: Executor contact persons
            items:
              $ref: '#/components/schemas/ContactPerson'
            type: array
          isPlaceholder:
            description: Whether this is a placeholder executor
            example: false
            type: boolean
          ableToSubmitAssessment:
            description: Whether this executor can submit the assessment
            example: true
            type: boolean
          isLead:
            description: Whether this executor is the lead
            example: true
            type: boolean
          assignedRoles:
            description: Roles assigned to this executor
            items:
              $ref: '#/components/schemas/ExecutorAssignedRole'
            type: array
      type: object
    AreaToImproveField:
      properties:
        improvementAreaId:
          description: ID of the improvement area
          example: 07e1d9ef-aebe-4901-b26c-941cb5983832
          type: string
        fieldId:
          description: ID of the field
          example: b62ca36f-fa86-4ee0-ae96-bad52c2c46b2
          type: string
        field:
          description: Field definition
          properties:
            id:
              description: Field ID
              example: b62ca36f-fa86-4ee0-ae96-bad52c2c46b2
              type: string
            fieldName:
              description: Name of the field
              example: Root Causes
              type: string
            description:
              description: Field description
              example: Describe the root causes
              type: string
            enabled:
              description: Whether the field is enabled
              example: true
              type: boolean
            responseType:
              description: Type of response expected
              example: MULTIPLE_TEXT_ENTRIES
              type: string
            requirement:
              description: Field requirement level
              example: REQUIRED_WHEN_ATI_MANDATORY
              type: string
            systemKey:
              description: System key for the field
              example: ROOT_CAUSES
              type:
              - string
              - 'null'
            settings:
              description: Additional settings
              type:
              - object
              - 'null'
            order:
              description: Display order
              example: 0
              type: integer
            choices:
              description: Available choices for the field
              items:
                type: object
              type: array
            createdAt:
              description: Creation timestamp
              example: '2025-11-03T14:40:34.815Z'
              format: date-time
              type: string
            updatedAt:
              description: Last update timestamp
              example: '2025-11-03T14:40:34.815Z'
              format: date-time
              type: string
          type: object
        answer:
          description: Answer to the field
          properties:
            value:
     

# --- 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