Collaborative Drug Discovery Import Parsers 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 Import Parsers API
  version: 1.0.0
servers:
- url: https://app.collaborativedrug.com/api/v1
security:
- ApiKeyAuth: []
tags:
- description: Import parsers for structured data files
  name: Import Parsers
paths:
  /vaults/{vault_id}/import_parsers:
    get:
      description: List the import parsers (structured-file parsing templates) defined in the vault. The listing returns summary fields only; use the show endpoint to retrieve a parser's full `template_json` configuration.
      operationId: getImportParsers
      parameters:
      - in: path
        name: vault_id
        required: true
        schema:
          $ref: '#/components/schemas/vault_id'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  count:
                    type: integer
                  objects:
                    items:
                      $ref: '#/components/schemas/import_parser'
                    type: array
                required:
                - count
                - objects
                type: object
          description: List of import parsers
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_apikey'
          description: Missing or invalid API key
      summary: Get import parsers
      tags:
      - Import Parsers
  /vaults/{vault_id}/import_parsers/{id}:
    get:
      description: Retrieve a single import parser, including its full `template_json` configuration.
      operationId: getImportParser
      parameters:
      - in: path
        name: vault_id
        required: true
        schema:
          $ref: '#/components/schemas/vault_id'
      - description: Numeric identifier of the import parser
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/import_parser'
          description: The import parser
        '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: Import parser not found, or vault is unauthorized
      summary: Get an import parser
      tags:
      - Import Parsers
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
    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
    import_parser:
      description: An import parser (plate block template) describing how a structured data file should be parsed during import.
      properties:
        created_at:
          format: date-time
          type: string
        id:
          type: integer
        modified_at:
          format: date-time
          type: string
        name:
          description: Name of the import parser.
          type: string
        owner:
          description: Full name of the user who owns the import parser.
          type: string
        template_json:
          additionalProperties: true
          description: The parser configuration (arbitrary JSON object). Only returned by the show endpoint, not in the index listing.
          type: object
      required:
      - id
      - name
      - created_at
      - modified_at
      - owner
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-CDD-Token
      type: apiKey