Benchling Procedure Run Condition API

openapi: 3.2.0
info:
  title: Benchling Procedure Run Condition API
  version: 2.0.0
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  description: 'Operations tagged ProcedureRunCondition 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: 'A ProcedureRunCondition represents a configuration of the methods of a Procedure that is being

    executed within a ProcedureRun.


    The values associated with the ProcedureRunCondition are not exposed on the ProcedureRunCondition itself,

    but instead can be found by traversing:


    ProcedureRunCondition

    -> ProcedureRunConditionReplicate (pick any, since every replicate uses the same set of values)

    -> ProcedureMethodExecutionInstance (join all, since each method has its own set of values)

    -> ProcedureMethodDefinitionVersion

    -> ProcedureParameterValueSet


    ## Product mapping


    - In Benchling experiment setup, this maps to a **condition** (for example, "Condition 1").

    - A condition captures one configuration of the run, while repeated executions of that condition

    are represented by `ProcedureRunConditionReplicate`.'
  name: ProcedureRunCondition
  x-bnch-organization: Benchling
  x-displayName: Procedure Run Condition
paths:
  /procedure-run-condition/items:
    get:
      description: List ProcedureRunCondition items.
      operationId: ProcedureRunCondition.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/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/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/procedureRun.eq'
      - $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/ProcedureRunConditionPaginatedList'
          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 ProcedureRunCondition items
      tags:
      - ProcedureRunCondition
    servers:
    - url: /api/v3
  /procedure-run-condition/{procedure_run_condition_id}:
    get:
      description: Get a single ProcedureRunCondition by ID.
      operationId: ProcedureRunCondition.Get
      parameters:
      - description: ID of the ProcedureRunCondition.
        in: path
        name: procedure_run_condition_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/ProcedureRunCondition'
          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 ProcedureRunCondition by ID
      tags:
      - ProcedureRunCondition
    servers:
    - url: /api/v3
  /procedure-run-condition/{procedure_run_condition_id}/procedure-run-condition-replicates/items:
    get:
      description: List ProcedureRunConditionReplicate items.
      operationId: ProcedureRunCondition.procedureRunConditionReplicates.List
      parameters:
      - description: ID of the ProcedureRunCondition.
        in: path
        name: procedure_run_condition_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/archived.anyOf'
      - 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/ProcedureRunConditionReplicateUnpaginatedList'
          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 ProcedureRunConditionReplicate items
      tags:
      - ProcedureRunCondition
    servers:
    - url: /api/v3
