Benchling Procedure Flowchart Config 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 Flowchart Config Version API
  version: 2.0.0
  description: 'Represents a snapshot of a procedure''s flowchart configuration at a specific point in time. The

    flowchart defines the structure of a procedure as a directed graph, where nodes represent method

    steps (see `nodes` and `ProcedureMethodDefinitionVersion`) and edges define the execution order

    and dependencies between them (see `edges` and `ProcedureEdge`). This type is accessible from

    `Procedure` (via `latestProcedureFlowchartConfigVersion` and

    `publishedProcedureFlowchartConfigVersion`), `ProcedureRun`, and `ProcedureRunPlan` to provide a

    read-only view of the flowchart structure for execution and planning purposes.


    ## Product mapping


    - In the Benchling UI, this is the **flowchart version users are viewing** when they open the

    procedure graph for a procedure.

    - `nodes` correspond to unit operations (`ProcedureMethodDefinitionVersion`) and `edges` correspond to

    graph connections between those unit operations.'
servers:
- url: /api/v3
security:
- oAuth: []
- basicApiKeyAuth: []
tags:
- description: 'Represents a snapshot of a procedure''s flowchart configuration at a specific point in time. The

    flowchart defines the structure of a procedure as a directed graph, where nodes represent method

    steps (see `nodes` and `ProcedureMethodDefinitionVersion`) and edges define the execution order

    and dependencies between them (see `edges` and `ProcedureEdge`). This type is accessible from

    `Procedure` (via `latestProcedureFlowchartConfigVersion` and

    `publishedProcedureFlowchartConfigVersion`), `ProcedureRun`, and `ProcedureRunPlan` to provide a

    read-only view of the flowchart structure for execution and planning purposes.


    ## Product mapping


    - In the Benchling UI, this is the **flowchart version users are viewing** when they open the

    procedure graph for a procedure.

    - `nodes` correspond to unit operations (`ProcedureMethodDefinitionVersion`) and `edges` correspond to

    graph connections between those unit operations.'
  name: ProcedureFlowchartConfigVersion
  x-bnch-organization: Benchling
  x-displayName: Procedure Flowchart Config Version
paths:
  /procedure-flowchart-config-version/items:
    get:
      description: List ProcedureFlowchartConfigVersion items.
      operationId: ProcedureFlowchartConfigVersion.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/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $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/ProcedureFlowchartConfigVersionPaginatedList'
          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 ProcedureFlowchartConfigVersion items
      tags:
      - ProcedureFlowchartConfigVersion
  /procedure-flowchart-config-version/{procedure_flowchart_config_version_id}:
    get:
      description: Get a single ProcedureFlowchartConfigVersion by ID.
      operationId: ProcedureFlowchartConfigVersion.Get
      parameters:
      - description: ID of the ProcedureFlowchartConfigVersion.
        in: path
        name: procedure_flowchart_config_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/ProcedureFlowchartConfigVersion'
          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 ProcedureFlowchartConfigVersion by ID
      tags:
      - ProcedureFlowchartConfigVersion
  /procedure-flowchart-config-version/{procedure_flowchart_config_version_id}/nodes/items:
    get:
      description: List ProcedureMethodDefinitionVersion items.
      operationId: ProcedureFlowchartConfigVersion.nodes.List
      parameters:
      - description: ID of the ProcedureFlowchartConfigVersion.
        in: path
        name: procedure_flowchart_config_version_id
        required: true
        schema:
          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/ProcedureMethodDefinitionVersionUnpaginatedList'
          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 ProcedureMethodDefinitionVersion items
      tags:
      - ProcedureFlowchartConfigVersion
