Chemaxon Db Work queue handler controller API

openapi: 3.2.0
info:
  title: Chemaxon Db Work queue handler controller API
  version: 26.1.3
  description: 'Operations tagged Db Work queue handler controller across 2 of this provider''s published API definitions: chemaxon-task-manager-openapi.json, chemaxon-task-manager-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://jchem-microservices.chemaxon.com/jws-taskmanager
tags:
- description: Use this controller to handle async and background tasks
  name: Db Work queue handler controller
paths:
  /rest-v1/work-queue/db/task:
    put:
      operationId: createTask_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DbTaskCreationRequest'
        required: true
      responses:
        '201':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DbTaskDescriptor'
          description: Created
      summary: Creates a new db task / background process to the work queue
      tags:
      - Db Work queue handler controller
    servers:
    - url: https://jchem-microservices.chemaxon.com/jws-taskmanager
  /rest-v1/work-queue/db/task/{taskId}:
    delete:
      operationId: deleteTask_1
      parameters:
      - description: id of the task to delete
        example: 3
        in: path
        name: taskId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
      summary: Deletes the specified task
      tags:
      - Db Work queue handler controller
    get:
      operationId: monitorState_1
      parameters:
      - description: id of the task to monitor its state
        example: 3
        in: path
        name: taskId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitorResponse'
          description: OK
      summary: Gets the state of the specified task / background process
      tags:
      - Db Work queue handler controller
    put:
      operationId: addStructures_1
      parameters:
      - description: id of the task to add structures
        example: 3
        in: path
        name: taskId
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DbAddStructuresRequest'
        required: true
      responses:
        '201':
          content:
            '*/*':
              schema:
                type: array
                items:
                  type: string
          description: Created
      summary: Adds structures to specified task / background process
      tags:
      - Db Work queue handler controller
    servers:
    - url: https://jchem-microservices.chemaxon.com/jws-taskmanager
  /rest-v1/work-queue/db/task/{taskId}/copy:
    put:
      description: Request body is optional. Fill in only if you want to change some aspects of the copied task!
      operationId: copyTask_1
      parameters:
      - description: id of the task to copy
        example: 3
        in: path
        name: taskId
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DbTaskCreationRequest'
      responses:
        '201':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DbTaskDescriptor'
          description: Created
      summary: Copies an already existing task / background process to the work queue
      tags:
      - Db Work queue handler controller
    servers:
    - url: https://jchem-microservices.chemaxon.com/jws-taskmanager
  /rest-v1/work-queue/db/task/{taskId}/import-file/{fileName}:
    post:
      description: 'The file can be a reference to the .json, or a .zip archive, where first item is the .json.

        Default import directory is ./data/export, that can be modified by setting the value of

        chemaxon.microservices.db.import-export.dir property.'
      operationId: importFromFile_1
      parameters:
      - description: id of the task to upload the structures
        example: 3
        in: path
        name: taskId
        required: true
        schema:
          type: integer
          format: int64
      - description: File name
        example: exported.json
        in: path
        name: fileName
        required: true
        schema:
          type: string
      responses:
        '201':
          content:
            '*/*':
              schema:
                type: array
                items:
                  type: string
          description: Created
      summary: Imports all structures from the file and adds them to the given task ID
      tags:
      - Db Work queue handler controller
    servers:
    - url: https://jchem-microservices.chemaxon.com/jws-taskmanager
  /rest-v1/work-queue/db/task/{taskId}/manage:
    post:
      operationId: manageTask_1
      parameters:
      - description: id of the task to upload the structures
        example: 3
        in: path
        name: taskId
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManageRequest'
        required: true
      responses:
        '200':
          description: OK
      summary: Manages the specified task
      tags:
      - Db Work queue handler controller
    servers:
    - url: https://jchem-microservices.chemaxon.com/jws-taskmanager
  /rest-v1/work-queue/db/task/{taskId}/results:
    get:
      operationId: getResults
      parameters:
      - description: id of the task to which the results belongs to
        example: 3
        in: path
        name: taskId
        required: true
        schema:
          type: integer
          format: int64
      - description: requested result type in the response. ERROR include fails and duplicates only
        in: query
        name: resultIdType
        required: true
        schema:
          type: string
          default: ERROR
          enum:
          - ALL
          - ERROR
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DbResultResponse'
          description: OK
      summary: Gets all of the results of the specified task / background process
      tags:
      - Db Work queue handler controller
    servers:
    - url: https://jchem-microservices.chemaxon.com/jws-taskmanager
  /rest-v1/work-queue/db/task/{taskId}/structure/{structureKey}:
    delete:
      operationId: deleteStructure_1
      parameters:
      - description: id of the task to which the structure belongs
        example: 3
        in: path
        name: taskId
        required: true
        schema:
          type: integer
          format: int64
      - description: Task-Manager-specific unique key of the structure
        example: s5
        in: path
        name: structureKey
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Accepted
      summary: Deletes the specified structure of the specified task / background process
      tags:
      - Db Work queue handler controller
    get:
      operationId: getStructure_1
      parameters:
      - description: id of the task to which the structure belongs
        example: 3
        in: path
        name: taskId
        required: true
        schema:
          type: integer
          format: int64
      - description: Task-Manager-specific unique key of the structure
        example: s5
        in: path
        name: structureKey
        required: true
        schema:
          type: string
      - description: the output format of the structure, if not set, then returns the way the structure is in the database
        in: query
        name: outputFormat
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                type: string
                format: byte
          description: OK
      summary: Gets the specified structure of the specified task / background process
      tags:
      - Db Work queue handler controller
    servers:
    - url: https://jchem-microservices.chemaxon.com/jws-taskmanager
  /rest-v1/work-queue/db/task/{taskId}/structures:
    get:
      operationId: getStructures_1
      parameters:
      - description: id of the task to which the structure belongs
        example: 3
        in: path
        name: taskId
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DbStructureResponse'
          description: OK
      summary: Gets all of the structures of the specified task / background process
      tags:
      - Db Work queue handler controller
    servers:
    - url: https://jchem-microservices.chemaxon.com/jws-taskmanager
  /rest-v1/work-queue/db/task/{taskId}/upload:
    post:
      operationId: uploadStructures_1
      parameters:
      - description: id of the task to upload the structures
        example: 3
        in: path
        name: taskId
        required: true
        schema:
          type: integer
          format: int64
      - description: input format and options
        in: query
        name: inputFormat
        required: false
        schema:
          type: string
      - description: the mode of error handling
        in: query
        name: errorHandlingMode
        required: true
        schema:
          type: string
          default: HALT
          enum:
          - SKIP
          - HALT
          - EMPTY
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: The file containing the structures to upload to the specified task
              required:
              - file
      responses:
        '201':
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
          description: Created
      summary: Uploads structures of specified task
      tags:
      - Db Work queue handler controller
    servers:
    - url: https://jchem-microservices.chemaxon.com/jws-taskmanager
  /rest-v1/work-queue/db/tasks:
    get:
      operationId: tasks_1
      responses:
        '200':
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DbTaskDescriptor'
          description: OK
      summary: Lists all tasks
      tags:
      - Db Work queue handler controller
    servers:
    - url: https://jchem-microservices.chemaxon.com/jws-taskmanager