components:
  schemas:
    ProcedureRunConditionReplicateUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureRunConditionReplicate'
          type: array
      type: object
    ProcedureRunCondition:
      description: "A ProcedureRunCondition represents a configuration of the methods of a Procedure that is being\nexecuted within a ProcedureRun.\n\nThe values associated with the ProcedureRunCondition are not exposed on the ProcedureRunCondition itself,\nbut instead can be found by traversing:\n\n    ProcedureRunCondition\n    -> ProcedureRunConditionReplicate   (pick any, since every replicate uses the same set of values)\n    -> ProcedureMethodExecutionInstance (join all, since each method has its own set of values)\n    -> ProcedureMethodDefinitionVersion\n    -> ProcedureParameterValueSet\n\n## Product mapping\n\n- In Benchling experiment setup, this maps to a **condition** (for example, \"Condition 1\").\n- A condition captures one configuration of the run, while repeated executions of that condition\n  are represented by `ProcedureRunConditionReplicate`."
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type: string
        description:
          description: The user-defined description of the condition.
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          description: 'The user-defined name of the condition. In M1, this is non-user-configurable and instead auto-generated,

            e.g. "Condition 1", "Condition 2", etc.'
          type: string
        procedureRun:
          $ref: '#/components/schemas/ProcedureRunRef'
          description: The ProcedureRun that this condition is a part of.
        procedureRunConditionReplicates:
          description: 'The replicates of this condition, each representing an execution of a Procedure with the same configuration.

            The number of replicates is chosen by the user while designing their experiment, but must be at least 1.'
          format: uri
          type: string
      type: object
    ProcedureRunConditionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureRunCondition'
          type: array
        nextToken:
          type:
          - string
          - 'null'
      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
    ProcedureRunRef:
      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
    ProcedureRunConditionRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureRunConditionReplicate:
      description: "A replicate of a `ProcedureRunCondition`, representing one execution of a condition's configuration.\nScientists often run the same experimental condition multiple times to obtain statistically\nsignificant results—each repetition is a replicate. The `replicateNumber` provides a one-indexed\nidentifier within the parent condition (e.g., replicate 1, 2, 3). Each replicate contains its own\nset of `ProcedureMethodExecutionInstance` objects that track actual execution data. Links to a\n`WorkflowTask` that serves as the root task for workflow orchestration. The archivable fields\nsupport marking replicates as archived when no longer needed, with lineage tracking through\n`archivableParent` and `archivableChildren`.\n\n## Product mapping\n\n- In Benchling experiment setup, this maps to a specific **replicate row/instance** within a\n  condition.\n- `replicateNumber` corresponds to the user-visible replicate index for that condition."
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        procedureRunCondition:
          $ref: '#/components/schemas/ProcedureRunConditionRef'
        replicateNumber:
          description: A one-indexed number that uniquely identifies this replicate within its parent ProcedureRunCondition.
          type: integer
      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
    ProcedureRunCondition_2:
      description: "A ProcedureRunCondition represents a configuration of the methods of a Procedure that is being\nexecuted within a ProcedureRun.\n\nThe values associated with the ProcedureRunCondition are not exposed on the ProcedureRunCondition itself,\nbut instead can be found by traversing:\n\n    ProcedureRunCondition\n    -> ProcedureRunConditionReplicate   (pick any, since every replicate uses the same set of values)\n    -> ProcedureMethodExecutionInstance (join all, since each method has its own set of values)\n    -> ProcedureMethodDefinitionVersion\n    -> ProcedureParameterValueSet"
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type: string
        description:
          description: The user-defined description of the condition.
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          description: 'The user-defined name of the condition. In M1, this is non-user-configurable and instead auto-generated,

            e.g. "Condition 1", "Condition 2", etc.'
          type: string
        procedureRun:
          $ref: '#/components/schemas/ProcedureRunRef'
          description: The ProcedureRun that this condition is a part of.
        procedureRunConditionReplicates:
          description: 'The replicates of this condition, each representing an execution of a Procedure with the same configuration.

            The number of replicates is chosen by the user while designing their experiment, but must be at least 1.'
          format: uri
          type: string
      type: object
    ProcedureRunConditionPaginatedList_2:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureRunCondition_2'
          type: array
        nextToken:
          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
    ProcedureRunConditionReplicate_2:
      description: 'A replicate of a `ProcedureRunCondition`, representing one execution of a condition''s configuration.

        Scientists often run the same experimental condition multiple times to obtain statistically

        significant results—each repetition is a replicate. The `replicateNumber` provides a one-indexed

        identifier within the parent condition (e.g., replicate 1, 2, 3). Each replicate contains its own

        set of `ProcedureMethodExecutionInstance` objects that track actual execution data. Links to a

        `WorkflowTask` that serves as the root task for workflow orchestration. The archivable fields

        support marking replicates as archived when no longer needed, with lineage tracking through

        `archivableParent` and `archivableChildren`.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        procedureRunCondition:
          $ref: '#/components/schemas/ProcedureRunConditionRef'
        replicateNumber:
          description: A one-indexed number that uniquely identifies this replicate within its parent ProcedureRunCondition.
          type: integer
      type: object
  responses:
    InternalServerError:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
      description: Internal Server Error
    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
    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
    TooManyRequests_2:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError_2'
      description: Too Many Requests
  parameters:
    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
    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.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
    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
    archived.anyOf:
      description: If true, returns archived items. If false, returns unarchived items. If both true and false, returns archived and unarchived items. Comma-separated list.
      explode: false
      in: query
      name: archived.anyOf
      schema:
        items:
          type: boolean
        maxItems: 2
        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
    procedureRun.eq:
      description: ID of a procedure run. Restricts results to only those that are part of the specified procedure run.
      in: query
      name: procedureRun.eq
      schema:
        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
    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