Collaborative Drug Discovery Files 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 Files API
  version: 1.0.0
servers:
- url: https://app.collaborativedrug.com/api/v1
security:
- ApiKeyAuth: []
tags:
- description: File attachments
  name: Files
paths:
  /vaults/{vault_id}/files:
    post:
      description: 'Attach a file to a record in the vault. The request must be sent as `multipart/form-data` (the file itself is the `file` part; the `resource_class` and `resource_id` fields identify the record to attach it to).


        Files can only be attached to the four resource classes listed under `resource_class`: `run`, `molecule`, `protocol`, and `eln_entry`. Readout rows are not directly attachable — there is no `readout_row` resource class. To associate a file with protocol readout data, attach it to the parent `run` (`resource_class: run`, `resource_id`: the run''s id) or to the `protocol`.'
      operationId: attachFile
      parameters:
      - in: path
        name: vault_id
        required: true
        schema:
          $ref: '#/components/schemas/vault_id'
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                file:
                  description: Path to the file to be uploaded
                  format: binary
                  type: string
                resource_class:
                  description: Class of the resource to which the file is attached
                  enum:
                  - run
                  - molecule
                  - protocol
                  - eln_entry
                  type: string
                resource_id:
                  description: Unique identifier of the resource to which the file is attached
                  type: string
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  id:
                    description: Internal file ID
                    type: string
                  name:
                    description: Name of the file
                    type: string
                type: object
          description: File successfully attached
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_apikey'
          description: Missing or invalid API key
      summary: Attach a file to an object
      tags:
      - Files
  /vaults/{vault_id}/files/{file_id}:
    delete:
      description: Delete a file
      operationId: deleteFile
      parameters:
      - in: path
        name: vault_id
        required: true
        schema:
          $ref: '#/components/schemas/vault_id'
      - in: path
        name: file_id
        required: true
        schema:
          description: Numeric identifier of the file
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/file'
          description: The file
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_apikey'
          description: Missing or invalid API key
      summary: Delete file
      tags:
      - Files
    get:
      description: Return a single file with the content base64 encoded.
      operationId: getFile
      parameters:
      - in: path
        name: vault_id
        required: true
        schema:
          $ref: '#/components/schemas/vault_id'
      - in: path
        name: file_id
        required: true
        schema:
          description: Numeric identifier of the file
          type: integer
      responses:
        '200':
          description: Successful operation, output will depend on format selected when doing the query
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_apikey'
          description: Missing or invalid API key
        '404':
          content:
            application/json:
              schema:
                properties:
                  error:
                    default: Couldn't find file with 'id'={file_id}
                type: object
          description: Couldn't find this file
      summary: Retrieve a file
      tags:
      - Files
components:
  schemas:
    file:
      properties:
        character_set:
          example: US-ASCII
          type: string
        class:
          example: uploaded file
          type: string
        contents:
          description: Base64 encoded contents of the file
          example: VGhpcyBpcyBhIGZpbGUK
          type: string
        id:
          example: 1069448031
          type: integer
        mime_type:
          properties:
            hash:
              example: -1147906696977776400
              type: integer
            string:
              example: text/plain
              type: string
            symbol:
              example: text
              type: string
            synonyms:
              items:
                type: string
              type: array
          type: object
        name:
          example: tmp.txt
          type: string
      type: object
    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
    vault_id:
      description: Numeric identifier of the vault
      type: integer
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-CDD-Token
      type: apiKey