Benchling Data Frame API

openapi: 3.2.0
info:
  title: Benchling Data Frame API
  version: 2.0.0
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  description: 'Operations tagged DataFrame across 2 of this provider''s published API definitions: benchling-openapi.yml, benchling-v3-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v3
security:
- oAuth: []
- basicApiKeyAuth: []
tags:
- description: '`DataFrame` stores non-schematized tabular data, with Benchling-aware column types (see `DataFrameColumn`).

    Data frames are not searchable and lack their own permissions; rather, they are child objects of pipelines

    (via `AutomationStepData`), datasets (see `Dataset`), and app canvases. Row data is stored in S3. Data frames

    are immutable; if data is updated, a new `DataFrame` is created.'
  name: DataFrame
  x-bnch-organization: Benchling
  x-displayName: Data Frame
paths:
  /data-frame:
    post:
      description: Create DataFrame.
      operationId: DataFrame.Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDataFrameInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFrame'
          description: Created
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Create DataFrame
      tags:
      - DataFrame
    servers:
    - url: /api/v3
  /data-frame/{data_frame_id}:
    get:
      description: Get a single DataFrame by ID.
      operationId: DataFrame.Get
      parameters:
      - description: ID of the DataFrame.
        in: path
        name: data_frame_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFrame'
          description: OK
          headers: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get DataFrame by ID
      tags:
      - DataFrame
    servers:
    - url: /api/v3
  /data-frame:batch-create:
    post:
      description: Batch create DataFrame synchronously in one transaction. Maximum 20 items per request.
      operationId: DataFrame.BatchCreate
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateDataFrameInput'
                  maxItems: 20
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/DataFrame'
                    type: array
                required:
                - items
                type: object
          description: Created
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Batch create DataFrame
      tags:
      - DataFrame
    servers:
    - url: /api/v3
  /data-frame:bulk-create:
    post:
      description: Bulk create DataFrame.
      operationId: DataFrame.BulkCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Bulk create DataFrame
      tags:
      - DataFrame
    servers:
    - url: /api/v3
  /data-frame/items:
    get:
      description: List DataFrame items.
      operationId: DataFrame.List
      parameters:
      - $ref: '#/components/parameters/createdAt.gt'
      - $ref: '#/components/parameters/createdAt.gte'
      - $ref: '#/components/parameters/createdAt.lt'
      - $ref: '#/components/parameters/createdAt.lte'
      - $ref: '#/components/parameters/creator.anyOf'
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $ref: '#/components/parameters/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/returning'
      - description: 'Method by which to order results. Valid sorts are: createdAt (created time, oldest first) and modifiedAt (modified time, oldest first). Use :asc or :desc to specify ascending or descending order. Default is modifiedAt:desc.'
        in: query
        name: sort
        schema:
          default: modifiedAt:desc
          enum:
          - createdAt:asc
          - createdAt:desc
          - modifiedAt:asc
          - modifiedAt:desc
          type: string
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFramePaginatedList'
          description: OK
          headers: {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests_2'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: List DataFrame items
      tags:
      - DataFrame
      x-bnch-rate-limit-tier: 4
    servers:
    - url: /api/v3
components:
  schemas:
    PrincipalRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    GeneralError:
      properties:
        detail:
          type:
          - 'null'
          - string
          - object
        instance:
          type: string
        invalidId:
          type: string
        status:
          type: integer
        title:
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - type
      - title
      - detail
      - status
      - instance
      type: object
    TooManyRequestsError:
      properties:
        detail:
          type:
          - 'null'
          - string
          - object
        instance:
          type: string
        invalidId:
          type: string
        status:
          type: integer
        title:
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - type
      - title
      - detail
      - status
      - instance
      type: object
    DatasetRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    CreateDataFrameInput:
      additionalProperties: false
      properties:
        delimiter:
          description: Single-character delimiter used when parsing the file. Defaults to a tab for .tsv files and ',' otherwise.
          maxLength: 1
          minLength: 1
          type: string
        locale:
          description: Locale used for number parsing, such as decimal and thousands separators (e.g. 'en-US'). Defaults to 'en-US' if not specified.
          type: string
        name:
          type: string
        scratchFileId:
          description: ID of ScratchFile containing the raw file from which to create the DataFrame. Only files with a .csv or .tsv extension are supported.
          type:
          - 'null'
          - string
      required:
      - name
      - scratchFileId
      type: object
    DataFrameManifestItem:
      description: 'Represents one part of a DataFrame''s downloadable row data. Currently, the manifest

        always contains exactly one item. The array structure is forward-compatible with future

        multi-part download support for large data frames.'
      properties:
        __typename:
          type: string
        fileName:
          type: string
        url:
          type: string
      type: object
    DataFrameColumn:
      description: 'Defines a column within a DataFrame, including its internal system name, user-facing

        display name, and data type specification.'
      properties:
        __typename:
          type: string
        displayName:
          type: string
        systemName:
          type: string
        type:
          type: object
      type: object
    AsyncTaskLink:
      properties:
        pollingUri:
          format: uri
          type: string
        taskId:
          type: string
      type: object
    InternalServerError:
      properties:
        detail:
          type:
          - 'null'
          - string
          - object
        errorId:
          type: string
        instance:
          type: string
        status:
          type: integer
        title:
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - type
      - title
      - detail
      - status
      - instance
      type: object
    BulkImport:
      example:
        fileId: scrfile_jdf8BV24kLmN
      properties:
        fileId:
          description: The API ID of the scratch file (`scrfile_XXXXXXXX`) containing the items to import. The referenced file must be a scratch file whose upload has completed successfully.
          type: string
      required:
      - fileId
      type: object
    DataFrame:
      description: '`DataFrame` stores non-schematized tabular data, with Benchling-aware column types (see `DataFrameColumn`).

        Data frames are not searchable and lack their own permissions; rather, they are child objects of pipelines

        (via `AutomationStepData`), datasets (see `Dataset`), and app canvases. Row data is stored in S3. Data frames

        are immutable; if data is updated, a new `DataFrame` is created.'
      properties:
        __typename:
          type: string
        columns:
          items:
            $ref: '#/components/schemas/DataFrameColumn'
          type: array
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        dataset:
          oneOf:
          - $ref: '#/components/schemas/DatasetRef'
          - type: 'null'
        errorMessage:
          type:
          - 'null'
          - string
        id:
          type: string
        manifest:
          items:
            $ref: '#/components/schemas/DataFrameManifestItem'
          type: array
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        size:
          type: integer
        uploadStatus:
          enum:
          - SUCCEEDED
          - FAILED_VALIDATION
          - IN_PROGRESS
          - NOT_UPLOADED
          type: string
      type: object
    GeneralError_2:
      properties:
        detail:
          type:
          - 'null'
          - string
          - object
        instance:
          type: string
        status:
          type: integer
        title:
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - type
      - title
      - detail
      - status
      - instance
      type: object
    DataFramePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/DataFrame_2'
          type: array
        nextToken:
          type: string
      type: object
    DataFrame_2:
      description: '`DataFrame` stores non-schematized tabular data, with Benchling-aware column types (see `DataFrameColumn`).

        Data frames are not searchable and lack their own permissions; rather, they are child objects of pipelines

        (via `PipelineStepData`), datasets (see `Dataset`), and app canvases. Row data is stored in S3. Data frames

        are immutable; if data is updated, a new `DataFrame` is created.'
      properties:
        __typename:
          type: string
        columns:
          items:
            $ref: '#/components/schemas/DataFrameColumn'
          type: array
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        dataset:
          oneOf:
          - $ref: '#/components/schemas/DatasetRef'
          - type: 'null'
        errorMessage:
          type:
          - 'null'
          - string
        id:
          type: string
        manifest:
          items:
            $ref: '#/components/schemas/DataFrameManifestItem'
          type: array
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        size:
          type: integer
        uploadStatus:
          enum:
          - SUCCEEDED
          - FAILED_VALIDATION
          - IN_PROGRESS
          - NOT_UPLOADED
          type: string
      type: object
  responses:
    BadRequest:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Bad Request
    NotFound:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Not Found
    Forbidden:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Forbidden
    Conflict:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Conflict
    TooManyRequests:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/TooManyRequestsError'
      description: Too Many Requests
      headers:
        Retry-After:
          description: Minimum number of seconds to wait before retrying. Only included when the request exceeded a rate limit specific to the caller. Limits shared with other callers, such as tenant-wide limits, omit this header because the wait depends on their traffic.
          required: false
          schema:
            minimum: 1
            type: integer
    InternalServerError:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
      description: Internal Server Error
    TooManyRequests_2:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError_2'
      description: Too Many Requests
  parameters:
    omit:
      description: Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.
      explode: false
      in: query
      name: omit
      schema:
        items:
          type: string
        type: array
    returning:
      description: Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.
      explode: false
      in: query
      name: returning
      schema:
        items:
          type: string
        type: array
    modifiedAt.gte:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified at or after the specified time. e.g. >= 2017-04-30.
      in: query
      name: modifiedAt.gte
      schema:
        format: datetime
        type: string
    creator.anyOf:
      description: Restricts results to those created by any of the specified user IDs. Comma-separated list.
      explode: false
      in: query
      name: creator.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    createdAt.lte:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or before the specified time. e.g. <= 2017-04-30.
      in: query
      name: createdAt.lte
      schema:
        format: datetime
        type: string
    modifiedAt.lte:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified at or before the specified time. e.g. <= 2017-04-30.
      in: query
      name: modifiedAt.lte
      schema:
        format: datetime
        type: string
    name.anyOf:
      description: Restricts results to those that match any of the specified names. Case insensitive. Warning - this filter can be non-performant due to case insensitivity. Ensure only one name filter is used at a time. Comma-separated list.
      explode: false
      in: query
      name: name.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    createdAt.gt:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created after the specified time. e.g. > 2017-04-30.
      in: query
      name: createdAt.gt
      schema:
        format: datetime
        type: string
    nextToken:
      description: Token for pagination
      in: query
      name: nextToken
      schema:
        type: string
    name.anyOf.caseSensitive:
      description: Restricts results to those that match any of the specified names. Case sensitive. Ensure only one name filter is used at a time. Comma-separated list.
      explode: false
      in: query
      name: name.anyOf.caseSensitive
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    modifiedAt.gt:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified after the specified time. e.g. > 2017-04-30.
      in: query
      name: modifiedAt.gt
      schema:
        format: datetime
        type: string
    pageSize:
      description: Number of results to return. Defaults to 50, maximum of 100.
      in: query
      name: pageSize
      schema:
        type: integer
    modifiedAt.lt:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified before the specified time. e.g. < 2017-04-30.
      in: query
      name: modifiedAt.lt
      schema:
        format: datetime
        type: string
    createdAt.gte:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or after the specified time. e.g. >= 2017-04-30.
      in: query
      name: createdAt.gte
      schema:
        format: datetime
        type: string
    createdAt.lt:
      description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created before the specified time. e.g. < 2017-04-30.
      in: query
      name: createdAt.lt
      schema:
        format: datetime
        type: string
    id.anyOf:
      description: Restricts results to those matching any of the specified IDs. Comma-separated list.
      explode: false
      in: query
      name: id.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
  securitySchemes:
    BearerAuth:
      description: Use a short-lived V3 API Explorer token.
      scheme: bearer
      type: http
      x-fern-playground-description: Copy a short-lived V3 API Explorer token from the user's settings page
    basicApiKeyAuth:
      description: Use issued API key for standard access to the API
      scheme: basic
      type: http
    basicClientIdSecretAuth:
      description: Auth used as part of client credentials OAuth flow prior to receiving a bearer token.
      scheme: basic
      type: http
    oAuth:
      description: OAuth2 Client Credentials flow intended for service access
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: /oauth/token
      type: oauth2
x-refined-from:
- benchling-openapi.yml
- benchling-v3-openapi.yaml