Collaborative Drug Discovery Batch Move Jobs API

openapi: 3.2.0
info:
  contact:
    url: https://support.collaborativedrug.com/hc/en-us/requests/new
  description: 'Collaborative Drug Discovery provides an API (Application Programming

    Interface) that can be used for secure programmatic access to your vault

    data.'
  license:
    name: Proprietary
    url: https://support.collaborativedrug.com/hc/en-us/requests/new
  title: CDD Batch Move Jobs API
  version: 1.0.0
servers:
- url: https://app.collaborativedrug.com/api/v1
security:
- ApiKeyAuth: []
tags:
- description: Asynchronous batch move jobs
  name: Batch Move Jobs
paths:
  /vaults/{vault_id}/batch_move_jobs:
    get:
      description: Get all batch move jobs. Requires the user to be a vault administrator.
      operationId: get_all_batch_move_jobs
      parameters:
      - in: path
        name: vault_id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/batch_move_job'
                type: array
          description: List of all batch move jobs
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_apikey'
          description: Missing or invalid API key
      summary: Get all batch move jobs
      tags:
      - Batch Move Jobs
    post:
      description: Create a batch move job to move a batch to a different molecule in the same vault. Requires the user to be a vault administrator.
      operationId: create_batch_move_job
      parameters:
      - in: path
        name: vault_id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/batch_move_job_create'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/batch_move_job'
          description: Batch move job created
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_apikey'
          description: Missing or invalid API key
      summary: Create a new batch move job
      tags:
      - Batch Move Jobs
  /vaults/{vault_id}/batch_move_jobs/{job_id}:
    delete:
      description: Cancel a single batch move job. Once a job has started it can no longer be canceled. Requires the user to be a vault administrator.
      operationId: cancel_batch_move_job
      parameters:
      - in: path
        name: vault_id
        required: true
        schema:
          type: integer
      - in: path
        name: job_id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/batch_move_job'
          description: Batch move job canceled
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_apikey'
          description: Missing or invalid API key
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/batch_move_job'
          description: The job is no longer in a cancelable state (it has already started or finished). The current job is returned unchanged.
      summary: Cancel a single batch move job
      tags:
      - Batch Move Jobs
    get:
      description: Retrieve a single batch move job. Requires the user to be a vault administrator.
      operationId: get_single_batch_move_job
      parameters:
      - in: path
        name: vault_id
        required: true
        schema:
          type: integer
      - in: path
        name: job_id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/batch_move_job'
          description: Batch move job details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_apikey'
          description: Missing or invalid API key
      summary: Retrieve a single batch move job
      tags:
      - Batch Move Jobs
components:
  schemas:
    error_apikey:
      description: Whenever the given API key doesn't allow access to the given vault or the vault doesn't exist
      properties:
        code:
          default: 401
          type: integer
        error:
          default: key not authorized for access to this vault
          type: string
      type: object
    batch_move_job_create:
      description: Parameters for creating a batch move job, which moves a batch to a different molecule in the same vault.
      example:
        batch: 618771089
        molecule: 1
        fail_on_molecule_deletion: true
      properties:
        batch:
          description: The ID of the batch to move.
          type: integer
        fail_on_molecule_deletion:
          default: true
          description: Fail the job if moving the batch would trigger removal of the originating molecule. Defaults to true.
          type: boolean
        molecule:
          description: The ID of the molecule to move the batch to.
          type: integer
        name:
          description: A new name for the batch. Optional, and only allowed for vaults without a registration system.
          type: string
      required:
      - batch
      - molecule
      type: object
    batch_move_job:
      properties:
        batch:
          description: The ID of the batch to move
          type: integer
        class:
          description: The class of the job
          example: batch move job
          type: string
        created_at:
          description: The creation time of the batch move job
          format: date-time
          type: string
        fail_on_molecule_deletion:
          description: Whether to fail if moving the batch would trigger the removal of the originating molecule
          type: boolean
        id:
          description: The ID of the batch move job
          type: integer
        modified_at:
          description: The modification time of the batch move job
          format: date-time
          type: string
        molecule:
          description: The ID of the molecule to move the batch to
          type: integer
        name:
          description: The new name given to the batch. Only present when a name was supplied at creation (allowed only for vaults without a registration system).
          type: string
        queued_job_position:
          description: Position of the job in the processing queue. Only present while the job is queued.
          type: integer
        requested_by:
          description: The ID of the user who requested the batch move job
          type: integer
        status:
          description: The status of the batch move job. A job starts as `requested` and transitions through the queue until it reaches a terminal state (`success`, `failure`, or `canceled`).
          enum:
          - requested
          - queued
          - processing
          - success
          - failure
          - canceled
          example: requested
          type: string
        status_message:
          description: Human-readable description of the job's current status.
          type: string
      required:
      - id
      - class
      - created_at
      - modified_at
      - status
      - fail_on_molecule_deletion
      - molecule
      - batch
      - requested_by
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-CDD-Token
      type: apiKey