Transload Qa Classification API

The Qa Classification API from Transload — 6 operation(s) for qa classification.

OpenAPI Specification

transload-qa-classification-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Pipeline Backend Admin Qa Classification API
  version: 0.1.0
security:
- bearerAuth: []
tags:
- name: Qa Classification
paths:
  /v1/qa-classification/pending:
    get:
      parameters:
      - schema:
          type: integer
          minimum: 1
          default: 50
        in: query
        name: limit
        required: false
      - schema:
          type: integer
          default: 0
        in: query
        name: offset
        required: false
      - schema:
          type: string
          format: uuid
        in: query
        name: siteId
        required: false
      - schema:
          type: string
          format: uuid
        in: query
        name: cameraId
        required: false
      - schema:
          type: number
          default: 0
        in: query
        name: minGap
        required: false
      - schema:
          type: integer
          default: 0
        in: query
        name: excludeOverlapSeconds
        required: false
      - schema:
          type: boolean
          default: false
        in: query
        name: hideNoScanner
        required: false
      - schema:
          type: array
          items:
            type: string
            format: uuid
          default: []
        in: query
        name: excludedCustomerIds
        required: false
      - schema:
          type: string
          enum:
          - oldest
          - newest
          default: oldest
        in: query
        name: sortOrder
        required: false
      - schema:
          type: string
          format: date-time
        in: query
        name: capturedAfter
        required: false
      - schema:
          type: string
          format: date-time
        in: query
        name: capturedBefore
        required: false
      responses:
        '200':
          description: Default Response
      tags:
      - Qa Classification
  /v1/qa-classification/summary:
    get:
      parameters:
      - schema:
          type: string
          format: uuid
        in: query
        name: siteId
        required: false
      - schema:
          type: string
          format: uuid
        in: query
        name: cameraId
        required: false
      - schema:
          type: number
          default: 0
        in: query
        name: minGap
        required: false
      - schema:
          type: integer
          default: 0
        in: query
        name: excludeOverlapSeconds
        required: false
      - schema:
          type: boolean
          default: false
        in: query
        name: hideNoScanner
        required: false
      - schema:
          type: string
          format: date-time
        in: query
        name: capturedAfter
        required: false
      - schema:
          type: string
          format: date-time
        in: query
        name: capturedBefore
        required: false
      responses:
        '200':
          description: Default Response
      tags:
      - Qa Classification
  /v1/qa-classification/{scanId}/review:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - type: object
                properties:
                  decision:
                    enum:
                    - accepted
                  kochScaleFactor:
                    type: object
                    properties:
                      objective:
                        type: string
                        enum:
                        - t30_mae
                        - per_dim_5cm_count
                    required:
                    - objective
                required:
                - decision
              - type: object
                properties:
                  decision:
                    enum:
                    - rejected
                  reason:
                    type: string
                    enum:
                    - ambiguous
                    - bad_segmentation
                    - item_not_measurable
                    - mixed_pallet
                    - no_scan_visible
                    - wrong_item_selected
                    - bad_bounding_box_fit
                    - bad_measurements
                    - other
                    - barcode_not_attached
                    - stacked_items
                  correction:
                    type: object
                    properties:
                      lengthCm:
                        type: integer
                      widthCm:
                        type: integer
                      heightCm:
                        type: integer
                      obbCornersPx:
                        type: array
                        items:
                          type: object
                          properties:
                            u:
                              type: number
                            v:
                              type: number
                          required:
                          - u
                          - v
                    required:
                    - lengthCm
                    - widthCm
                    - heightCm
                    - obbCornersPx
                required:
                - decision
      parameters:
      - schema:
          type: string
          format: uuid
        in: path
        name: scanId
        required: true
      responses:
        '200':
          description: Default Response
      tags:
      - Qa Classification
  /v1/qa-classification/{scanId}/review/reset:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                stageRunId:
                  type: string
                  format: uuid
              required:
              - stageRunId
      parameters:
      - schema:
          type: string
          format: uuid
        in: path
        name: scanId
        required: true
      responses:
        '200':
          description: Default Response
      tags:
      - Qa Classification
  /v1/qa-classification/reviews/reset:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                reviews:
                  type: array
                  items:
                    type: object
                    properties:
                      scanId:
                        type: string
                        format: uuid
                      stageRunId:
                        type: string
                        format: uuid
                    required:
                    - scanId
                    - stageRunId
              required:
              - reviews
      responses:
        '200':
          description: Default Response
      tags:
      - Qa Classification
  /v1/qa-classification/stats:
    get:
      parameters:
      - schema:
          type: string
          format: uuid
        in: query
        name: customerId
        required: false
      - schema:
          type: string
          format: date-time
        in: query
        name: from
        required: false
      - schema:
          type: string
          format: date-time
        in: query
        name: to
        required: false
      responses:
        '200':
          description: Default Response
      tags:
      - Qa Classification
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer