Benchling Procedure Parameter Version API

openapi: 3.2.0
info:
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  title: Benchling Procedure Parameter Version API
  version: 2.0.0
  description: 'A versioned definition of a procedure parameter. Each version specifies the parameter''s name,

    description, data type configuration (`dataType`), and how values are entered (`confirmationMethod`).

    Parameters are versioned to allow procedure templates to evolve while preserving the exact

    configuration used in past executions. Links to its parent `ProcedureParameter` for identity.

    For data parameters, `minimum` and `maximum` fields define optional numeric bounds. For material

    inputs, `amountDataType` configures how quantities are specified. For equipment parameters,

    `allowedEquipmentModels` restricts which equipment can be selected. May reference a

    `LibraryParameterDefinition` when the parameter was created from the parameter library.'
servers:
- url: /api/v3
security:
- oAuth: []
- basicApiKeyAuth: []
tags:
- description: 'A versioned definition of a procedure parameter. Each version specifies the parameter''s name,

    description, data type configuration (`dataType`), and how values are entered (`confirmationMethod`).

    Parameters are versioned to allow procedure templates to evolve while preserving the exact

    configuration used in past executions. Links to its parent `ProcedureParameter` for identity.

    For data parameters, `minimum` and `maximum` fields define optional numeric bounds. For material

    inputs, `amountDataType` configures how quantities are specified. For equipment parameters,

    `allowedEquipmentModels` restricts which equipment can be selected. May reference a

    `LibraryParameterDefinition` when the parameter was created from the parameter library.'
  name: ProcedureParameterVersion
  x-bnch-organization: Benchling
paths:
  /procedure-parameter-version/items:
    get:
      description: List ProcedureParameterVersion items.
      operationId: ProcedureParameterVersion.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/libraryParameterDefinition.anyOf'
      - $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/procedureParameter.eq'
      - $ref: '#/components/parameters/returning'
      - description: 'Method by which to order results. Valid sorts are: createdAt (created time, oldest first). Use :asc or :desc to specify ascending or descending order. Default is createdAt:desc.'
        in: query
        name: sort
        schema:
          default: createdAt:desc
          enum:
          - createdAt:asc
          - createdAt: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/ProcedureParameterVersionPaginatedList'
          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: List ProcedureParameterVersion items
      tags:
      - ProcedureParameterVersion
      x-bnch-rate-limit-tier: 4
  /procedure-parameter-version/{procedure_parameter_version_id}:
    get:
      description: Get a single ProcedureParameterVersion by ID.
      operationId: ProcedureParameterVersion.Get
      parameters:
      - description: ID of the ProcedureParameterVersion.
        in: path
        name: procedure_parameter_version_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/ProcedureParameterVersion'
          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 ProcedureParameterVersion by ID
      tags:
      - ProcedureParameterVersion
      x-bnch-rate-limit-tier: 5
components:
  schemas:
    ProcedureParameterDataType:
      description: 'Specifies the value type configuration for a procedure parameter. Used within

        `ProcedureParameterVersion` to define what kind of data a parameter accepts. The `type` field

        indicates the field type (such as text, decimal, entity link, or dropdown). For numeric types,

        `unit` optionally references a `Unit` for measurement context. For entity link types, `schema`

        optionally constrains values to entities of a specific `EntitySchema`. Also used as

        `amountDataType` on material input parameter versions to define how amounts are specified.'
      properties:
        __typename:
          type: string
        dropdown:
          oneOf:
          - $ref: '#/components/schemas/DropdownRef'
          - type: 'null'
        schema:
          oneOf:
          - $ref: '#/components/schemas/EntitySchemaRef'
          - type: 'null'
        type:
          type: string
        unit:
          oneOf:
          - $ref: '#/components/schemas/UnitRef'
          - type: 'null'
      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
    EntitySchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    PrincipalRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureParameterVersionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureParameterVersion'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureParameterVersion:
      description: 'A versioned definition of a procedure parameter. Each version specifies the parameter''s name,

        description, data type configuration (`dataType`), and how values are entered (`confirmationMethod`).

        Parameters are versioned to allow procedure templates to evolve while preserving the exact

        configuration used in past executions. Links to its parent `ProcedureParameter` for identity.

        For data parameters, `minimum` and `maximum` fields define optional numeric bounds. For material

        inputs, `amountDataType` configures how quantities are specified. For equipment parameters,

        `allowedEquipmentModels` restricts which equipment can be selected. May reference a

        `LibraryParameterDefinition` when the parameter was created from the parameter library.'
      properties:
        __typename:
          type: string
        allowedEquipmentModels:
          type:
          - 'null'
          - object
        amountDataType:
          oneOf:
          - $ref: '#/components/schemas/ProcedureParameterDataType'
          - type: 'null'
        confirmationMethod:
          enum:
          - TABLE
          - PLATE_MAP
          type: string
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        dataType:
          $ref: '#/components/schemas/ProcedureParameterDataType'
        description:
          type: string
        id:
          type: string
        maximum:
          type:
          - 'null'
          - object
        minimum:
          type:
          - 'null'
          - object
        name:
          type: string
        procedureParameter:
          $ref: '#/components/schemas/ProcedureParameterRef'
      type: object
    DropdownRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    UnitRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    GeneralError:
      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
    ProcedureParameterRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
  parameters:
    pageSize:
      description: Number of results to return. Defaults to 50, maximum of 100.
      in: query
      name: pageSize
      schema:
        type: integer
    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
    libraryParameterDefinition.anyOf:
      description: Restricts results to parameter versions linked to any of the specified library parameter definition IDs. Comma-separated list.
      explode: false
      in: query
      name: libraryParameterDefinition.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    procedureParameter.eq:
      description: ID of a procedure parameter. Restricts results to children of the specified parameter.
      in: query
      name: procedureParameter.eq
      schema:
        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
    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
    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.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
    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
    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
    nextToken:
      description: Token for pagination
      in: query
      name: nextToken
      schema:
        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
    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
    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
  responses:
    NotFound:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Not Found
    TooManyRequests:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Too Many Requests
    BadRequest:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Bad Request
    Forbidden:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Forbidden
    InternalServerError:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
      description: Internal Server Error
  securitySchemes:
    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