components:
  schemas:
    DbStructureResponse:
      properties:
        additionalData:
          type: object
          additionalProperties:
            type: object
          description: The additional data of the structure
        id:
          type: integer
          format: int64
          description: The ID of the structure.
        inputFormat:
          type: string
          description: The input format of the structure
        key:
          type: string
          description: Task-Manager-specific unique key of the structure
        structure:
          type: string
          description: The structure.
    ResultInProgressResponse:
      description: Information about a task that is still in progress
      properties:
        message:
          type: string
          description: Task in progress message
          example: Results are not yet available.
    DbAddStructuresRequest:
      description: structure and input format descriptor object
      properties:
        inputFormat:
          type: string
          description: The input format and options.
          example: smiles
        structures:
          type: array
          description: A list of structures to add to task.
          example:
          - additionalData:
              mass: '33.2'
              radioactive: 'false'
            id: 1
            structure: O=C1CCCC=C1
          - id: 2
            structure: C1CCCCC1
          items:
            $ref: '#/components/schemas/DbStructureWithId'
      required:
      - structures
    DbStructureWithId:
      properties:
        additionalData:
          type: object
          additionalProperties:
            type: object
          description: The additional data of the structure
          example:
            mass: '46.042'
            name: etanol
            radioactive: 'false'
        id:
          type: integer
          format: int64
          description: The ID of the structure.
        structure:
          type: string
          description: The structure.
          example: O=C1CCCC=C1
    MonitorResponse:
      description: Information about the state of the task
      properties:
        inQueuePosition:
          type: integer
          format: int32
          description: The task's position in the queue while its status is WAITING.
        processedError:
          type: integer
          format: int64
          description: Number of failed structures.
        processedPercentage:
          type: integer
          format: int64
          description: This shows the percentage of structures which were processed.
        processedSuccess:
          type: integer
          format: int64
          description: Number of successfully processed structures.
        status:
          type: string
          description: 'The status of the task. Possible values: PREPARING, WAITING, IN PROGRESS, READY, ERROR, PAUSED'
          enum:
          - PREPARING
          - WAITING
          - IN_PROGRESS
          - READY
          - ERROR
          - PAUSED
    DbTaskDescriptor:
      description: All information about the db task
      properties:
        organization:
          type: string
          deprecated: true
          description: Not used. A default value is returned for backward compatibility.
        params:
          type: object
          description: Any additional property object to set up the task.
          example:
            idProperty: CD_ID
            isDuplicateFiltering: 'true'
            tableName: exampleTable
        status:
          type: string
          description: Current status of task
          enum:
          - PREPARING
          - WAITING
          - IN_PROGRESS
          - READY
          - ERROR
          - PAUSED
        task:
          type: string
          description: The process that should be performed by the service
          example: batchInsert
        taskId:
          type: integer
          format: int64
          description: The identifier of the task in the database
        user:
          type: string
          deprecated: true
          description: Not used. A default value is returned for backward compatibility.
    ManageRequest:
      description: manage a task
      properties:
        action:
          type: string
          description: The action to take on the task
          enum:
          - START
          - PAUSE
          example: START
      required:
      - action
    DbTaskCreationRequest:
      description: universal task descriptor object
      properties:
        params:
          type: object
          description: Any additional property object to set up the task.
          example:
            idProperty: CD_ID
            isDuplicateFiltering: 'true'
            tableName: exampleTable
        task:
          type: string
          description: The process that should be performed by the service
          example: batchInsert
    DbResultResponse:
      description: DB task result.
      oneOf:
      - $ref: '#/components/schemas/BatchInsertResponse'
      - $ref: '#/components/schemas/ResultInProgressResponse'
    BatchInsertResponse:
      description: Batch insert task result
      properties:
        duplicatedIds:
          type: array
          description: A list containing the IDs of the input structures which are duplicates of an already inserted structure. If you are using autogenerated IDs, this list is empty.
          example:
          - 7
          items:
            type: integer
            format: int64
        duplicatedKeys:
          type: array
          description: A list containing the Task-Manager-specific unique keys of the input structures which are duplicates of an already inserted structure. (If you are using autogenerated IDs, this is the only information you can use to detect which of your inputs are duplicates.)
          example:
          - s5
          items:
            type: string
        failedIds:
          type: array
          description: A list containing the IDs of the input structures which could not be imported. If you are using autogenerated IDs, this list is empty.
          example:
          - 7
          items:
            type: integer
            format: int64
        failedKeys:
          type: array
          description: A list containing the Task-Manager-specific unique keys of the input structures which could not be imported. (If you are using autogenerated IDs, this is the only information you can use to detect which of your inputs had errors.)
          example:
          - s5
          items:
            type: string
        successfulIds:
          type: array
          description: A list containing the IDs of the input structures which were imported. If you are using autogenerated IDs, this list contains the generated IDs of the imported structures in the same order as they appear in "successfulKeys".
          example:
          - 2
          items:
            type: integer
            format: int64
        successfulKeys:
          type: array
          description: A list containing the Task-Manager-specific unique keys of the input structures which were imported. (If you are using autogenerated IDs, this is the only information you can use to detect which are the IDs of your inputs.)
          example:
          - s5
          items:
            type: string
x-refined-from:
- chemaxon-task-manager-openapi.json
- chemaxon-task-manager-openapi.yml