Collaborative Drug Discovery Registration Forms 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 Registration Forms API
  version: 1.0.0
servers:
- url: https://app.collaborativedrug.com/api/v1
security:
- ApiKeyAuth: []
tags:
- description: Registration forms
  name: Registration Forms
paths:
  /vaults/{vault_id}/registration_forms:
    get:
      description: List the registration forms configured in the vault.
      operationId: getRegistrationForms
      parameters:
      - in: path
        name: vault_id
        required: true
        schema:
          $ref: '#/components/schemas/vault_id'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/registration_form'
                type: array
          description: List of registration forms
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_apikey'
          description: Missing or invalid API key
      summary: Get registration forms
      tags:
      - Registration Forms
  /vaults/{vault_id}/registration_forms/{id}:
    get:
      description: Retrieve a single registration form.
      operationId: getRegistrationForm
      parameters:
      - in: path
        name: vault_id
        required: true
        schema:
          $ref: '#/components/schemas/vault_id'
      - description: Numeric identifier of the registration form
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/registration_form'
          description: The registration form
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_apikey'
          description: Missing or invalid API key
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
          description: Registration form not found, or vault is unauthorized
      summary: Get a registration form
      tags:
      - Registration Forms
components:
  schemas:
    registration_form:
      description: A registration form configured in the vault.
      properties:
        allow_new_molecules:
          description: Whether the form permits registering new molecules.
          type: boolean
        class:
          example: registration form
          type: string
        created_at:
          format: date-time
          type: string
        id:
          type: integer
        modified_at:
          format: date-time
          type: string
        name:
          type: string
        registration_system:
          description: The registration system the form belongs to. Present only when the form is associated with a registration system.
          properties:
            class:
              example: registration system
              type: string
            id:
              type: integer
          type: object
        registration_type:
          description: The kind of entity this form registers.
          type: string
      required:
      - id
      - name
      - registration_type
      - allow_new_molecules
      - created_at
      - modified_at
      - class
      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
    error:
      description: A general error response containing an error message and HTTP status code
      properties:
        code:
          description: HTTP status code
          type: integer
          example: 404
        error:
          description: Human-readable error message
          type: string
          example: Resource not found
      type: object
    vault_id:
      description: Numeric identifier of the vault
      type: integer
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-CDD-Token
      type: apiKey