Benchling Procedure Parameter Planned Value 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 Planned Value API
  version: 2.0.0
  description: 'Stores the expected or planned value for a parameter, set during procedure setup or run planning.

    Used to specify anticipated inputs before execution begins—for example, the target concentration

    for a reagent, the expected sample to use, or the equipment to employ. Scientists can later

    confirm these values (`ProcedureParameterConfirmationValue`) during execution or record actual

    results (`ProcedureParameterMeasuredValue`). For material inputs, `amount` and `container` fields

    specify planned quantities and storage locations. Links to `ProcedureParameterVersion` for the

    parameter definition and optionally to a `ProcedureMethodExecutionInstance` when associated with

    a specific run.'
servers:
- url: /api/v3
security:
- oAuth: []
- basicApiKeyAuth: []
tags:
- description: 'Stores the expected or planned value for a parameter, set during procedure setup or run planning.

    Used to specify anticipated inputs before execution begins—for example, the target concentration

    for a reagent, the expected sample to use, or the equipment to employ. Scientists can later

    confirm these values (`ProcedureParameterConfirmationValue`) during execution or record actual

    results (`ProcedureParameterMeasuredValue`). For material inputs, `amount` and `container` fields

    specify planned quantities and storage locations. Links to `ProcedureParameterVersion` for the

    parameter definition and optionally to a `ProcedureMethodExecutionInstance` when associated with

    a specific run.'
  name: ProcedureParameterPlannedValue
  x-bnch-organization: Benchling
paths:
  /procedure-parameter-planned-value/items:
    get:
      description: List ProcedureParameterPlannedValue items.
      operationId: ProcedureParameterPlannedValue.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/methodExecutionInstance.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/parameterVersion.anyOf'
      - $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/ProcedureParameterPlannedValuePaginatedList'
          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 ProcedureParameterPlannedValue items
      tags:
      - ProcedureParameterPlannedValue
      x-bnch-rate-limit-tier: 4
  /procedure-parameter-planned-value/{procedure_parameter_planned_value_id}:
    get:
      description: Get a single ProcedureParameterPlannedValue by ID.
      operationId: ProcedureParameterPlannedValue.Get
      parameters:
      - description: ID of the ProcedureParameterPlannedValue.
        in: path
        name: procedure_parameter_planned_value_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/ProcedureParameterPlannedValue'
          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 ProcedureParameterPlannedValue by ID
      tags:
      - ProcedureParameterPlannedValue
      x-bnch-rate-limit-tier: 5
components:
  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
    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
    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
    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
    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
    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
    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
    parameterVersion.anyOf:
      description: Restricts results to those that are children of procedure parameter versions matching any of the specified procedure parameter version IDs. Comma-separated list.
      explode: false
      in: query
      name: parameterVersion.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
    methodExecutionInstance.anyOf:
      description: Restricts results to only those that are part of procedure method execution instances matching any of the specified procedure method execution instance IDs. Comma-separated list.
      explode: false
      in: query
      name: methodExecutionInstance.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    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
    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
    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
  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
  schemas:
    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
    ProcedureParameterValueLinkedPlateWell:
      description: 'Associates a parameter value with a specific well on a laboratory plate. Used within

        `ProcedureParameterPlannedValue`, `ProcedureParameterConfirmationValue`, and

        `ProcedureParameterMeasuredValue` via the `plateWellAssociations` field. Enables

        plate map integrations where parameter values correspond to individual wells. The

        `plateId` references the plate (Plate, MatrixPlate, or WellPlate), and `wellPosition`

        specifies the alphanumeric coordinate (such as "A1" or "B19").'
      properties:
        __typename:
          type: string
        plateId:
          type: string
        wellPosition:
          description: Alphanumeric position of plate well eg. A1, B19
          type: string
      type: object
    ProcedureMethodExecutionInstanceRef:
      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
    ProcedureParameterPlannedValuePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureParameterPlannedValue'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureParameterPlannedValue:
      description: 'Stores the expected or planned value for a parameter, set during procedure setup or run planning.

        Used to specify anticipated inputs before execution begins—for example, the target concentration

        for a reagent, the expected sample to use, or the equipment to employ. Scientists can later

        confirm these values (`ProcedureParameterConfirmationValue`) during execution or record actual

        results (`ProcedureParameterMeasuredValue`). For material inputs, `amount` and `container` fields

        specify planned quantities and storage locations. Links to `ProcedureParameterVersion` for the

        parameter definition and optionally to a `ProcedureMethodExecutionInstance` when associated with

        a specific run.'
      properties:
        __typename:
          type: string
        amount:
          type:
          - 'null'
          - object
        container:
          type:
          - 'null'
          - object
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        id:
          type: string
        methodExecutionInstance:
          oneOf:
          - $ref: '#/components/schemas/ProcedureMethodExecutionInstanceRef'
          - type: 'null'
        modifiedAt:
          format: datetime
          type: string
        parameterVersion:
          $ref: '#/components/schemas/ProcedureParameterVersionRef'
        plateWellAssociations:
          items:
            $ref: '#/components/schemas/ProcedureParameterValueLinkedPlateWell'
          type: array
        value:
          type: object
      type: object
    ProcedureParameterVersionRef:
      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
  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