Benchling Automation Template 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 Variable API
  version: 2.0.0
  description: 'Defines a configuration parameter within an AutomationTemplate that users can customize when

    applying the template. Unlike AutomationTemplateDataFrameVariable which handles data frame

    inputs, this type represents scalar configuration values such as thresholds, filter criteria,

    or algorithm parameters. The configVariableKey identifies which step configuration field

    this variable controls, and variableTypeConfigSpec defines the allowed value types. When

    users apply a template, they provide values for these variables that configure the behavior

    of the corresponding AutomationStep. Note: These are surfaced as "config variables" on the AutomationTemplate object.'
servers:
- url: /api/v3
security:
- oAuth: []
- basicApiKeyAuth: []
tags:
- description: 'Defines a configuration parameter within an AutomationTemplate that users can customize when

    applying the template. Unlike AutomationTemplateDataFrameVariable which handles data frame

    inputs, this type represents scalar configuration values such as thresholds, filter criteria,

    or algorithm parameters. The configVariableKey identifies which step configuration field

    this variable controls, and variableTypeConfigSpec defines the allowed value types. When

    users apply a template, they provide values for these variables that configure the behavior

    of the corresponding AutomationStep. Note: These are surfaced as "config variables" on the AutomationTemplate object.'
  name: AutomationTemplateVariable
  x-bnch-organization: Benchling
  x-displayName: Automation Template Variable
paths:
  /automation-template-variable/{automation_template_variable_id}:
    get:
      description: Get a single AutomationTemplateVariable by ID.
      operationId: AutomationTemplateVariable.Get
      parameters:
      - description: ID of the AutomationTemplateVariable.
        in: path
        name: automation_template_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/AutomationTemplateVariable'
          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 AutomationTemplateVariable by ID
      tags:
      - AutomationTemplateVariable
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
    AutomationTemplateVariable:
      description: 'Defines a configuration parameter within an AutomationTemplate that users can customize when

        applying the template. Unlike AutomationTemplateDataFrameVariable which handles data frame

        inputs, this type represents scalar configuration values such as thresholds, filter criteria,

        or algorithm parameters. The configVariableKey identifies which step configuration field

        this variable controls, and variableTypeConfigSpec defines the allowed value types. When

        users apply a template, they provide values for these variables that configure the behavior

        of the corresponding AutomationStep. Note: These are surfaced as "config variables" on the AutomationTemplate object.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        automationStep:
          $ref: '#/components/schemas/AutomationStepRef'
        configVariableKey:
          type: string
        createdAt:
          format: datetime
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        pipelineStep:
          $ref: '#/components/schemas/AutomationStepRef'
          deprecated: true
          description: Use automationStep instead.
        template:
          $ref: '#/components/schemas/AutomationTemplateRef'
        variableTypeConfigSpec:
          description: Defines the allowed value type and validation constraints for this variable. The structure depends on the variable's data type.
          type: object
      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