components:
  schemas:
    ProcedureParameterVersionRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureMethodDefinitionVersionUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureMethodDefinitionVersion'
          type: array
      type: object
    ProcedureParameterPlannedValueRef:
      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
    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
    ProcedureStepDefinitionVersionRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureEquipmentSetting:
      description: 'Configures equipment usage within a method, linking a parameter definition

        (`ProcedureParameterVersion`) with its planned values. Equipment settings specify

        instruments or devices required to perform the method step.'
      properties:
        __typename:
          type: string
        values:
          items:
            $ref: '#/components/schemas/ProcedureParameterPlannedValueRef'
          type: array
        version:
          $ref: '#/components/schemas/ProcedureParameterVersionRef'
      type: object
    ProcedureRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureFlowchartConfigVersionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureFlowchartConfigVersion'
          type: array
        nextToken:
          type:
          - string
          - 'null'
      type: object
    ProcedureDataParameterSetting:
      description: 'Configures a data parameter within a method, linking a parameter definition

        (`ProcedureParameterVersion`) with its planned values. Data parameters capture experimental

        measurements or observations during procedure execution.'
      properties:
        __typename:
          type: string
        values:
          items:
            $ref: '#/components/schemas/ProcedureParameterPlannedValueRef'
          type: array
        version:
          $ref: '#/components/schemas/ProcedureParameterVersionRef'
      type: object
    ProcedureMaterialOutputSetting:
      description: 'Configures a material output within a method, linking to a parameter definition

        (`ProcedureParameterVersion`). Material outputs specify products or intermediates

        produced by the method step that can flow to subsequent methods via material edges.'
      properties:
        __typename:
          type: string
        version:
          $ref: '#/components/schemas/ProcedureParameterVersionRef'
      type: object
    ProcedureFlowchartConfigVersion:
      description: "Represents a snapshot of a procedure's flowchart configuration at a specific point in time. The\nflowchart defines the structure of a procedure as a directed graph, where nodes represent method\nsteps (see `nodes` and `ProcedureMethodDefinitionVersion`) and edges define the execution order\nand dependencies between them (see `edges` and `ProcedureEdge`). This type is accessible from\n`Procedure` (via `latestProcedureFlowchartConfigVersion` and\n`publishedProcedureFlowchartConfigVersion`), `ProcedureRun`, and `ProcedureRunPlan` to provide a\nread-only view of the flowchart structure for execution and planning purposes.\n\n## Product mapping\n\n- In the Benchling UI, this is the **flowchart version users are viewing** when they open the\n  procedure graph for a procedure.\n- `nodes` correspond to unit operations (`ProcedureMethodDefinitionVersion`) and `edges` correspond to\n  graph connections between those unit operations."
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type: string
        edges:
          items:
            $ref: '#/components/schemas/ProcedureEdge'
          type: array
        id:
          type: string
        nodes:
          format: uri
          type: string
        procedure:
          $ref: '#/components/schemas/ProcedureRef'
      type: object
    ProcedureEdge:
      description: 'A directed connection between two nodes in a procedure flowchart. The edge''s type (see

        `ProcedureEdgeType`) determines what `sourceId` and `targetId` reference: for METHOD_EDGE,

        they are method definition version IDs; for MATERIAL_EDGE, they are material version IDs.

        Edges define the structure and flow of a procedure''s execution graph.'
      properties:
        __typename:
          type: string
        sourceId:
          type: string
        targetId:
          type: string
        type:
          enum:
          - METHOD_EDGE
          - MATERIAL_EDGE
          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
    ProcedureStepGroup:
      description: 'Groups procedure steps by their execution phase within a method. Each method contains

        multiple step groups (see `ProcedureStepGroupType`), and each group contains an ordered

        list of steps (see `steps` and `ProcedureStepDefinitionVersion`) to be executed in sequence.'
      properties:
        __typename:
          type: string
        group:
          enum:
          - PRE_RUN
          - RUN
          - POST_RUN
          type: string
        steps:
          items:
            $ref: '#/components/schemas/ProcedureStepDefinitionVersionRef'
          type: array
      type: object
    ProcedureMaterialInputSetting:
      description: 'Configures a material input within a method, linking a parameter definition

        (`ProcedureParameterVersion`) with its planned values. Material inputs specify reagents,

        samples, or other substances consumed by the method step.'
      properties:
        __typename:
          type: string
        values:
          items:
            $ref: '#/components/schemas/ProcedureParameterPlannedValueRef'
          type: array
        version:
          $ref: '#/components/schemas/ProcedureParameterVersionRef'
      type: object
    ProcedureMethodDefinitionVersion:
      description: "A versioned method within a procedure flowchart. Methods are the building blocks of\nprocedures, representing discrete experimental operations that scientists perform. Each\nmethod contains step groups (see `stepGroups` and `ProcedureStepGroup`) organized by\nexecution phase, along with parameter settings for data collection (`dataParameterSettings`),\nmaterial inputs (`materialInputSettings`), material outputs (`materialOutputSettings`), and\nequipment (`equipmentSettings`). Methods appear as nodes in the procedure flowchart (see\n`ProcedureFlowchartConfigVersion`) and are connected by edges that define execution\norder and material flow.\n\n## Product mapping\n\n- In the Benchling product experience, this maps to a **method, or unit operation** in the procedure graph.\n- This type is the versioned template/configuration shape; runtime execution state is captured by\n  `ProcedureMethodExecutionInstance`."
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type: string
        dataParameterSettings:
          items:
            $ref: '#/components/schemas/ProcedureDataParameterSetting'
          type: array
        description:
          type: string
        equipmentSettings:
          items:
            $ref: '#/components/schemas/ProcedureEquipmentSetting'
          type: array
        id:
          type: string
        materialInputSettings:
          items:
            $ref: '#/components/schemas/ProcedureMaterialInputSetting'
          type: array
        materialOutputSettings:
          items:
            $ref: '#/components/schemas/ProcedureMaterialOutputSetting'
          type: array
        name:
          type: string
        nodeId:
          type: string
        stepGroups:
          items:
            $ref: '#/components/schemas/ProcedureStepGroup'
          type: array
      type: object
  responses:
    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
    InternalServerError:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
      description: Internal Server Error
  parameters:
    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
    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
    pageSize:
      description: Number of results to return. Defaults to 50, maximum of 100.
      in: query
      name: pageSize
      schema:
        type: integer
    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