Inspectorio ASSESSMENT-V1 API

openapi: 3.2.0
info:
  title: File Management ANALYTICS ASSESSMENT V1 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: ASSESSMENT-V1
paths:
  /api/v1/assessments/search:
    post:
      operationId: searchAssessmentsV1
      description: Search Assessments V1 with filters and pagination
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1AssessmentSearchRequest'
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1AssessmentListResponse'
          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: Search assessments
      tags:
      - ASSESSMENT-V1
  /api/v1/assessments/{assessment_id}:
    get:
      description: Get Assessment V1 with detailed information
      operationId: getAssessmentV1
      parameters:
      - in: path
        name: assessment_id
        required: true
        schema:
          type: string
        description: Assessment execution ID (UUID)
      - in: query
        name: capa_details
        required: false
        schema:
          type: boolean
          default: false
        description: Get additional information about CAPA
      - in: query
        name: include_step_questions
        required: false
        schema:
          type: boolean
          default: false
        description: Get question and answers
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1AssessmentDetailResponse'
          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
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundApiError'
          description: Assessment not found
        '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 Assessment
      tags:
      - ASSESSMENT-V1
components:
  schemas:
    V1AssessmentAssignedUser:
      properties:
        id:
          description: User unique identifier
          example: 5d975074-392d-4850-9f9a-3bde0d756525
          type: string
        email:
          description: User email
          example: user@inspectorio.mailinator.com
          type: string
        firstName:
          description: User first name
          example: Forrest
          type:
          - string
          - 'null'
        lastName:
          description: User last name
          example: V
          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
    V1AssessmentSearchRequest:
      properties:
        case_id:
          description: Filter by case ID (numeric custom ID)
          example: 100000
          type: integer
        assessment_type:
          description: Type of the assessment
          enum:
          - Self Assessment
          - Verification Assessment
          example: Self Assessment
          type: string
        assessment_status:
          description: Filter by assessment status (single value or comma-separated string) - accepts New, In Progress, Completed, Submitted, Aborted, Assessment Canceled, Report Declined
          oneOf:
          - type: string
            enum:
            - New
            - In Progress
            - Completed
            - Submitted
            - Aborted
            - Assessment Canceled
            - Report Declined
          - type: string
            pattern: ^(New|In Progress|Completed|Submitted|Aborted|Assessment Canceled|Report Declined)(,(New|In Progress|Completed|Submitted|Aborted|Assessment Canceled|Report Declined))*$
          example: Submitted
        workflow:
          description: Filter by workflow name
          example: Draft
          type: string
        workflow_name:
          description: Filter by workflow name (alternative parameter name)
          example: Draft
          type: string
        standard_name:
          description: Filter by standard name (single value or comma-separated string)
          example: Environmental Audit - RS Std
          type: string
        standard_version:
          description: Filter by standard version (single value or comma-separated string)
          example: '6.1'
          type: string
        rating_labels:
          description: Filter by rating label names (single value or comma-separated string)
          example: Excellent
          type: string
        scheduling_status:
          description: Filter by scheduling status
          enum:
          - N/A
          - Waiting For Scheduling
          - Scheduling Confirmed
          - Scheduling Finished
          - Scheduling Late
          - Pending Scheduling Confirmation
          - Scheduling Declined
          example: Waiting For Scheduling
          type: string
        assessed_org_id:
          description: Filter by assessed organization external ID
          example: F123
          type: string
        requester_org_id:
          description: Filter by requester organization external ID (single value or comma-separated string)
          example: R123
          type: string
        executor_org_id:
          description: Filter by executor organization external ID (single value or comma-separated string)
          example: E123
          type: string
        selected_partner_org_id:
          description: Filter by selected partner organization (UUID, external ID, or organization name - single value or comma-separated). Supports 'null' to filter assessments with no selected partners.
          example: 123e4567-e89b-12d3-a456-426614174000,partner123,Factory Org Name
          type: string
        country:
          description: Filter by country/region code (single value or comma-separated - US, CN, VN, etc.)
          example: US,CN,VN
          type: string
        reason:
          description: Filter by reason name (single value or comma-separated)
          example: Regular Audit,Special Audit
          type: string
        capa_status:
          description: Status of the CAPA
          enum:
          - New
          - In-Progress
          - Assessment Requested
          - Submitted
          - In Review
          - Declined
          - Closed
          - Assessment Canceled
          - Reopened
          - Approved
          example: New
          type: string
        capa_due_date_from:
          description: Earliest date of the CAPA due date range
          example: '2020-01-01'
          format: date
          type: string
        capa_due_date_to:
          description: Latest date of the CAPA due date range
          example: '2020-01-02'
          format: date
          type: string
        due_date_from:
          description: Earliest date of the due date range
          example: '2020-01-01'
          format: date
          type: string
        due_date_to:
          description: Latest date of the due date range
          example: '2020-01-02'
          format: date
          type: string
        assessment_due_date_from:
          description: Earliest date of the assessment due date range (alternative to due_date_from)
          example: '2020-01-01'
          format: date
          type: string
        assessment_due_date_to:
          description: Latest date of the assessment due date range (alternative to due_date_to)
          example: '2020-01-02'
          format: date
          type: string
        audit_date_from:
          description: Earliest date of the audit date range (filters assessments with audit dates from this date onwards)
          example: '2020-01-01'
          format: date
          type: string
        audit_date_to:
          description: Latest date of the audit date range (filters assessments with audit dates up to this date)
          example: '2020-01-02'
          format: date
          type: string
        audit_start_date_from:
          description: Earliest date of the audit start date range - filters assessments by their audit start date
          example: '2020-01-01'
          format: date
          type: string
        audit_start_date_to:
          description: Latest date of the audit start date range - filters assessments by their audit start date
          example: '2020-01-02'
          format: date
          type: string
        audit_end_date_from:
          description: Earliest date of the audit end date range - filters assessments by their audit end date
          example: '2020-01-01'
          format: date
          type: string
        audit_end_date_to:
          description: Latest date of the audit end date range - filters assessments by their audit end date
          example: '2020-01-02'
          format: date
          type: string
        assessment_submit_date_from:
          description: Earliest date of the assessment submission date range
          example: '2020-01-01'
          format: date
          type: string
        assessment_submit_date_to:
          description: Latest date of the assessment submission date range
          example: '2020-01-02'
          format: date
          type: string
        updated_date_from:
          description: From the date assessments are updated
          example: '2020-01-01'
          format: date
          type: string
        updated_date_to:
          description: To the date assessments are updated
          example: '2020-01-02'
          format: date
          type: string
        updated_datetime_from:
          description: From the datetime assessments are updated (ISO 8601 format with Zulu timezone)
          example: '2020-01-01T12:34:56Z'
          format: date-time
          type: string
        updated_datetime_to:
          description: To the datetime assessments are updated (ISO 8601 format with Zulu timezone)
          example: '2020-01-01T12:34:56Z'
          format: date-time
          type: string
        order:
          description: Order used to sort the assessments whether ascending or descending. Allowed fields - updated_date, created_date, due_date, status, assessment_type, assessmentId, assessmentSubmitDate, assessmentDueDate, auditStartDate, auditEndDate, updatedDate, rating, score. Format - {field}:asc or {field}:desc
          default: updated_date:desc
          example: assessmentId:asc
          pattern: ^(updated_date|created_date|due_date|status|assessment_type|assessmentId|assessmentSubmitDate|assessmentDueDate|auditStartDate|auditEndDate|updatedDate|rating|score)(:(asc|desc))?$
          type: string
        search:
          description: Search term for filtering assessments
          example: factory
          type: string
        limit:
          description: Limit result of list
          default: 20
          maximum: 1000
          minimum: 1
          type: integer
        offset:
          description: Offset for pagination
          default: 0
          minimum: 0
          type: integer
      type: object
    ExecutorAssignedRole:
      properties:
        name:
          description: Assigned role name
          example: Lead Auditor
          type: string
      type: object
    V1AssessmentDetail:
      allOf:
      - $ref: '#/components/schemas/V1AssessmentListItem'
      - properties:
          stakeholders:
            description: Stakeholders information (detail view with full data)
            allOf:
            - $ref: '#/components/schemas/V1AssessmentStakeholders'
          capa:
            description: Information of the CAPA, Corrective Action and Preventive Action (full details when capa_details=true)
            type:
            - object
            - 'null'
            allOf:
            - $ref: '#/components/schemas/Capa'
          overallComment:
            description: Overall comment content
            example: Input Manually\nasds\nasd\n
            type:
            - string
            - 'null'
          description:
            description: Assessment description
            example: Annual audit for supplier compliance
            type:
            - string
            - 'null'
          auditors:
            description: Auditors of the Assessment
            items:
              $ref: '#/components/schemas/V1AssessmentAuditor'
            type: array
          assignedUsers:
            description: Information of the assigned users
            items:
              $ref: '#/components/schemas/V1AssessmentAssignedUser'
            type: array
          assignedRoles:
            description: Information of the assigned roles
            items:
              $ref: '#/components/schemas/V1AssessmentAssignedRole'
            type: array
          auditTimeSpent:
            description: The time spent by Auditor in hours (This field has value only when the configuration is enabled in the standard)
            example: 12.5
            type:
            - number
            - 'null'
          assessmentRequestDate:
            description: Request date of the assessment
            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'
          reportGenerateDate:
            description: The date the report was generated
            example: '2024-09-30T10:36:56.057000+00:00'
            format: date-time
            type:
            - string
            - 'null'
          executionLocations:
            description: Execution Location (optional - depending on the configuration in each standard)
            example:
            - On-site
            - Desktop Review
            items:
              type: string
            type:
            - array
            - 'null'
          schedulingComment:
            description: Comment about scheduling
            example: Scheduled for next week
            type:
            - string
            - 'null'
          scheduledToOrganization:
            description: Organization to which assessment is scheduled
            allOf:
            - $ref: '#/components/schemas/IdNameTypeOrgId'
            type:
            - object
            - 'null'
          scheduledToOrganizationRole:
            description: Role of the scheduled organization
            example: Lead Auditor
            type:
            - string
            - 'null'
          checkin:
            description: On-site check-in information
            allOf:
            - $ref: '#/components/schemas/CheckIn'
            type:
            - object
            - 'null'
          escalations:
            description: List of escalations of the assessment
            items:
              $ref: '#/components/schemas/V2ReportEscalation'
            type: array
          announcementType:
            description: Announcement type
            example: Announced
            enum:
            - Announced
            - Semi-Announced
            - Private
            - Unannounced
            type:
            - string
            - 'null'
          stepExecutions:
            description: List of step executions in the assessment
            items:
              $ref: '#/components/schemas/V1AssessmentStepExecution'
            type: array
          submitEvent:
            description: Information about assessment submission
            allOf:
            - $ref: '#/components/schemas/V1AssessmentSubmitEvent'
            type:
            - object
            - 'null'
          reportLabels:
            description: Labels of the report/assessment
            items:
              type: object
            type: array
          confidentialNotes:
            description: Confidential notes
            items:
              $ref: '#/components/schemas/V1AssessmentConfidentialNote'
            type: array
          schemes:
            description: Related schemes information
            items:
              $ref: '#/components/schemas/V1AssessmentScheme'
            type: array
      type: object
    NotFoundApiError:
      properties:
        errorCode:
          example: Generic
          type: string
        message:
          example: Not Found
          type: string
      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
    V1AssessmentScheme:
      properties:
        schema:
          description: Scheme name
          example: ISO 9001
          type:
          - string
          - 'null'
        orgId:
          description: Organization external ID
          example: ORG_123
          type:
          - string
          - 'null'
        reportId:
          description: Related report ID
          example: 5c40e755-3ab0-4fa9-9a44-f76a95f0e87d
          type:
          - string
          - 'null'
        auditDate:
          description: Audit date for this scheme
          example: '2024-09-30'
          format: date
          type:
          - string
          - 'null'
      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
    V1AssessmentStakeholders:
      properties:
        assessedOrg:
          description: The organization being assessed
          allOf:
          - $ref: '#/components/schemas/IdNameTypeOrgId'
          - properties:
              address:
                description: Street address of the assessed organization
                example: 59 Xa lo Ha Noi
                type:
                - string
                - 'null'
              city:
                description: City of the assessed organization
                example: Ho Chi Minh City
                type:
                - string
                - 'null'
              postal:
                description: Postal code of the assessed organization
                example: '70000'
                type:
                - string
                - 'null'
              country:
                description: Country code of the assessed organization
                example: VN
                type:
                - string
                - 'null'
              province:
                description: Province/state of the assessed organization
                example: Ho Chi Minh
                type:
                - string
                - 'null'
              contactPersons:
                description: Assessed organization contact persons
                items:
                  $ref: '#/components/schemas/ContactPerson'
                type: array
              siteStatus:
                description: Site status of the assessed organization
                example: Active
                type:
                - string
                - 'null'
        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
        executors:
          description: The organizations who execute the assessment
          items:
            allOf:
            - $ref: '#/components/schemas/Executor'
          type: array
        selectedPartners:
          description: The partners associated with the assessed organization
          items:
            allOf:
            - $ref: '#/components/schemas/IdNameTypeOrgId'
            - properties:
                contactPersons:
                  description: Partner contact persons
                  items:
                    $ref: '#/components/schemas/ContactPerson'
                  type: array
          type: array
      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
    V1AssessmentSubmitEvent:
      properties:
        submittedByUser:
          description: User who submitted the assessment
          allOf:
          - $ref: '#/components/schemas/V1AssessmentSubmittedByUser'
          type:
          - object
          - 'null'
        submitDate:
          description: Submission date
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type: string
        submittedByOrg:
          description: Organization that submitted
          allOf:
          - $ref: '#/components/schemas/IdNameTypeOrgId'
          type:
          - object
          - 'null'
      type: object
    V1AssessmentListItem:
      properties:
        id:
          description: Unique assessment execution ID
          example: 5c40e755-3ab0-4fa9-9a44-f76a95f0e87d
          type: string
        assessmentId:
          description: Assessment ID (displays in UI)
          example: 100000-2
          type: string
        caseId:
          description: Case ID (displays in UI)
          example: 100000
          type: string
        reportId:
          description: Associated report ID (if report exists)
          example: 5c40e755-3ab0-4fa9-9a44-f76a95f0e87d
          type:
          - string
          - 'null'
        status:
          description: Assessment Status (New, Aborted, Submitted ...)
          example: Submitted
          type: string
        type:
          description: Assessment type
          example: Verification Assessment
          enum:
          - Verification Assessment
          - Self Assessment
          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
          example: Factory Information
          type: string
        standard:
          description: The Standard used for the Assessment
          allOf:
          - $ref: '#/components/schemas/NameVersion'
        rating:
          description: Rating of the assessment. 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 Assessment. 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 Assessment 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'
        totalFindings:
          description: List of findings. Only contains value if the assessment is issue-based.
          items:
            $ref: '#/components/schemas/V1AssessmentFinding'
          type: array
        numberOfAreaToImproves:
          description: The total count of area to improves after the assessment is completed.
          example: 12
          type: integer
        assessmentDueDate:
          description: Due date of the assessment
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        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'
        auditStartDate:
          description: Actual Audit Start date (This field has value only when the configuration is enabled in the standard)
          example: '2024-09-30T00:00:00.000000+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-30T00:00:00.000000+00:00'
          format: date-time
          type:
          - string
          - 'null'
        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'
        assessmentStartDate:
          description: The start date of the Assessment
          example: '2024-09-30T10:36:56.057000+00:00'
          format: date-time
          type:
          - str

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