Cloudmersive Batch Job API

openapi: 3.2.0
info:
  version: v1
  title: barcodeapi Batch Job API
  description: Barcode APIs let you generate barcode images, and recognize values from images of barcodes.
servers:
- url: http://localhost
tags:
- name: BatchJob
paths:
  /barcode/batch-job/scan/image/advanced/qr:
    post:
      tags:
      - BatchJob
      summary: Advanced AI scan and recognition of an image of one or more QR barcodes as a…
      description: Creates an async batch job to scan an image or photo of a QR barcode and return the result. Uses AI deep learning to read blurry or low resultion QR barcodes. Supports PNG, PDF and JPEG input file formats. Use the GetAsyncJobStatus API to check on the status of this job using the returned AsyncJobID and get the result when it finishes. Requires Managed Instance or Private Cloud deployment.
      operationId: BatchJob_ScanImageAdvancedQRBatchJob
      parameters:
      - name: preprocessing
        in: header
        description: Optional, preprocessing mode, default is 'Auto'.  Possible values are None (no preprocessing of the image), SmoothEdges, SmoothEdgesPlus, and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended).  Set this to 'None' if you do not want to use automatic image unrotation and enhancement.  Set to SmoothEdges to smooth harsh edges in the input image to enhance recognition accuracy.  Set to SmoothEdgesPlus to smooth harsh edges to a higher degree.
        required: false
        schema:
          type: string
      - name: recognitionMode
        in: header
        description: Optional, recognitionMode mode, default is 'Advanced'.  Possible values are Advanced, and Advanced2 which provides the most advanced available barcode recognition.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BarcodeBatchJobResult'
            text/json:
              schema:
                $ref: '#/components/schemas/BarcodeBatchJobResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/BarcodeBatchJobResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/BarcodeBatchJobResult'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                imageFile:
                  type: string
                  description: Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
                  format: binary
              required:
              - imageFile
  /barcode/batch-job/status:
    get:
      tags:
      - BatchJob
      summary: Get the status and result of a Barcode Batch Job
      description: Returns the result of the Async Job - possible states can be STARTED or COMPLETED. This API is only available for Cloudmersive Managed Instance and Private Cloud deployments.
      operationId: BatchJob_GetAsyncJobStatus
      parameters:
      - name: AsyncJobID
        in: query
        description: Job ID for the batch job to get the status of
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BarcodeBatchJobStatusResult'
            text/json:
              schema:
                $ref: '#/components/schemas/BarcodeBatchJobStatusResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/BarcodeBatchJobStatusResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/BarcodeBatchJobStatusResult'
      security:
      - Apikey: []
components:
  schemas:
    BarcodeBatchJobStatusResult:
      description: Result of checking on the status of a barcode batch job
      type: object
      properties:
        Successful:
          description: True if the operation to check the status of the job was successful, false otherwise
          type: boolean
        AsyncJobStatus:
          description: Returns the job status of the Async Job, if applicable.  Possible states are STARTED and COMPLETED
          type: string
        AsyncJobID:
          description: Job ID
          type: string
        QRScanResult:
          $ref: '#/components/schemas/BarcodeScanQRAdvancedResult'
          description: Result of performing an Advanced QR barcode scan operation on the input image
        ErrorMessage:
          description: Error message (if any)
          type: string
    BarcodeBatchJobResult:
      description: Result of creating a barcode batch job
      type: object
      properties:
        Successful:
          description: True if successful, false otherwise
          type: boolean
        AsyncJobID:
          description: When creating a job, an Async Job ID is returned.  Use the GetAsyncJobStatus API to check on the status of this job using the AsyncJobID and get the result when it finishes
          type: string
    BarcodeScanQRAdvancedResult:
      description: Result of the advanced QR barcode scan
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        ResultBarcodes:
          description: Results of performing the QR barcode scan operation
          type: array
          items:
            $ref: '#/components/schemas/BarcodeQRResultItem'
        BarcodeCount:
          format: int32
          description: Number of barcodes read
          type: integer
        ErrorMessage:
          description: Error message if any
          type: string
    BarcodeQRResultItem:
      description: QR barcode instance
      type: object
      properties:
        RawText:
          description: The barcode text
          type: string
  securitySchemes:
    Apikey:
      type: apiKey
      description: API Key Authentication
      name: Apikey
      in: header
x-provenance:
  method: harvested
  publisher: Cloudmersive
  source: https://api.cloudmersive.com/barcode/docs/v1/swagger
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)