Benchling Automation Template Data Frame Variable API

openapi: 3.2.0
info:
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  title: Benchling Automation Template Data Frame Variable API
  version: 2.0.0
  description: 'Defines a data frame placeholder within an AutomationTemplate that users must provide when

    applying the template. Each variable specifies which AutomationStep input (replaceStep,

    replaceStepData, replaceStepDataIndex) will receive the user-provided data frame. The

    replaceDataFrameColumnsSpec field defines the expected column structure that the provided

    data must match. When users apply an automation template to create an Analysis, they provide

    bindings that map actual data frames to these variables, populating the template''s pipeline

    with real data.'
servers:
- url: /api/v3
security:
- oAuth: []
- basicApiKeyAuth: []
tags:
- description: 'Defines a data frame placeholder within an AutomationTemplate that users must provide when

    applying the template. Each variable specifies which AutomationStep input (replaceStep,

    replaceStepData, replaceStepDataIndex) will receive the user-provided data frame. The

    replaceDataFrameColumnsSpec field defines the expected column structure that the provided

    data must match. When users apply an automation template to create an Analysis, they provide

    bindings that map actual data frames to these variables, populating the template''s pipeline

    with real data.'
  name: AutomationTemplateDataFrameVariable
  x-bnch-organization: Benchling
  x-displayName: Automation Template Data Frame Variable
paths:
  /automation-template-data-frame-variable/{automation_template_data_frame_variable_id}:
    get:
      description: Get a single AutomationTemplateDataFrameVariable by ID.
      operationId: AutomationTemplateDataFrameVariable.Get
      parameters:
      - description: ID of the AutomationTemplateDataFrameVariable.
        in: path
        name: automation_template_data_frame_variable_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      - 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/AutomationTemplateDataFrameVariable'
          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 AutomationTemplateDataFrameVariable by ID
      tags:
      - AutomationTemplateDataFrameVariable
components:
  schemas:
    AutomationTemplateRef:
      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
    AutomationTemplateDataFrameVariable:
      description: 'Defines a data frame placeholder within an AutomationTemplate that users must provide when

        applying the template. Each variable specifies which AutomationStep input (replaceStep,

        replaceStepData, replaceStepDataIndex) will receive the user-provided data frame. The

        replaceDataFrameColumnsSpec field defines the expected column structure that the provided

        data must match. When users apply an automation template to create an Analysis, they provide

        bindings that map actual data frames to these variables, populating the template''s pipeline

        with real data.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        description:
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        replaceDataFrameColumnsSpec:
          description: Expected column structure that the provided DataFrame must match.
          items:
            $ref: '#/components/schemas/DataFrameColumn'
          type: array
        replaceStep:
          $ref: '#/components/schemas/AutomationStepRef'
          description: The AutomationStep whose input will be replaced by the bound DataFrame.
        replaceStepData:
          $ref: '#/components/schemas/AutomationStepDataRef'
          description: The specific AutomationStepData slot on the step that receives the bound DataFrame.
        replaceStepDataIndex:
          description: The index within the step data slot where the bound DataFrame is placed.
          type: integer
        template:
          $ref: '#/components/schemas/AutomationTemplateRef'
      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
    AutomationStepDataRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          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
    AutomationStepRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      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
  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
  responses:
    Forbidden:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Forbidden
    BadRequest:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Bad Request
    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
    NotFound:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Not Found
    InternalServerError:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
      description: Internal Server Error
  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