components:
  parameters:
    action.anyOf:
      description: Restricts results to audit logs matching any of the specified action
        display names (e.g. 'Updated name', 'Created'). Comma-separated list.
      explode: false
      in: query
      name: action.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    aminoAcids.anyOf:
      description: Restricts results to those whose sequence exactly matches any of
        the specified amino acid sequences (case-insensitive). Comma-separated list.
      explode: false
      in: query
      name: aminoAcids.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    archiveReason.anyOf:
      description: Restricts items to those with any of the specified archive reasons.
        Use "NOT_ARCHIVED" to filter for unarchived items. Use "ANY_ARCHIVED" to filter
        for archived items regardless of reason. Use "ANY_ARCHIVED_OR_NOT_ARCHIVED"
        to return items for both archived and unarchived. Comma-separated list.
      explode: false
      in: query
      name: archiveReason.anyOf
      schema:
        items:
          type: string
        maxItems: 10
        type: array
    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
    authors.anyOf:
      description: Restricts results to those whose author matches any of the specified
        user or author IDs. Comma-separated list.
      explode: false
      in: query
      name: authors.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    barcode.anyOf:
      description: Restricts results to those matching any of the specified barcodes.
        Fails and reports any invalid barcodes. Comma-separated list.
      explode: false
      in: query
      name: barcode.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    bases.anyOf:
      description: Restricts results to those whose sequence exactly matches any of
        the specified DNA base sequences (case-insensitive, accounting for circular
        and reverse complement). Comma-separated list.
      explode: false
      in: query
      name: bases.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    collaboratorId.anyOf:
      description: Restricts results to collaborations for any of the specified collaborator
        IDs. Comma-separated list.
      explode: false
      in: query
      name: collaboratorId.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.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
    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
    entry.anyOf:
      description: Restricts results to those in entries matching any of the specified
        entry IDs. Comma-separated list.
      explode: false
      in: query
      name: entry.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    entry.eq:
      description: Single entry ID. Restricts results to those in the specified entry.
      in: query
      name: entry.eq
      schema:
        type: string
    featureLibrary.eq:
      description: ID of a Feature Library.
      in: query
      name: featureLibrary.eq
      schema:
        type: string
    fieldset.anyOf:
      description: Restricts results to those whose schema implements any of the specified
        fieldset API IDs (custom schema interfaces). Comma-separated list.
      explode: false
      in: query
      name: fieldset.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    groupId.eq:
      description: Restricts results to memberships of the specified group ID.
      in: query
      name: groupId.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
    item.anyOf:
      description: Restricts results to only those associated with any of the specified
        item IDs. Comma-separated list.
      explode: false
      in: query
      name: item.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    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
    memberId.eq:
      description: Restricts results to memberships for the specified member (principal)
        ID.
      in: query
      name: memberId.eq
      schema:
        type: string
    mentionedIn.anyOf:
      description: Restricts results to items mentioned in entries matching any of
        the specified entry IDs. Comma-separated list.
      explode: false
      in: query
      name: mentionedIn.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    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
    model.anyOf:
      description: Restricts results to prediction batches using any of the specified
        model names. Comma-separated list.
      explode: false
      in: query
      name: model.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        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
    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
    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
    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
    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
    nextToken:
      description: Token for pagination
      in: query
      name: nextToken
      schema:
        type: string
    objectId.anyOf:
      description: Retrieves audit logs for the specified object API IDs. Comma-separated
        list.
      explode: false
      in: query
      name: objectId.anyOf
      schema:
        items:
          type: string
        maxItems: 10
        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
    pageSize:
      description: Number of results to return. Defaults to 50, maximum of 100.
      in: query
      name: pageSize
      schema:
        type: integer
    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
    parent.eq:
      description: ID of a folder. Restricts results to its direct children.
      in: query
      name: parent.eq
      schema:
        type: string
    parentStorage.eq:
      description: ID of a location. Restricts results to those located in the specified
        inventory.
      in: query
      name: parentStorage.eq
      schema:
        type: string
    predictionBatch.eq:
      description: ID of a Prediction Batch. Returns prediction jobs belonging to
        the specified batch.
      in: query
      name: predictionBatch.eq
      schema:
        type: string
    procedureParameter.eq:
      description: ID of a procedure parameter. Restricts results to children of the
        specified parameter.
      in: query
      name: procedureParameter.eq
      schema:
        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
    procedureRunCondition.eq:
      description: ID of a procedure run condition. Restricts results to only those
        that are part of the specified procedure run condition.
      in: query
      name: procedureRunCondition.eq
      schema:
        type: string
    procedureRunConditionReplicate.anyOf:
      description: Restricts results to only those that are part of procedure run
        condition-replicates matching any of the specified procedure run condition-replicate
        IDs. Comma-separated list.
      explode: false
      in: query
      name: procedureRunConditionReplicate.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    project.eq:
      description: ID of a project. Restricts results to those in the project.
      in: query
      name: project.eq
      schema:
        type: string
    proteinFullHistory.eq:
      description: ID of the Protein that owns the version.
      in: query
      name: proteinFullHistory.eq
      schema:
        type: string
    proteinHistory.eq:
      description: ID of the Protein that owns the version.
      in: query
      name: proteinHistory.eq
      schema:
        type: string
    reasonCode.anyOf:
      description: Restricts results to audit logs with any of the specified reason
        codes. Comma-separated list.
      explode: false
      in: query
      name: reasonCode.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    registry.eq:
      description: ID of a registry. Restricts results to those registered in this
        registry. Specifying "null" returns unregistered items.
      in: query
      name: registry.eq
      schema:
        type: string
    resourceId.anyOf:
      description: Restricts results to collaborations on any of the specified resource
        IDs. Comma-separated list.
      explode: false
      in: query
      name: resourceId.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        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
    review.eq:
      description: ID of a Review.
      in: query
      name: review.eq
      schema:
        type: string
    reviewId.anyOf:
      description: Restricts results to review changes for any of the specified Review
        API IDs. Comma-separated list.
      explode: false
      in: query
      name: reviewId.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    reviewProcess.eq:
      description: ID of a ReviewProcess.
      in: query
      name: reviewProcess.eq
      schema:
        type: string
    reviewableId.anyOf:
      description: Restricts results to review changes for items with any of the specified
        reviewable item IDs (e.g. entry IDs like etr_...). Comma-separated list.
      explode: false
      in: query
      name: reviewableId.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    schema.anyOf:
      description: Restricts results to those that match any of the specified schema
        IDs. Use only one `schema` filter arg at a time. Comma-separated list.
      explode: false
      in: query
      name: schema.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    schema.eq:
      description: Single schema ID. Restricts results to those that match the specified
        schema exactly. Use only one `schema` filter arg at a time.
      in: query
      name: schema.eq
      schema:
        type: string
    sequenceIds.anyOf:
      description: Restricts results to Nucleotide Alignments owned by any of the
        specified sequence IDs (i.e. sequences used as the template in a Template
        Alignment or created as the consensus sequence from a Consensus Alignment).
        Fails and reports any invalid IDs. Comma-separated list.
      explode: false
      in: query
      name: sequenceIds.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    study.anyOf:
      description: Restricts results to those associated with any of the specified
        study IDs. Comma-separated list.
      explode: false
      in: query
      name: study.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    study.eq:
      description: ID of a study. Restricts results to only those that are part of
        the specified study.
      in: query
      name: study.eq
      schema:
        type: string
    systemCategory.anyOf:
      description: Restricts results to those whose schema implements any of the specified
        system category API IDs (non-exclusive static schema interfaces). Comma-separated
        list.
      explode: false
      in: query
      name: systemCategory.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    templateProcedureFlowchartVersion.anyOf:
      description: Restricts results to only those created from template procedure
        flowchart versions matching any of the specified template procedure flowchart
        version IDs. Comma-separated list.
      explode: false
      in: query
      name: templateProcedureFlowchartVersion.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    templateProcedureMethodVersion.eq:
      description: ID of a procedure method definition version. Restricts results
        to only those that have the specified template procedure method version.
      in: query
      name: templateProcedureMethodVersion.eq
      schema:
        type: string
    userId.anyOf:
      description: Restricts results to those associated with any of the specified
        user API IDs. Comma-separated list.
      explode: false
      in: query
      name: userId.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
    worksheet.anyOf:
      description: Restricts results to only those executed in worksheets matching
        any of the specified worksheet IDs. Comma-separated list.
      explode: false
      in: query
      name: worksheet.anyOf
      schema:
        items:
          type: string
        maxItems: 100
        type: array
  responses:
    BadRequest:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Bad Request
    Conflict:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Conflict
    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
    NotFound:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Not Found
    PaymentRequired:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Payment Required
    TooManyRequests:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/GeneralError'
      description: Too Many Requests
  schemas:
    AaAnnotation:
      description: 'Represents an annotated region on an amino acid sequence (AaSequence).
        Annotations mark

        functional domains, binding sites, post-translational modifications, engineered
        mutations,

        or other biologically significant features. Each annotation defines a start
        and end

        position (0-based, exclusive end), a name, optional type classification, display
        color,

        and descriptive notes. Annotations appear as visual overlays on the sequence
        viewer.'
      properties:
        __typename:
          type: string
        aaSequence:
          $ref: '#/components/schemas/AaSequenceRef'
          description: AA sequence the annotation belongs to.
        color:
          description: Hex color when displaying the annotation.
          type: string
        end:
          description: 0-based exclusive end index.
          type: integer
        id:
          description: ID of the annotation.
          type: string
        name:
          description: Name of the annotation.
          type: string
        notes:
          description: Text notes on the annotation.
          type: string
        start:
          description: 0-based inclusive start index.
          type: integer
        type:
          description: Feature type of the annotation.
          type:
          - 'null'
          - string
      type: object
    AaAnnotationInput:
      additionalProperties: false
      properties:
        color:
          type: string
        end:
          type: integer
        name:
          type: string
        notes:
          type: string
        start:
          type: integer
        type:
          type: string
      required:
      - name
      - end
      - start
      type: object
    AaAnnotationInputUpdate:
      additionalProperties: false
      properties:
        annotationId:
          type: string
        color:
          type: string
        end:
          type: integer
        name:
          type: string
        notes:
          type: string
        start:
          type: integer
        type:
          type: string
      required:
      - name
      - end
      - start
      type: object
    AaChainConfigurationInput:
      additionalProperties: false
      properties:
        systemCategoryId:
          enum:
          - ssi_aachain
          type: string
      required:
      - systemCategoryId
      type: object
    AaDomainConfigurationInput:
      additionalProperties: false
      properties:
        systemCategoryId:
          enum:
          - ssi_aadomain
          type: string
      required:
      - systemCategoryId
      type: object
    AaPairConfigurationInput:
      additionalProperties: false
      properties:
        systemCategoryId:
          enum:
          - ssi_aapair
          type: string
      required:
      - systemCategoryId
      type: object
    AaPartLinkFieldDefinition:
      description: A schema field definition for linking to AA parts.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent AA part. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    AaSequence:
      allOf:
      - $ref: '#/components/schemas/IAaSequence'
      - description: 'Represents an amino acid sequence in Benchling''s molecular
          biology platform. An AaSequence stores the

          one-letter amino acid code string along with annotations marking functional
          regions, domains, or other

          features of interest. `AaSequence`s can be registered in the Registry with
          a unique entityRegistryId,

          organized in folders, and linked via schema fields to other entities. The
          annotations array contains

          `AaAnnotation` objects for features like signal peptides, binding domains,
          or engineered mutations.

          Parts (see `AaPart`) indicate regions matching other registered `AaSequence`s.'
        properties:
          __typename:
            type: string
          authors:
            oneOf:
            - format: uri
              type: string
            - type: 'null'
          creator:
            oneOf:
            - $ref: '#/components/schemas/PrincipalRef'
            - type: 'null'
          schemaFields:
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    AaSequenceLinkFieldDefinition:
      description: A schema field definition for linking to AA sequences.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent AA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinition:
          oneOf:
          - $ref: '#/components/schemas/AaSequenceSchemaRef'
          - type: 'null'
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    AaSequencePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/AaSequence'
          type: array
        nextToken:
          type: string
      type: object
    AaSequenceRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    AaSequenceSchema:
      description: Defines the structure, field definitions, and configuration options
        for AA sequences.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/Constraint'
          - type: 'null'
        containableType:
          enum:
          - NONE
          - ENTITY
          - BATCH
          type: string
        containerNameTemplate:
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplate'
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          type: string
        fieldDefinitions:
          description: "The field definitions configured on this schema. Supported
            types include:\n\n- Legacy: `BaseFieldDefinition`, `SchemaLinkFieldDefinition`\n\n-
            Primitive: `TextFieldDefinition`, `LongTextFieldDefinition`, `IntegerFieldDefinition`,\n
            \ `FloatFieldDefinition`, `BooleanFieldDefinition`, `DateFieldDefinition`,
            `DateTimeFieldDefinition`\n\n- Dropdown: `DropdownLinkFieldDefinition`\n\n-
            Blob: `BlobLinkFieldDefinition`\n\n- Entity links: `AnyEntityLinkFieldDefinition`,
            `CustomEntityLinkFieldDefinition`,\n  `AaSequenceLinkFieldDefinition`,
            `DnaSequenceLinkFieldDefinition`, `MixtureLinkFieldDefinition`,\n  `MoleculeLinkFieldDefinition`,
            `AntibodyLinkFieldDefinition`, `OligoConjugateLinkFieldDefinition`,\n
            \ `OligoDuplexLinkFieldDefinition`, `DnaOligoLinkFieldDefinition`, `RnaOligoLinkFieldDefinition`\n\n-
            Storage: `StorableLinkFieldDefinition`\n\n- Assay links: `AssayRequestLinkFieldDefinition`,
            `AssayResultLinkFieldDefinition`,\n  `AssayRunLinkFieldDefinition`\n\n-
            Part links: `AaPartLinkFieldDefinition`\n\n`JsonFieldDefinition` is not
            supported."
          format: uri
          type: string
        fieldsets:
          format: uri
          type: string
        iconId:
          enum:
          - ANTIBODY
          - BASIC_FOLDER_ITEM
          - LINEAR
          - PROTEIN
          type: string
        id:
          type: string
        includeRegistryIdInChips:
          type: boolean
        itemIdPrefix:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        nameTemplate:
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplate'
          - type: 'null'
        organization:
          $ref: '#/components/schemas/OrganizationRef'
        showResidues:
          description: Controls whether amino acid residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfiguration'
          type: array
        systemName:
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    AaSequenceSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/AaSequenceSchema'
          type: array
        nextToken:
          type: string
      type: object
    AaSequenceSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    AaSequenceSchemaSetFieldDefinitionsInput:
      additionalProperties: false
      properties:
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaPartLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAaPartLinkFieldDefinitionInput'
          type: array
      required:
      - fieldDefinitions
      type: object
    AaSubElementConfigurationInput:
      additionalProperties: false
      properties:
        systemCategoryId:
          enum:
          - ssi_aasubelement
          type: string
      required:
      - systemCategoryId
      type: object
    AddColumnTransform:
      description: 'A data transform that adds a new column to the file with values
        resolved via a

        LookupConfig. Used in input file generation to enrich data with looked-up
        values.'
      properties:
        __typename:
          type: string
        transformationProperties:
          description: Additional parameters for this transform
          oneOf:
          - $ref: '#/components/schemas/AddColumnTransformationProperties'
          - type: 'null'
        type:
          description: The type of this transform (ADD_COLUMN)
          enum:
          - ADD_COLUMN
          - ARITHMETIC
          - CUSTOM
          - DUPLICATE
          - EXTRA_HEADERS
          - EXTRA_FOOTERS
          - FILTER
          - FIND_REPLACE
          - MERGE
          - MELT
          - PLATE_SHAPE
          - PIVOT
          - REMOVE_QUOTES
          - SPLIT
          - null
          type:
          - 'null'
          - string
      type: object
    AddColumnTransformationProperties:
      description: Properties for an ADD_COLUMN transform, specifying the name of
        the new column to add.
      properties:
        __typename:
          type: string
        column:
          description: The name of the column to be added
          type:
          - 'null'
          - string
      type: object
    AlignedNucleotideSequence:
      description: 'Represents a single sequence row within a NucleotideAlignment.
        Each AlignedNucleotideSequence contains

        the aligned bases (including gap characters for insertions/deletions), the
        original

        NucleotideSequence if it exists in the registry, and quality trim boundaries.
        The trimStart

        and trimEnd fields define the high-quality region of the sequence used for
        alignment and

        pairwise identity calculations—bases outside this region are typically low-quality
        ends

        from Sanger sequencing reads. For template alignments, pairwiseIdentity indicates
        the

        fraction of matching bases within the trimmed region compared to the reference.'
      properties:
        __typename:
          type: string
        bases:
          description: The bases of the Aligned Nucleotide Sequence, including gaps.
          type: string
        createdAt:
          description: DateTime the parent Alignment was created.
          format: datetime
          type: string
        id:
          description: The ID of the Aligned Nucleotide Sequence.
          type: string
        name:
          description: The name of the Aligned Nucleotide Sequence.
          type: string
        nucleotideAlignment:
          $ref: '#/components/schemas/NucleotideAlignmentRef'
          description: The Nucleotide Alignment the Aligned Nucleotide Sequence belongs
            to.
        sequence:
          description: The Nucleotide Sequence the Aligned Nucleotide Sequence is
            associated with.
          oneOf:
          - $ref: '#/components/schemas/NucleotideSequenceRef'
          - type: 'null'
        trimEnd:
          description: 'End index of the region of bases included in the alignment.
            Bases outside the trimmed region are excluded

            from the alignment and from the pairwise identity calculation. The trim
            region is determined by trace data,

            but can also be edited manually.'
          type: integer
        trimStart:
          description: 'Start index of the region of bases included in the alignment.
            Bases outside the trimmed region are excluded

            from the alignment and from the pairwise identity calculation. The trim
            region is determined by trace data,

            but can also be edited manually.'
          type: integer
      type: object
    AlignedNucleotideSequencePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/AlignedNucleotideSequence'
          type: array
        nextToken:
          type: string
      type: object
    AlignmentFileInput:
      additionalProperties: false
      properties:
        data:
          type: string
        name:
          type: string
        sequenceId:
          type: string
      type: object
    Analysis:
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        description:
          type:
          - 'null'
          - string
        folder:
          $ref: '#/components/schemas/FolderRef'
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        statusCode:
          enum:
          - AI_PROPOSED
          - BLOCKED
          - FAILED
          - HALTED
          - RUNNING
          - SUCCEEDED
          - WAITING
          type: string
        steps:
          format: uri
          type: string
        webUrl:
          type: string
      type: object
    AnalysisPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Analysis'
          type: array
        nextToken:
          type: string
      type: object
    AnalysisRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    AnalysisTemplate:
      description: 'A reusable pipeline configuration that can be instantiated to
        create new Analysis objects.

        AnalysisTemplates define a complete data processing workflow with PipelineSteps
        (see `steps`)

        that can be parameterized through configVariables (see `AnalysisTemplateVariable`)
        and

        dataFrameVariables (see `AnalysisTemplateDataFrameVariable`). When users apply
        a template,

        they provide values for these variables, generating a new Analysis with the
        template''s

        pipeline structure populated with actual data. Templates are organized within

        TemplateCollections and support versioning through the createdFromPipeline
        reference.'
      properties:
        __typename:
          type: string
        archivableChildren:
          oneOf:
          - format: uri
            type: string
          - type: 'null'
        archivableParent:
          oneOf:
          - $ref: '#/components/schemas/TemplateCollectionRef'
          - type: 'null'
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        configVariables:
          format: uri
          type: string
        createdAt:
          format: datetime
          type: string
        createdFromPipeline:
          oneOf:
          - $ref: '#/components/schemas/AnalysisRef'
          - type: 'null'
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        dataFrameVariables:
          format: uri
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        steps:
          format: uri
          type: string
        templateCollection:
          $ref: '#/components/schemas/TemplateCollectionRef'
        webUrl:
          type:
          - 'null'
          - string
      type: object
    AnalysisTemplateDataFrameVariable:
      description: 'Defines a data frame placeholder within an AnalysisTemplate that
        users must provide when

        applying the template. Each variable specifies which PipelineStep input (replaceStep,

        replaceStepData, replaceStepDataIndex) will receive the user-provided data
        frame. The

        replaceDataFrameColumnsSpec field defines the expected column structure that
        the provided

        data must match. When users apply an analysis template to create an Analysis,
        they provide

        bindings that map actual data frames to these variables, populating the template''s
        pipeline

        with real data.'
      properties:
        __typename:
          type: string
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        description:
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        replaceDataFrameColumnsSpec:
          items:
            $ref: '#/components/schemas/DataFrameColumn'
          type: array
        replaceStep:
          $ref: '#/components/schemas/PipelineStepRef'
        replaceStepData:
          $ref: '#/components/schemas/PipelineStepDataRef'
        replaceStepDataIndex:
          type: integer
        template:
          $ref: '#/components/schemas/AnalysisTemplateRef'
      type: object
    AnalysisTemplateDataFrameVariablePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/AnalysisTemplateDataFrameVariable'
          type: array
        nextToken:
          type: string
      type: object
    AnalysisTemplateDataFrameVariableUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/AnalysisTemplateDataFrameVariable'
          type: array
      type: object
    AnalysisTemplatePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/AnalysisTemplate'
          type: array
        nextToken:
          type: string
      type: object
    AnalysisTemplateRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    AnalysisTemplateVariable:
      description: 'Defines a configuration parameter within an AnalysisTemplate that
        users can customize when

        applying the template. Unlike AnalysisTemplateDataFrameVariable 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 PipelineStep.'
      properties:
        __typename:
          type: string
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        configVariableKey:
          type: string
        createdAt:
          format: datetime
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        pipelineStep:
          $ref: '#/components/schemas/PipelineStepRef'
        template:
          $ref: '#/components/schemas/AnalysisTemplateRef'
        variableTypeConfigSpec:
          type: object
      type: object
    AnalysisTemplateVariablePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/AnalysisTemplateVariable'
          type: array
        nextToken:
          type: string
      type: object
    AnalysisTemplateVariableUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/AnalysisTemplateVariable'
          type: array
      type: object
    AntibodyLinkFieldDefinition:
      description: A schema field definition for linking to Antibodies.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent Antibody. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    AntibodySchemaSetFieldDefinitionsInput:
      additionalProperties: false
      properties:
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateSystemCategoryLinkFieldDefinitionInput'
          type: array
      required:
      - fieldDefinitions
      type: object
    AntigenConfigurationInput:
      additionalProperties: false
      properties:
        systemCategoryId:
          enum:
          - ssi_antigen
          type: string
      required:
      - systemCategoryId
      type: object
    AnyEntityLinkFieldDefinition:
      description: A schema field definition for linking to any entity type.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    AnyType: {}
    AppCanvas:
      description: 'Represents a Benchling App canvas, an embedded UI surface that
        apps use to render custom

        interactive content within notebook entries, entry templates, assay runs,
        or app homepages.

        Each canvas belongs to a single app and contains a list of UI blocks that
        define the

        canvas layout and interactivity.'
      properties:
        __typename:
          type: string
        app:
          $ref: '#/components/schemas/IAppInstallationRef'
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        blocks:
          items:
            anyOf:
            - $ref: '#/components/schemas/ButtonUiBlock'
            - $ref: '#/components/schemas/ChipUiBlock'
            - $ref: '#/components/schemas/DropdownUiBlock'
            - $ref: '#/components/schemas/DropdownMultiValueUiBlock'
            - $ref: '#/components/schemas/FileUploadUiBlock'
            - $ref: '#/components/schemas/MarkdownUiBlock'
            - $ref: '#/components/schemas/SearchInputUiBlock'
            - $ref: '#/components/schemas/SearchInputMultiValueUiBlock'
            - $ref: '#/components/schemas/SectionUiBlock'
            - $ref: '#/components/schemas/SelectorInputUiBlock'
            - $ref: '#/components/schemas/SelectorInputMultiValueUiBlock'
            - $ref: '#/components/schemas/TextInputUiBlock'
            - $ref: '#/components/schemas/TableUiBlock'
            description: Union of ButtonUiBlock, ChipUiBlock, DropdownUiBlock, DropdownMultiValueUiBlock,
              FileUploadUiBlock, MarkdownUiBlock, SearchInputUiBlock, SearchInputMultiValueUiBlock,
              SectionUiBlock, SelectorInputUiBlock, SelectorInputMultiValueUiBlock,
              TextInputUiBlock, TableUiBlock
            discriminator:
              propertyName: __typename
          type: array
        createdAt:
          format: datetime
          type: string
        data:
          type:
          - 'null'
          - string
        enabled:
          type: boolean
        featureId:
          type:
          - 'null'
          - string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        resourceId:
          type: string
        sessionId:
          type:
          - 'null'
          - string
      type: object
    AppCanvasUiBlockInput:
      allOf:
      - properties:
          type:
            enum:
            - BUTTON
            - CHIP
            - DROPDOWN
            - DROPDOWN_MULTIVALUE
            - FILE_UPLOAD
            - MARKDOWN
            - SEARCH_INPUT
            - SEARCH_INPUT_MULTIVALUE
            - SECTION
            - SELECTOR_INPUT
            - SELECTOR_INPUT_MULTIVALUE
            - TABLE
            - TEXT_INPUT
            type: string
        required:
        - type
      - oneOf:
        - $ref: '#/components/schemas/ButtonUiBlockInput'
        - $ref: '#/components/schemas/ChipUiBlockInput'
        - $ref: '#/components/schemas/DropdownMultiValueUiBlockInput'
        - $ref: '#/components/schemas/DropdownUiBlockInput'
        - $ref: '#/components/schemas/FileUploadUiBlockInput'
        - $ref: '#/components/schemas/MarkdownUiBlockInput'
        - $ref: '#/components/schemas/SearchInputMultiValueUiBlockInput'
        - $ref: '#/components/schemas/SearchInputUiBlockInput'
        - $ref: '#/components/schemas/SectionUiBlockInput'
        - $ref: '#/components/schemas/SelectorInputMultiValueUiBlockInput'
        - $ref: '#/components/schemas/SelectorInputUiBlockInput'
        - $ref: '#/components/schemas/TableUiBlockInput'
        - $ref: '#/components/schemas/TextInputUiBlockInput'
      discriminator:
        propertyName: type
      type: object
    AppConfigDropdownOption:
      description: Defines an option within a dropdown-type app configuration field.
      properties:
        __typename:
          type: string
        description:
          type:
          - 'null'
          - string
        name:
          type: string
        requiredConfig:
          type:
          - 'null'
          - boolean
      type: object
    AppConfigFieldDefinition:
      description: 'Defines a field within an app configuration that references schema
        fields. Specifies the

        field name, type, whether it accepts multiple values, and whether it is required.'
      properties:
        __typename:
          type: string
        description:
          type:
          - 'null'
          - string
        isMulti:
          description: Whether the field must be multi-valued — null means either
            true or false is acceptable.
          type:
          - 'null'
          - boolean
        isRequired:
          description: Whether the field must be required — null means either true
            or false is acceptable.
          type:
          - 'null'
          - boolean
        name:
          type: string
        requiredConfig:
          type:
          - 'null'
          - boolean
        type:
          description: Type constraint for the field — null means any type is acceptable.
          enum:
          - DNA_SEQUENCE_LINK
          - AA_SEQUENCE_LINK
          - CUSTOM_ENTITY_LINK
          - ENTITY_LINK
          - MIXTURE_LINK
          - MOLECULE_LINK
          - DROPDOWN
          - PART_LINK
          - AA_PART_LINK
          - TRANSLATION_LINK
          - BLOB_LINK
          - TEXT
          - LONG_TEXT
          - BATCH_LINK
          - STORAGE_LINK
          - ENTRY_LINK
          - ASSAY_REQUEST_LINK
          - ASSAY_RESULT_LINK
          - ASSAY_RUN_LINK
          - BOOLEAN
          - FLOAT
          - INTEGER
          - DATETIME
          - DATE
          - JSON
          - null
          type:
          - 'null'
          - string
      type: object
    AppConfigOption:
      description: 'Defines a configuration option in an app''s configuration schema.
        Each option has a name,

        optional description, and a configSpec defining the expected value type and
        validation.'
      properties:
        __typename:
          type: string
        configSpec:
          anyOf:
          - $ref: '#/components/schemas/BooleanAppConfigSpec'
          - $ref: '#/components/schemas/IntegerAppConfigSpec'
          - $ref: '#/components/schemas/FloatAppConfigSpec'
          - $ref: '#/components/schemas/TextAppConfigSpec'
          - $ref: '#/components/schemas/SecureTextAppConfigSpec'
          - $ref: '#/components/schemas/DateAppConfigSpec'
          - $ref: '#/components/schemas/DateTimeAppConfigSpec'
          - $ref: '#/components/schemas/JsonAppConfigSpec'
          - $ref: '#/components/schemas/ArrayAppConfigSpec'
          - $ref: '#/components/schemas/DropdownAppConfigSpec'
          - $ref: '#/components/schemas/EntitySchemaAppConfigSpec'
          - $ref: '#/components/schemas/WorkflowTaskSchemaAppConfigSpec'
          - $ref: '#/components/schemas/SchemaAppConfigSpec'
          - $ref: '#/components/schemas/ResourceAppConfigSpec'
          description: Union of BooleanAppConfigSpec, IntegerAppConfigSpec, FloatAppConfigSpec,
            TextAppConfigSpec, SecureTextAppConfigSpec, DateAppConfigSpec, DateTimeAppConfigSpec,
            JsonAppConfigSpec, ArrayAppConfigSpec, DropdownAppConfigSpec, EntitySchemaAppConfigSpec,
            WorkflowTaskSchemaAppConfigSpec, SchemaAppConfigSpec, ResourceAppConfigSpec
          discriminator:
            propertyName: __typename
        description:
          type:
          - 'null'
          - string
        name:
          type: string
      type: object
    AppConfigValue:
      description: 'Represents a configured value for a Benchling App on a specific
        tenant. Each config

        value has a path identifying its location in the configuration hierarchy and
        valueData

        containing the actual value. Config values are defined by the app''s configuration
        spec

        and set during installation or later configuration.'
      properties:
        __typename:
          type: string
        createdAt:
          description: DateTime at which the config value was created.
          format: datetime
          type:
          - 'null'
          - string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        modifiedAt:
          description: DateTime at which the config value was last modified.
          format: datetime
          type:
          - 'null'
          - string
        path:
          items:
            type: string
          type: array
        valueData:
          description: Union of BooleanAppConfigValue, IntegerAppConfigValue, FloatAppConfigValue,
            TextAppConfigValue, SecureTextAppConfigValue, DateAppConfigValue, DateTimeAppConfigValue,
            JsonAppConfigValue, ArrayElementAppConfigValue, EntitySchemaAppConfigValue,
            ResourceAppConfigValue
          oneOf:
          - anyOf:
            - $ref: '#/components/schemas/BooleanAppConfigValue'
            - $ref: '#/components/schemas/IntegerAppConfigValue'
            - $ref: '#/components/schemas/FloatAppConfigValue'
            - $ref: '#/components/schemas/TextAppConfigValue'
            - $ref: '#/components/schemas/SecureTextAppConfigValue'
            - $ref: '#/components/schemas/DateAppConfigValue'
            - $ref: '#/components/schemas/DateTimeAppConfigValue'
            - $ref: '#/components/schemas/JsonAppConfigValue'
            - $ref: '#/components/schemas/ArrayElementAppConfigValue'
            - $ref: '#/components/schemas/EntitySchemaAppConfigValue'
            - $ref: '#/components/schemas/ResourceAppConfigValue'
            discriminator:
              propertyName: __typename
          - type: 'null'
      type: object
    AppConfigValuePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/AppConfigValue'
          type: array
        nextToken:
          type: string
      type: object
    AppConfigValueUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/AppConfigValue'
          type: array
      type: object
    AppConfigWorkflowTaskSchemaOutput:
      description: Defines the output field structure for a workflow task schema configuration.
      properties:
        __typename:
          type: string
        fieldDefinitions:
          oneOf:
          - items:
              $ref: '#/components/schemas/AppConfigFieldDefinition'
            type: array
          - type: 'null'
      type: object
    AppHomepageFeatureSpec:
      description: 'Defines a homepage feature for a Benchling App, providing a dedicated
        landing page within

        the Benchling application for the app''s functionality.'
      properties:
        __typename:
          type: string
        featureId:
          type: string
        name:
          type: string
      type: object
    AppInstallation:
      description: 'Represents an installed Benchling App on a tenant, created from
        an `AppDefinitionVersion`.

        App installations store tenant-specific configuration values and feature bindings.
        As a

        Principal, app installations can be attributed as actors for API operations
        and auditing.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        configurationValues:
          format: uri
          type: string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        creator:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        featureValues:
          items:
            $ref: '#/components/schemas/AssayRunFeatureValue'
          type: array
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
      type: object
    AppInstallationPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/AppInstallation'
          type: array
        nextToken:
          type: string
      type: object
    AppMessageSubscription:
      description: 'Represents an app''s subscription to a specific event type, specifying
        the event type and

        how notifications should be delivered (see `DeliveryMethod`).'
      properties:
        __typename:
          type: string
        deliveryMethod:
          enum:
          - WEBHOOK
          - WEBHOOK_INTERNAL
          type: string
        type:
          enum:
          - V2_BETA_CANVAS_CREATED
          - V2_CANVAS_CREATED
          - V2_CANVAS_USER_INTERACTED
          - V2_CANVAS_INITIALIZED
          - V2_APP_ACTIVATE_REQUESTED
          - V2_APP_DEACTIVATED
          - V2_APP_INSTALLED
          - V2_BETA_APP_CONFIGURATION_UPDATED
          - V2_ASSAY_RUN_CREATED
          - V2_ASSAY_RUN_UPDATED_FIELDS
          - V2_ENTITY_REGISTERED
          - V2_ENTRY_CREATED
          - V2_ENTRY_UPDATED_FIELDS
          - V2_ENTRY_UPDATED_REVIEW_RECORD
          - V2_REQUEST_CREATED
          - V2_REQUEST_UPDATED_FIELDS
          - V2_REQUEST_UPDATED_STATUS
          - V2_WORKFLOW_TASK_GROUP_CREATED
          - V2_WORKFLOW_TASK_GROUP_MAPPING_COMPLETED
          - V2_WORKFLOW_TASK_GROUP_UPDATED_WATCHERS
          - V2_WORKFLOW_TASK_CREATED
          - V2_WORKFLOW_TASK_UPDATED_ASSIGNEE
          - V2_WORKFLOW_TASK_UPDATED_SCHEDULED_ON
          - V2_WORKFLOW_TASK_UPDATED_STATUS
          - V2_WORKFLOW_TASK_UPDATED_FIELDS
          - V2_WORKFLOW_OUTPUT_CREATED
          - V2_WORKFLOW_OUTPUT_UPDATED_FIELDS
          - V2_AUTOMATION_FILE_TRANSFORM_UPDATED_STATUS_RUNNING
          - V2_AUTOMATION_FILE_TRANSFORM_UPDATED_STATUS_PENDING
          - V2_AUTOMATION_FILE_TRANSFORM_UPDATED_STATUS_SUCCEEDED
          - V2_AUTOMATION_FILE_TRANSFORM_UPDATED_STATUS_FAILED
          - V3_CUSTOM_ENTITY_CREATED
          - V3_CUSTOM_ENTITY_UPDATED
          - V3_DNA_OLIGO_CREATED
          - V3_DNA_OLIGO_UPDATED
          - V3_DNA_SEQUENCE_CREATED
          - V3_DNA_SEQUENCE_UPDATED
          - V3_ENTRY_CREATED
          - V3_PROJECT_CREATED
          - V3_PROJECT_UPDATED
          - V3_RNA_OLIGO_CREATED
          - V3_RNA_OLIGO_UPDATED
          - V3_RNA_SEQUENCE_CREATED
          - V3_RNA_SEQUENCE_UPDATED
          - V3_RUN_CREATED
          type: string
      type: object
    AppSession:
      description: 'Represents a running or completed session for a Benchling App.
        App sessions track

        long-running app operations, providing status updates and user-facing messages.

        Each session belongs to a single app installation and progresses through a
        lifecycle

        from RUNNING to a terminal status. Sessions are updated by appending new versions,

        which can change the status, timeout, and displayed messages.'
      properties:
        __typename:
          type: string
        app:
          $ref: '#/components/schemas/IAppInstallationRef'
          description: The Benchling App installation that owns this session.
        createdAt:
          format: datetime
          type: string
        id:
          type: string
        messages:
          description: The messages currently displayed to the user, from the most
            recent session version.
          items:
            $ref: '#/components/schemas/AppSessionMessage'
          type: array
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        status:
          description: The current lifecycle status of this session, derived from
            the most recent version.
          enum:
          - RUNNING
          - SUCCEEDED
          - FAILED
          - COMPLETED_WITH_WARNINGS
          - TIMEOUT
          type: string
        timeoutSeconds:
          description: 'Maximum duration in seconds before the session times out automatically.
            Once the session''s

            age exceeds this value and the session has not been finalized, its status
            becomes TIMEOUT.'
          type: integer
      type: object
    AppSessionMessage:
      description: 'A status message displayed to the user within an app session.
        Messages convey progress,

        warnings, results, or errors from a running Benchling App. Each message has
        a textual

        content body and a visual style. Message content may contain inline chip references
        to

        Benchling objects using the `{id:<api_id>}` syntax.'
      properties:
        __typename:
          type: string
        content:
          description: The text body of the message, which may contain chip references
            like `{id:ent_abc123}`.
          type: string
        style:
          description: The visual style applied to this message.
          enum:
          - NONE
          - INFO
          - WARNING
          - SUCCESS
          - ERROR
          type: string
      type: object
    AppSessionMessageInput:
      additionalProperties: false
      properties:
        content:
          type: string
        style:
          description: Visual style for this message. Defaults to NONE if omitted.
          enum:
          - NONE
          - INFO
          - WARNING
          - SUCCESS
          - ERROR
          type: string
      required:
      - content
      type: object
    AppSessionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/AppSession'
          type: array
        nextToken:
          type: string
      type: object
    ArithmeticTransform:
      description: 'A data transform that performs arithmetic operations between two
        variables (columns

        or constants) and writes the result to a new column.'
      properties:
        __typename:
          type: string
        transformationProperties:
          description: Additional parameters for this transform
          oneOf:
          - $ref: '#/components/schemas/ArithmeticTransformationProperties'
          - type: 'null'
        type:
          description: The type of this transform (ARITHMETIC)
          enum:
          - ADD_COLUMN
          - ARITHMETIC
          - CUSTOM
          - DUPLICATE
          - EXTRA_HEADERS
          - EXTRA_FOOTERS
          - FILTER
          - FIND_REPLACE
          - MERGE
          - MELT
          - PLATE_SHAPE
          - PIVOT
          - REMOVE_QUOTES
          - SPLIT
          - null
          type:
          - 'null'
          - string
      type: object
    ArithmeticTransformColumnVariable:
      description: 'A variable in an arithmetic transform that references values from
        a named column in

        the file.'
      properties:
        __typename:
          type: string
        type:
          description: COLUMN
          enum:
          - CONSTANT
          - COLUMN
          - null
          type:
          - 'null'
          - string
        value:
          description: Name of a column that contains values on which to perform the
            arithmetic operation
          type:
          - 'null'
          - string
      type: object
    ArithmeticTransformConstantVariable:
      description: A variable in an arithmetic transform that holds a fixed numeric
        constant.
      properties:
        __typename:
          type: string
        type:
          description: CONSTANT
          enum:
          - CONSTANT
          - COLUMN
          - null
          type:
          - 'null'
          - string
        value:
          description: A constant value on which to perform the arithmetic operation
          type:
          - 'null'
          - number
      type: object
    ArithmeticTransformationProperties:
      description: 'Properties for an ARITHMETIC transform, defining the operator,
        operands, and the

        name of the result column. Supports addition, subtraction, multiplication,
        and

        division between column values and/or constants.'
      properties:
        __typename:
          type: string
        firstVariable:
          description: First operand for the arithmetic operation
          oneOf:
          - anyOf:
            - $ref: '#/components/schemas/ArithmeticTransformColumnVariable'
            - $ref: '#/components/schemas/ArithmeticTransformConstantVariable'
            discriminator:
              propertyName: __typename
          - type: 'null'
        newColumnName:
          description: Name of the column that will contain the results of the arithmetic
            operation
          type:
          - 'null'
          - string
        operator:
          description: 'The arithmetic operation to perform: +, -, *, or /'
          type:
          - 'null'
          - string
        secondVariable:
          description: Second operand for the arithmetic operation
          oneOf:
          - anyOf:
            - $ref: '#/components/schemas/ArithmeticTransformColumnVariable'
            - $ref: '#/components/schemas/ArithmeticTransformConstantVariable'
            discriminator:
              propertyName: __typename
          - type: 'null'
      type: object
    ArrayAppConfigOption:
      description: 'A config option nested within an array-type app configuration
        field. Structurally

        identical to AppConfigOption — it has a name and a configSpec — but its configSpec

        accepts the same config types as the top level except nested arrays (see

        ArrayAppConfigElementSpec).'
      properties:
        __typename:
          type: string
        configSpec:
          anyOf:
          - $ref: '#/components/schemas/BooleanAppConfigSpec'
          - $ref: '#/components/schemas/IntegerAppConfigSpec'
          - $ref: '#/components/schemas/FloatAppConfigSpec'
          - $ref: '#/components/schemas/TextAppConfigSpec'
          - $ref: '#/components/schemas/SecureTextAppConfigSpec'
          - $ref: '#/components/schemas/DateAppConfigSpec'
          - $ref: '#/components/schemas/DateTimeAppConfigSpec'
          - $ref: '#/components/schemas/JsonAppConfigSpec'
          - $ref: '#/components/schemas/DropdownAppConfigSpec'
          - $ref: '#/components/schemas/EntitySchemaAppConfigSpec'
          - $ref: '#/components/schemas/WorkflowTaskSchemaAppConfigSpec'
          - $ref: '#/components/schemas/SchemaAppConfigSpec'
          - $ref: '#/components/schemas/ResourceAppConfigSpec'
          description: Union of BooleanAppConfigSpec, IntegerAppConfigSpec, FloatAppConfigSpec,
            TextAppConfigSpec, SecureTextAppConfigSpec, DateAppConfigSpec, DateTimeAppConfigSpec,
            JsonAppConfigSpec, DropdownAppConfigSpec, EntitySchemaAppConfigSpec, WorkflowTaskSchemaAppConfigSpec,
            SchemaAppConfigSpec, ResourceAppConfigSpec
          discriminator:
            propertyName: __typename
        description:
          type:
          - 'null'
          - string
        name:
          type: string
      type: object
    ArrayAppConfigSpec:
      description: Specifies that an app configuration field should accept an array
        of values.
      properties:
        __typename:
          type: string
        elementDefinition:
          description: Defines the named config options allowed within this array
            and their type constraints.
          items:
            $ref: '#/components/schemas/ArrayAppConfigOption'
          type: array
        maxElements:
          description: Maximum number of elements allowed in the array (1-500); null
            means no maximum.
          type:
          - 'null'
          - integer
        minElements:
          description: Minimum number of elements allowed in the array (0-500); null
            means no minimum.
          type:
          - 'null'
          - integer
        requiredConfig:
          type:
          - 'null'
          - boolean
      type: object
    ArrayCellEvaluationValue:
      description: An array evaluation value containing multiple cell evaluation values.
      properties:
        __typename:
          type: string
        value:
          items:
            anyOf:
            - $ref: '#/components/schemas/StringCellEvaluationValue'
            - $ref: '#/components/schemas/NumberCellEvaluationValue'
            - $ref: '#/components/schemas/BooleanCellEvaluationValue'
            - $ref: '#/components/schemas/DateCellEvaluationValue'
            - $ref: '#/components/schemas/DateTimeCellEvaluationValue'
            - $ref: '#/components/schemas/EntityLinkCellEvaluationValue'
            - $ref: '#/components/schemas/ArrayCellEvaluationValue'
            - $ref: '#/components/schemas/UnsupportedCellEvaluationValue'
            description: Union of StringCellEvaluationValue, NumberCellEvaluationValue,
              BooleanCellEvaluationValue, DateCellEvaluationValue, DateTimeCellEvaluationValue,
              EntityLinkCellEvaluationValue, ArrayCellEvaluationValue, UnsupportedCellEvaluationValue
            discriminator:
              propertyName: __typename
          type: array
      type: object
    ArrayElementAppConfigValue:
      description: Stores an element value within an array-type app configuration.
      properties:
        __typename:
          type: string
        value:
          type:
          - 'null'
          - string
      type: object
    ArrayValue:
      description: A type that represents a list of BenchlingValues, used for multi-value
        cells (e.g. alias columns).
      properties:
        __typename:
          type: string
        value:
          items:
            anyOf:
            - $ref: '#/components/schemas/BooleanValue'
            - $ref: '#/components/schemas/DateTimeValue'
            - $ref: '#/components/schemas/DateValue'
            - $ref: '#/components/schemas/DecimalValue'
            - $ref: '#/components/schemas/IntegerValue'
            - $ref: '#/components/schemas/JsonValue'
            - $ref: '#/components/schemas/ObjectLinkValue'
            - $ref: '#/components/schemas/ObjectLinkListValue'
            - $ref: '#/components/schemas/TextAndUrlValue'
            - $ref: '#/components/schemas/TextValue'
            description: Union of BooleanValue, DateTimeValue, DateValue, DecimalValue,
              IntegerValue, JsonValue, ObjectLinkValue, ObjectLinkListValue, TextAndUrlValue,
              TextValue
            discriminator:
              propertyName: __typename
          type: array
      type: object
    AssayRequestLinkFieldDefinition:
      description: A schema field definition for linking to assay requests.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    AssayResultLinkFieldDefinition:
      description: A schema field definition for linking to assay results.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        linkDefinition:
          oneOf:
          - $ref: '#/components/schemas/ResultSchemaRef'
          - type: 'null'
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    AssayRunFeatureSpec:
      description: 'Defines an assay run feature for a Benchling App, allowing the
        app to process or generate

        lab automation run data.'
      properties:
        __typename:
          type: string
        featureId:
          type: string
        name:
          type: string
      type: object
    AssayRunFeatureValue:
      description: 'Links an app''s assay run feature to a specific resource (typically
        a run schema) on a

        tenant. The featureId identifies the feature from the app definition, and
        resourceId

        references the tenant-specific resource it''s bound to.'
      properties:
        __typename:
          type: string
        featureId:
          description: Developer-specified feature ID as defined in the app manifest
            / app definition version
          type: string
        resourceId:
          type:
          - 'null'
          - string
      type: object
    AssayRunLinkFieldDefinition:
      description: A schema field definition for linking to assay runs.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        linkDefinition:
          oneOf:
          - $ref: '#/components/schemas/RunSchemaRef'
          - type: 'null'
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    Assembly:
      description: 'Represents a molecular cloning assembly that combines multiple
        DNA fragments into

        complete constructs. Assemblies model the process of joining fragment sequences

        (such as genes, promoters, and terminators) using methods like Gibson Assembly,

        Golden Gate, or restriction enzyme-based cloning. The assembly tracks the
        input

        fragments and resulting construct sequences, enabling design-to-experiment
        traceability.

        Assemblies can be organized in folders and support archiving when no longer
        needed.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          description: DateTime the Assembly was created
          format: datetime
          type: string
        creator:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        folder:
          description: Folder that contains the Assembly.
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        id:
          description: Id of the Assembly
          type: string
        modifiedAt:
          description: DateTime the Assembly was last modified
          format: datetime
          type: string
        name:
          description: Name of the Assembly
          type: string
      type: object
    AssemblyPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Assembly'
          type: array
        nextToken:
          type: string
      type: object
    AsyncTaskLink:
      properties:
        pollingUri:
          format: uri
          type: string
        taskId:
          type: string
      type: object
    AttachmentContentInput:
      additionalProperties: false
      properties:
        contentType:
          enum:
          - attachment
          type: string
        displayWidth:
          type:
          - 'null'
          - integer
        indentation:
          type: integer
        scratchFileId:
          type: string
      required:
      - contentType
      - scratchFileId
      type: object
    AttachmentDocumentContent:
      description: 'Represents an external file attachment embedded in notebook or
        document content.

        Attachments expose file metadata, a temporary download URL, and indentation
        within the document.'
      properties:
        __typename:
          type: string
        customWidth:
          description: The custom width in pixels, if set, or null.
          type:
          - 'null'
          - integer
        downloadUrl:
          description: A presigned URL to download the attachment.
          type: string
        downloadUrlExpiresAt:
          description: When the download URL expires (ISO 8601 datetime).
          format: datetime
          type: string
        externalFileId:
          description: The external file ID for this attachment (e.g., efl_XXXXX).
          type: string
        filename:
          description: The filename of the attachment.
          type: string
        indentation:
          type: integer
        size:
          description: The file size in bytes.
          type: integer
      type: object
    AuditLog:
      description: Represents a single entry in an object's audit log. Each entry
        captures what changed, who made the change, and contextual information about
        the affected object hierarchy.
      properties:
        __typename:
          type: string
        action:
          type: string
        clientId:
          type:
          - 'null'
          - string
        clientName:
          type:
          - 'null'
          - string
        createdAt:
          format: datetime
          type: string
        delegateUser:
          type:
          - 'null'
          - string
        electronicallySigned:
          type: string
        eventDescription:
          type: string
        id:
          type: string
        ipAddress:
          type: string
        item:
          type: string
        itemDeveloperId:
          type: string
        itemId:
          type:
          - 'null'
          - string
        itemType:
          type: string
        newValue:
          type:
          - 'null'
          - string
        oldValue:
          type:
          - 'null'
          - string
        parentItem1:
          type:
          - 'null'
          - string
        parentItem1DeveloperId:
          type:
          - 'null'
          - string
        parentItem1Type:
          type:
          - 'null'
          - string
        parentItem2:
          type:
          - 'null'
          - string
        parentItem2DeveloperId:
          type:
          - 'null'
          - string
        parentItem2Type:
          type:
          - 'null'
          - string
        parentItem3:
          type:
          - 'null'
          - string
        parentItem3DeveloperId:
          type:
          - 'null'
          - string
        parentItem3Type:
          type:
          - 'null'
          - string
        reasonCode:
          type:
          - 'null'
          - string
        reasonComment:
          type:
          - 'null'
          - string
        transactionId:
          type: string
        userHandle:
          type: string
        userId:
          type: string
        userName:
          type: string
      type: object
    AuditLogExportInput:
      additionalProperties: false
      properties:
        format:
          enum:
          - CSV
          - PDF
          type: string
        objectId:
          type: string
      required:
      - objectId
      - format
      type: object
    AuditLogExportOutput:
      description: Output of the audit log export custom method. Contains a presigned
        download URL for the exported file.
      properties:
        downloadUrl:
          type: string
      type: object
    AuditLogPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/AuditLog'
          type: array
        nextToken:
          type: string
      type: object
    AutomationInputFileConfig:
      description: 'Defines the configuration for generating input files that drive
        laboratory automation

        instruments. An AutomationInputFileConfig specifies how to pull sample data
        from

        Benchling (via rowConfigs with LookupConfig), which columns to include, how
        to format

        and sort the data, and where to send the generated files (via destinations).
        The

        configuration supports data transformations (see AutomationTransformConfig)
        and

        customizable file naming through nameTemplateParts. Input generators using
        this config

        (see AutomationInputGenerator) produce files in the specified format (delimiter
        and

        fileExtension) that can be consumed by liquid handlers, plate readers, and
        other

        automated lab equipment.'
      properties:
        __typename:
          type: string
        columns:
          description: List of columns for input files generated by this configuration
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        delimiter:
          description: Delimiter to use in input files generated by this configuration
          type:
          - 'null'
          - string
        destinations:
          description: Configurations for destinations for input files generated by
            this configuration
          oneOf:
          - items:
              $ref: '#/components/schemas/AutomationInputFileDestinationInfo'
            type: array
          - type: 'null'
        fileExtension:
          description: Extension to use for input files generated by this configuration
          type:
          - 'null'
          - string
        id:
          type: string
        isHidden:
          description: Whether input generators for this configuration are hidden
            in the notebook
          type:
          - 'null'
          - boolean
        name:
          description: The name of the AutomationInputFileConfig
          type:
          - 'null'
          - string
        nameTemplateParts:
          description: Configuration for naming input files generated by this configuration
          oneOf:
          - items:
              $ref: '#/components/schemas/AutomationInputFileNamePart'
            type: array
          - type: 'null'
        rowConfigs:
          description: Configurations for the rows of the input files generated by
            this configuration
          oneOf:
          - items:
              $ref: '#/components/schemas/AutomationInputFileRowConfig'
            type: array
          - type: 'null'
        sortColumns:
          description: List of columns to sort input files generated by this configuration
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        transforms:
          description: Configurations for transforms for input files generated by
            this configuration
          oneOf:
          - items:
              $ref: '#/components/schemas/AutomationTransformConfig'
            type: array
          - type: 'null'
      type: object
    AutomationInputFileConfigUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/AutomationInputFileConfig'
          type: array
      type: object
    AutomationInputFileDestinationInfo:
      description: 'Describes a destination target for rows in a lab automation input
        file. Contains a

        lookup configuration for resolving destination samples and an optional display
        name.'
      properties:
        __typename:
          type: string
        name:
          description: Name for this DestinationInfo
          type:
          - 'null'
          - string
      type: object
    AutomationInputFileNamePart:
      description: 'Represents a single segment of a generated input file name. Parts
        are concatenated

        in order to build the file name and can contain static text, date/time stamps,
        run

        identifiers, or field values from the associated run schema.'
      properties:
        __typename:
          type: string
        field:
          description: Run schema field for the name of the input file (only present
            for FIELD type)
          oneOf:
          - $ref: '#/components/schemas/SchemaFieldDefinitionRef'
          - type: 'null'
        text:
          description: Text value for the name of the input file (only present for
            TEXT type)
          type:
          - 'null'
          - string
        type:
          description: The type of this name template part
          enum:
          - CREATED_AT_DATE
          - CREATED_AT_TIME
          - DISPLAY_NAME
          - FIELD
          - RUN_API_ID
          - RUN_ID
          - RUN_SCHEMA_NAME
          - SOURCE_FILE_NAME
          - TEXT
          - null
          type:
          - 'null'
          - string
      type: object
    AutomationInputFileRowConfig:
      description: 'Configures how a set of rows is generated for a lab automation
        input file. Each row

        config specifies a data source via LookupConfig, an optional destination,
        column

        definitions, and an optional plate layout for positional mapping.'
      properties:
        __typename:
          type: string
        columns:
          description: Configuration for the columns of the input file
          oneOf:
          - items:
              $ref: '#/components/schemas/AutomationInputFileRowConfigColumn'
            type: array
          - type: 'null'
        destination:
          description: DestinationInfo for the destinations used to generate a set
            of rows of the input file
          oneOf:
          - $ref: '#/components/schemas/AutomationInputFileDestinationInfo'
          - type: 'null'
        plateLayout:
          description: PlateLayout to use when generating the input file
          oneOf:
          - $ref: '#/components/schemas/PlateLayout'
          - type: 'null'
      type: object
    AutomationInputFileRowConfigColumn:
      description: 'Defines a single column within an input file row configuration.
        Each column has a

        lookup configuration that determines the values to populate and a display
        name.'
      properties:
        __typename:
          type: string
        name:
          description: Name for this column of the input file
          type:
          - 'null'
          - string
      type: object
    AutomationOutputFileConfig:
      description: 'Defines the configuration for processing output files from laboratory
        automation

        instruments and converting them into Benchling data. An AutomationOutputFileConfig

        specifies the expected file format (columns, delimiter, locale), data transformations

        to apply before processing, and what actions to take with the data: creating
        or

        updating registered entities (entitySchemaInfo), recording assay results (resultSchemaInfo),

        or creating inventory items (inventorySchemaInfo). Output processors using
        this config

        (see AutomationOutputProcessor) parse instrument output files and execute
        the configured

        actions, enabling automated data capture from plate readers, mass spectrometers,
        and

        other lab equipment.'
      properties:
        __typename:
          type: string
        allowMissingSource:
          description: Whether to allow some source values to be missing in the output
            file to be processed
          type:
          - 'null'
          - boolean
        automationOutputFileTableType:
          description: 'Type for the notebook table produced by processing output
            files with this configuration.

            GRID for one row per box/plate, SAMPLE for one row per sample.'
          enum:
          - GRID
          - SAMPLE
          - null
          type:
          - 'null'
          - string
        columns:
          description: 'List of columns for output files to be processed by this configuration.

            Either "columns" or "namedColumnTypes", but not both, must be provided.'
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        concentrationUnits:
          description: Units with which to interpret any concentration values in output
            files processed by this configuration.
          type:
          - 'null'
          - string
        datasetNameTemplateParts:
          description: Configuration for naming output datasets generated by this
            configuration
          oneOf:
          - items:
              $ref: '#/components/schemas/AutomationInputFileNamePart'
            type: array
          - type: 'null'
        delimiter:
          description: Delimiter to use in transform files generated by this configuration
          type:
          - 'null'
          - string
        entitySchemaInfo:
          description: Configuration for registered entities created or updated when
            processing output files with this configuration.
          oneOf:
          - $ref: '#/components/schemas/AutomationOutputFileEntitySchemaInfo'
          - type: 'null'
        fileExtension:
          description: Extension to use for transform files generated by this configuration
          type:
          - 'null'
          - string
        id:
          type: string
        inventorySchemaInfo:
          description: Configuration for storage created or updated when processing
            output files with this configuration.
          oneOf:
          - $ref: '#/components/schemas/AutomationOutputFileInventorySchemaInfo'
          - type: 'null'
        isHidden:
          description: Whether output processors for this configuration are hidden
            from notebook runs.
          type:
          - 'null'
          - boolean
        name:
          description: The name of the AutomationOutputFileConfig
          type:
          - 'null'
          - string
        namedColumnTypes:
          description: 'List of columns for output files to be processed by this configuration.

            Either "columns" or "namedColumnTypes", but not both, must be provided.'
          oneOf:
          - items:
              $ref: '#/components/schemas/AutomationOutputFileNamedColumnType'
            type: array
          - type: 'null'
        quantityUnits:
          description: Units with which to interpret any volume or quantity values
            in output files processed by this configuration.
          type:
          - 'null'
          - string
        resultSchemaInfo:
          description: Configuration for results created when processing output files
            with this configuration.
          oneOf:
          - $ref: '#/components/schemas/AutomationOutputFileResultSchemaInfo'
          - type: 'null'
        spreadsheetProcessingLocale:
          description: Locale to use to interpret dates, times, and decimal values
            in output files processed with this configuration
          type:
          - 'null'
          - string
        transforms:
          description: Configuration for transforms to run before processing output
            files with this configuration.
          oneOf:
          - items:
              $ref: '#/components/schemas/AutomationTransformConfig'
            type: array
          - type: 'null'
      type: object
    AutomationOutputFileConfigUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/AutomationOutputFileConfig'
          type: array
      type: object
    AutomationOutputFileEntitySchemaInfo:
      description: 'Configuration for registering or updating entities when processing
        an automation

        output file. Specifies the entity schema, destination folder, naming strategy,
        field

        mappings, and the action to perform (create, update, or both).'
      properties:
        __typename:
          type: string
        actionType:
          description: CREATE, UPDATE, or CREATE_OR_UPDATE
          enum:
          - CREATE
          - UPDATE
          - CREATE_OR_UPDATE
          - null
          type:
          - 'null'
          - string
        fields:
          description: Configuration for schema fields of items to be registered when
            processing output files
          oneOf:
          - items:
              $ref: '#/components/schemas/AutomationOutputFileTransformationFieldInfo'
            type: array
          - type: 'null'
        folder:
          description: Folder for items registered when processing output files. If
            missing, will be entered on the run
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        namingStrategy:
          description: Naming strategy for items to be registered when processing
            output files
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          - null
          type:
          - 'null'
          - string
        schema:
          description: Entity schema of items to be registered when processing output
            files
          oneOf:
          - $ref: '#/components/schemas/EntitySchemaRef'
          - type: 'null'
        shouldReplaceExisting:
          description: Whether to replace existing items in the destination containers
            with the newly registered items
          type:
          - 'null'
          - boolean
      type: object
    AutomationOutputFileInventorySchemaInfo:
      description: 'Configuration for creating or updating inventory items (plates,
        boxes, or containers)

        when processing an automation output file. Specifies the destination schema,
        storage

        location, project context, and field mappings.'
      properties:
        __typename:
          type: string
        fields:
          description: Configuration for schema fields of inventory items to be created
            or updated when processing output files
          oneOf:
          - items:
              $ref: '#/components/schemas/AutomationOutputFileTransformationFieldInfo'
            type: array
          - type: 'null'
        location:
          description: Location for inventory items to be created when processing
            output files. If missing, will be entered on the run
          oneOf:
          - $ref: '#/components/schemas/LocationRef'
          - type: 'null'
        project:
          description: Project for inventory items to be created when processing output
            files. If missing, will be entered on the run
          oneOf:
          - $ref: '#/components/schemas/ObjectRef'
          - type: 'null'
        schema:
          description: Inventory schema for inventory items to be created when processing
            output files
          oneOf:
          - $ref: '#/components/schemas/ObjectRef'
          - type: 'null'
      type: object
    AutomationOutputFileNamedColumnType:
      description: 'Associates a column name with its data type in an automation output
        file configuration.

        Used instead of plain column name strings when the column type must be specified

        explicitly.'
      properties:
        __typename:
          type: string
        columnType:
          description: Type of a column in an output file
          type:
          - 'null'
          - string
        name:
          description: Name of a column in an output file
          type:
          - 'null'
          - string
      type: object
    AutomationOutputFileResultSchemaInfo:
      description: 'Configuration for creating assay results when processing an automation
        output file.

        Specifies the result schema and field mappings that control how file data
        is recorded

        as structured results.'
      properties:
        __typename:
          type: string
        fields:
          description: Configuration for schema fields of results to be created when
            processing output files
          oneOf:
          - items:
              $ref: '#/components/schemas/AutomationOutputFileTransformationFieldInfo'
            type: array
          - type: 'null'
        schema:
          description: Result schema of results to be created when processing output
            files
          oneOf:
          - $ref: '#/components/schemas/ResultSchemaRef'
          - type: 'null'
      type: object
    AutomationOutputFileTransformationFieldInfo:
      description: 'Maps a schema field to a data source when processing an automation
        output file.

        Specifies how to populate the field: directly from a file column, from the
        primary

        sample entity, from source container contents, or by calculating final concentration.'
      properties:
        __typename:
          type: string
        columnIndex:
          description: Index of column to use for a DIRECT field
          type:
          - 'null'
          - integer
        columnName:
          description: Name of column to use for a DIRECT field
          type:
          - 'null'
          - string
        filterSchema:
          description: Optional schema for items to be linked in a SOURCE_CONTENTS
            field
          oneOf:
          - $ref: '#/components/schemas/EntitySchemaRef'
          - type: 'null'
        schemaField:
          description: Schema field that this AutomationOutputFileTransformationFieldInfo
            tells us how to populate when processing output files
          oneOf:
          - $ref: '#/components/schemas/SchemaFieldDefinitionRef'
          - type: 'null'
        type:
          description: Type of field configuration - CALCULATE_FINAL_CONCENTRATION,
            DIRECT, PRIMARY_SAMPLE_ENTITY, or SOURCE_CONTENTS
          enum:
          - CALCULATE_FINAL_CONCENTRATION
          - DIRECT
          - PRIMARY_SAMPLE_ENTITY
          - SOURCE_CONTENTS
          - null
          type:
          - 'null'
          - string
      type: object
    AutomationTransformConfig:
      anyOf:
      - $ref: '#/components/schemas/AddColumnTransform'
      - $ref: '#/components/schemas/ArithmeticTransform'
      - $ref: '#/components/schemas/CustomTransform'
      - $ref: '#/components/schemas/DuplicateTransform'
      - $ref: '#/components/schemas/ExtraFootersTransform'
      - $ref: '#/components/schemas/ExtraHeadersTransform'
      - $ref: '#/components/schemas/FilterTransform'
      - $ref: '#/components/schemas/FindReplaceTransform'
      - $ref: '#/components/schemas/MeltTransform'
      - $ref: '#/components/schemas/MergeTransform'
      - $ref: '#/components/schemas/PivotTransform'
      - $ref: '#/components/schemas/PlateShapeTransform'
      - $ref: '#/components/schemas/RemoveQuotesTransform'
      - $ref: '#/components/schemas/SplitTransform'
      discriminator:
        propertyName: __typename
      type: object
    BarcodeInput:
      allOf:
      - properties:
          barcodeMode:
            enum:
            - SPECIFY_BARCODE
            - USE_NAME
            type: string
        required:
        - barcodeMode
      - oneOf:
        - $ref: '#/components/schemas/ExplicitBarcodeInput'
        - $ref: '#/components/schemas/UseNameAsBarcodeInput'
      discriminator:
        propertyName: barcodeMode
      type: object
    BaseCreateMessageBlockInput:
      allOf:
      - properties:
          type:
            enum:
            - text
            type: string
        required:
        - type
      - oneOf:
        - $ref: '#/components/schemas/CreateTextMessageBlockInput'
      discriminator:
        propertyName: type
      type: object
    BaseFieldDefinition:
      description: 'A basic schema field definition for primitive data types. Used
        for fields with types like TEXT,

        INTEGER, FLOAT, BOOLEAN, DATE, DATETIME, JSON, and LONG_TEXT. Each field has
        a user-facing

        `name` and a `systemName` for warehouse/API access. Fields can be archived
        when no longer needed. For fields

        that link to other objects, use `SchemaLinkFieldDefinition`; for dropdown
        selections, use

        `DropdownLinkFieldDefinition`.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          description: Determines whether multiple values are allowed
          type: boolean
        isRequired:
          description: Determines whether values must be provided
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - AA_PART_LINK
          - AA_SEQUENCE_LINK
          - ASSAY_REQUEST_LINK
          - ASSAY_RESULT_LINK
          - ASSAY_RUN_LINK
          - BATCH_LINK
          - BLOB_LINK
          - BOOLEAN
          - CUSTOM_ENTITY_LINK
          - DATE
          - DATETIME
          - DNA_SEQUENCE_LINK
          - ENTITY_LINK
          - ENTRY_LINK
          - FLOAT
          - INTEGER
          - JSON
          - LONG_TEXT
          - MIXTURE_LINK
          - MOLECULE_LINK
          - BASE_MOLECULE_LINK
          - PART_LINK
          - SAMPLE_LINK
          - DROPDOWN
          - STORAGE_LINK
          - TEXT
          - TRANSCRIPTION_LINK
          - TRANSLATION_LINK
          type: string
      type: object
    BaseSystemCategoryConfiguration:
      description: 'Default configuration for system categories that require no additional

        configuration beyond the system category identifier.'
      properties:
        __typename:
          type: string
        systemCategoryId:
          type: string
      type: object
    BenchlingItemContentInput:
      additionalProperties: false
      properties:
        contentType:
          enum:
          - benchling_item
          type: string
        indentation:
          type: integer
        itemId:
          description: API ID of the Benchling item to embed.
          type: string
      required:
      - contentType
      - itemId
      type: object
    BenchlingItemDocumentContent:
      description: Represents a Benchling item embedded in notebook or document content,
        identifying the referenced Benchling object.
      properties:
        __typename:
          type: string
        embeddedItem:
          description: 'The embedded item, resolved to its concrete `DocumentEmbeddable`
            type (e.g. `DnaSequence`,

            `CustomEntity`, `Protein`, `OligoConjugate`, `OligoDuplex`). Items that
            cannot be fetched via

            the V3 REST API (currently Protocols, Equipment, and Trial Subjects) resolve
            to

            `UnresolvableEmbeddedItem`, which exposes only the item''s id.'
          oneOf:
          - $ref: '#/components/schemas/DocumentEmbeddable'
          - type: 'null'
        indentation:
          type: integer
      type: object
    BlobLinkFieldDefinition:
      description: A schema field definition for linking to blobs (file attachments).
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    BooleanAppConfigSpec:
      description: Specifies that an app configuration field should accept a boolean
        value.
      properties:
        __typename:
          type: string
        requiredConfig:
          type:
          - 'null'
          - boolean
      type: object
    BooleanAppConfigValue:
      description: Stores a boolean value in an app configuration field.
      properties:
        __typename:
          type: string
        value:
          type:
          - 'null'
          - boolean
      type: object
    BooleanCellEvaluationValue:
      description: A boolean evaluation value.
      properties:
        __typename:
          type: string
        value:
          type: boolean
      type: object
    BooleanFieldDefinition:
      description: A boolean field definition for true/false values.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    BooleanValue:
      description: A type that represents boolean values.
      properties:
        __typename:
          type: string
        value:
          description: The boolean value.
          type: boolean
      type: object
    Box:
      allOf:
      - $ref: '#/components/schemas/IBox'
      - description: 'A Box is a grid-based storage container in Benchling''s inventory
          system, designed

          to hold multiple sample containers (tubes, vials, etc.) in an organized
          layout.

          Boxes have a defined capacity based on their schema''s height and width
          dimensions,

          and track how many positions are occupied, empty, or available. Each box
          is

          assigned a barcode for physical tracking and must be placed within a Location
          (via

          parentStorage). Boxes conform to a BoxSchema that defines their grid dimensions
          and

          which ContainerSchema their contents must use. Boxes are commonly used to
          organize

          samples in freezers, refrigerators, or other storage equipment.'
        properties:
          __typename:
            type: string
          creator:
            oneOf:
            - $ref: '#/components/schemas/PrincipalRef'
            - type: 'null'
          schemaFields:
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    BoxPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Box'
          type: array
        nextToken:
          type: string
      type: object
    BoxSchema:
      description: 'Defines the structure and constraints for a category of Boxes
        in Benchling''s inventory

        system. A BoxSchema specifies the grid dimensions (height and width) determining
        how

        many container positions the box has, and optionally links to a ContainerSchema
        that

        constrains what type of containers can be stored in boxes of this type. BoxSchemas

        support custom field definitions for capturing additional metadata about boxes.
        Each

        BoxSchema can be associated with a Registry and given a prefix for generating
        display

        IDs. Examples include "96-Well Freezer Box" or "81-Position Cryo Box".'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        containerSchema:
          oneOf:
          - $ref: '#/components/schemas/ContainerSchemaRef'
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          description: A description of the schema.
          type: string
        fieldDefinitions:
          format: uri
          type: string
        height:
          type:
          - 'null'
          - integer
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        prefix:
          type:
          - 'null'
          - string
        registry:
          oneOf:
          - $ref: '#/components/schemas/RegistryRef'
          - type: 'null'
        systemName:
          description: A unique, stable identifier for this schema used for programmatic
            access and integrations.
          type: string
        type:
          type:
          - 'null'
          - string
        width:
          type:
          - 'null'
          - integer
      type: object
    BoxSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/BoxSchema'
          type: array
        nextToken:
          type: string
      type: object
    BoxSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    BulkImport:
      example:
        fileId: scrfile_jdf8BV24kLmN
      properties:
        fileId:
          description: The API ID of the scratch file (`scrfile_XXXXXXXX`) containing
            the items to import. The referenced file must be a scratch file whose
            upload has completed successfully.
          type: string
      required:
      - fileId
      type: object
    ButtonUiBlock:
      description: A button block that triggers an app interaction when clicked.
      properties:
        __typename:
          type: string
        enabled:
          type:
          - 'null'
          - boolean
        id:
          type: string
        text:
          type: string
      type: object
    ButtonUiBlockInput:
      additionalProperties: false
      properties:
        enabled:
          type: boolean
        id:
          type: string
        text:
          type: string
        type:
          enum:
          - BUTTON
          type: string
      required:
      - type
      - id
      - text
      type: object
    CanvasFeatureSpec:
      description: 'Defines a canvas feature for a Benchling App, which provides an
        embedded UI surface within

        entries or templates. Canvases allow apps to render custom interactive content.'
      properties:
        __typename:
          type: string
        featureId:
          type: string
        locations:
          oneOf:
          - items:
              enum:
              - ENTRY
              - ENTRY_TEMPLATE
              - APP_HOME
              type: string
            type: array
          - type: 'null'
        name:
          type: string
      type: object
    CellError:
      description: 'A single error present on a table cell. `errorType` distinguishes
        evaluation failures

        (formula errors) from validation failures (schema/validation-rule violations);
        `message`

        is the human-readable description.'
      properties:
        __typename:
          type: string
        errorType:
          enum:
          - EVALUATION
          - VALIDATION
          type: string
        message:
          type: string
        type:
          description: 'Human-readable display name for the specific error (e.g. "Reference
            error", "Value error").

            Populated for evaluation errors; null for validation errors, which have
            no display type.'
          type:
          - 'null'
          - string
      type: object
    ChainLinkedSchema:
      properties:
        __typename:
          type: string
        label:
          type: string
        schemaOrInterfaceId:
          type:
          - 'null'
          - string
      type: object
    ChainLinkedSchemaInput:
      additionalProperties: false
      properties:
        label:
          description: Chain label from the protein format to map to a schema.
          type: string
        schemaOrInterfaceId:
          description: API ID of the schema or schema interface to use for the chain
            label.
          type: string
      required:
      - label
      - schemaOrInterfaceId
      type: object
    Chart:
      description: 'A Chart is a data visualization within Benchling. Charts can be
        created directly (for example, via APIs or the

        UI) or generated from other workflows. Charts store their configuration in
        a library-specific format (see

        `ChartLibrary`) along with a rasterized image for archival purposes. When
        applicable, charts may reference the

        pipeline step (see `PipelineStep`) or AI chat session (see `ChatSession`)
        they originated from as optional

        provenance links, enabling both programmatic and conversational data visualization
        workflows.'
      properties:
        __typename:
          type: string
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        id:
          type: string
        library:
          enum:
          - PLOTLY
          type: string
        libraryConfig:
          description: JSON object representing the direct input to a chart library
            on the front-end.
          type: object
        libraryVersion:
          description: 'Version of the library that the config corresponds to.


            For example, if the library uses semver, we might store "1.2.3", "1.2.3-alpha.1",
            ect.'
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        originPipelineStep:
          description: The pipeline step that this chart was created from.
          oneOf:
          - $ref: '#/components/schemas/PipelineStepRef'
          - type: 'null'
        originPipelineStepDataName:
          description: The name of the data in originPipelineStep that this chart
            was created from.
          type:
          - 'null'
          - string
        rasterConfig:
          description: "Config used to generate the rasterized image of the chart
            in relation to th library that we're using.\n\nFor example, in Plotly,
            this could be:\n```\n  {\n    width: 600\n    height: 400\n    scale:
            0.5\n    format: \"png\"\n    engine: \"kaleido\"\n  }\n```"
          type: object
        rasterDownloadUrl:
          description: 'URL to download a rasterized image of the chart.


            We store these images in perpetuity in case the library and libraryConfig
            version of the chart can no longer be rendered.'
          type: string
        rasterExternalFileId:
          type: string
      type: object
    ChartPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Chart'
          type: array
        nextToken:
          type: string
      type: object
    ChatSourceInput:
      allOf:
      - properties:
          type:
            enum:
            - mcp_server
            - public_data
            type: string
        required:
        - type
      - oneOf:
        - $ref: '#/components/schemas/McpServerChatSourceInput'
        - $ref: '#/components/schemas/PublicDataChatSourceInput'
      discriminator:
        propertyName: type
      type: object
    CheckoutRecord:
      description: 'Tracks the checkout status of an inventory item such as a Container.
        When laboratory

        samples need to be temporarily removed from storage (e.g., for an experiment),
        users

        can check them out, optionally adding a comment and assigning responsibility
        to a

        user or team (see Assignee). The record captures when the status was last
        modified.

        This enables sample tracking workflows and prevents conflicts when multiple
        users

        need access to the same samples.'
      properties:
        __typename:
          type: string
        assignee:
          description: Union of User, Team
          oneOf:
          - $ref: '#/components/schemas/ObjectRef'
          - type: 'null'
        comment:
          type:
          - 'null'
          - string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        status:
          enum:
          - AVAILABLE
          - RESERVED
          - CHECKED_OUT
          - null
          type:
          - 'null'
          - string
      type: object
    CheckoutRecordInput:
      additionalProperties: false
      properties:
        assigneeId:
          type:
          - 'null'
          - string
        comment:
          type:
          - 'null'
          - string
        status:
          enum:
          - AVAILABLE
          - RESERVED
          - CHECKED_OUT
          type: string
      required:
      - status
      type: object
    ChemSimplePolymer:
      description: 'Represents a small molecule within a complex polymer structure.
        Contains SMILES and molfile representations of

        the chemical structure, along with connections to other polymers. The entity
        field links to a corresponding

        `Molecule`. Commonly used as conjugate payloads attached to oligonucleotide
        backbones, such as lipid

        nanoparticles, fluorescent labels, or therapeutic molecules.'
      properties:
        __typename:
          type: string
        connections:
          items:
            $ref: '#/components/schemas/ComplexPolymerConnection'
          type: array
        entity:
          $ref: '#/components/schemas/MoleculeRef'
        helmReference:
          type: string
        molfile:
          type: string
        polymerType:
          type: string
        smiles:
          type: string
      type: object
    ChemicalStructureInput:
      additionalProperties: false
      properties:
        structureFormat:
          enum:
          - smiles
          - molfile
          type: string
        value:
          type: string
      required:
      - structureFormat
      - value
      type: object
    ChipUiBlock:
      description: A chip block that displays a short piece of information.
      properties:
        __typename:
          type: string
        id:
          type: string
        value:
          type: string
      type: object
    ChipUiBlockInput:
      additionalProperties: false
      properties:
        id:
          type: string
        type:
          enum:
          - CHIP
          type: string
        value:
          type: string
      required:
      - type
      - id
      - value
      type: object
    ClustalOOptionsInput:
      additionalProperties: false
      properties:
        maxGuidetreeIterations:
          description: Max guide tree iterations within combined iterations. Can be
            in the range -1 to 5 (-1 = no max).
          type: integer
        maxHmmIterations:
          description: Max HMM iterations within combined iterations. Can be in the
            range -1 to 5 (-1 = no max).
          type: integer
        mbedGuideTree:
          description: Whether mBed-like clustering guide tree should be used (faster
            to use it).
          type: boolean
        mbedIteration:
          description: Whether mBed-like clustering iteration should be used (faster
            to use it).
          type: boolean
        numCombinedIterations:
          description: Number of (combined guide-tree/HMM) iterations. Can be in the
            range 0 to 5.
          type: integer
      type: object
    CodeBlockContentInput:
      additionalProperties: false
      properties:
        contentType:
          enum:
          - code_block
          type: string
        text:
          type: string
      required:
      - contentType
      - text
      type: object
    CodeBlockDocumentContent:
      description: 'Represents a block of code or preformatted text within notebook
        or document content.

        Code blocks preserve the text content for display as a standalone code block.'
      properties:
        __typename:
          type: string
        text:
          type: string
      type: object
    CollaboratableRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    Collaboration:
      description: 'A Collaboration indicates that a Principal or Group is granted
        a Policy on a Resource.

        Some Collaborations represent Ownership, while others indicate that a Resource
        was shared with the Principal

        or Group.'
      properties:
        __typename:
          type: string
        accessPolicy:
          $ref: '#/components/schemas/PolicyRef'
        collaboratorInfo:
          anyOf:
          - $ref: '#/components/schemas/PrincipalCollaboratorInfo'
          - $ref: '#/components/schemas/GroupCollaboratorInfo'
          description: Union of PrincipalCollaboratorInfo, GroupCollaboratorInfo
          discriminator:
            propertyName: __typename
        createdAt:
          format: datetime
          type: string
        fromOwnership:
          type: boolean
        id:
          type: string
        isAuditor:
          type: boolean
        modifiedAt:
          format: datetime
          type: string
        resource:
          $ref: '#/components/schemas/CollaboratableRef'
      type: object
    CollaborationPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Collaboration'
          type: array
        nextToken:
          type: string
      type: object
    CollaborationUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Collaboration'
          type: array
      type: object
    CollaboratorReferenceInput:
      additionalProperties: false
      properties:
        collaboratorId:
          type: string
        role:
          enum:
          - MEMBER
          - ADMIN
          type: string
      required:
      - collaboratorId
      type: object
    ColumnMapping:
      additionalProperties: false
      properties:
        columnName:
          type: string
        layerName:
          type: string
        schemaFieldName:
          type: string
      required:
      - layerName
      - columnName
      - schemaFieldName
      type: object
    ComplexPolymerConnection:
      description: 'Represents a chemical bond between two polymers within a complex
        polymer structure.

        Connections can be covalent bonds (including disulfide bonds) or hydrogen
        bonds

        (for base pairing in duplexes). Each connection has source and target ConnectionSide

        endpoints defining which polymers and residues are bonded. The attachmentStyle

        indicates whether the connection was drawn graphically or specified via leaving
        groups.'
      properties:
        __typename:
          type: string
        attachmentStyle:
          description: 'The format in which the user has defined the connection (i.e.
            drawn vs leaving group style).

            Only applicable to covalent bond type connections.'
          enum:
          - LEAVING_GROUP
          - DRAWN
          - null
          type:
          - 'null'
          - string
        connectionType:
          description: The kind of chemical bond this connection represents.
          enum:
          - COVALENT_BOND
          - HYDROGEN_BOND
          type: string
        covalentBondType:
          description: 'The type of covalent bond represented by the connection (i.e.
            disulfide bond or not).

            Only applicable to covalent bond type connections.'
          enum:
          - DISULFIDE_BOND
          - null
          type:
          - 'null'
          - string
        source:
          $ref: '#/components/schemas/ConnectionSide'
          description: '''source'' and ''target'' are interchangeable - connections
            are bidirectional.'
        target:
          $ref: '#/components/schemas/ConnectionSide'
      type: object
    ComplexPolymerResolvedAttachment:
      description: 'Detailed information about a group of contiguous connections in
        a complex polymer.


        The entire chemical structure of the connection group, and any components
        inside it, is represented by a molfile.

        This allows for the representation of any bond chemistry, beyond the simple
        leaving group style supported by HELM.


        For example, suppose we have two involved connections, one between a backbone
        oligo and a linker molecule,

        and another between the linker molecule and a payload molecule.

        Then the molfile would represent the entire complex of:

        - the monomer on the backbone where the linker attaches

        - the connection between monomer and linker

        - the linker molecule

        - the connection between linker and payload

        - the payload molecule


        Currently, this structure will only represent attachments that the user draws.
        However, in the future,

        this object may also contain leaving group style connections as well.'
      properties:
        __typename:
          type: string
        connectionsInvolved:
          items:
            $ref: '#/components/schemas/ComplexPolymerConnection'
          type: array
        molfile:
          type: string
      type: object
    ComplexPolymerStructure:
      description: 'Contains the complete structural definition of a complex polymer,
        including all

        component polymers and their interconnections. This is the core data structure
        that

        defines how oligonucleotides, molecules, and peptides are assembled into bioconjugates.

        The simplePolymers list contains all components, connections defines the bonds
        between

        them, and resolvedAttachments provides detailed chemistry for drawn attachments.'
      properties:
        __typename:
          type: string
        connections:
          description: A list of all the connections between simple polymers in this
            complex polymer.
          items:
            $ref: '#/components/schemas/ComplexPolymerConnection'
          type: array
        resolvedAttachments:
          description: A list of attachment information, providing a more detailed
            chemical structure for a set of connections.
          items:
            $ref: '#/components/schemas/ComplexPolymerResolvedAttachment'
          type: array
        simplePolymers:
          description: A list of all the simple polymers in this complex polymer.
          items:
            anyOf:
            - $ref: '#/components/schemas/NucleotideSimplePolymer'
            - $ref: '#/components/schemas/ChemSimplePolymer'
            - $ref: '#/components/schemas/PeptideSimplePolymer'
            description: Union of NucleotideSimplePolymer, ChemSimplePolymer, PeptideSimplePolymer
            discriminator:
              propertyName: __typename
          type: array
      type: object
    ConcentrationLayerInput:
      additionalProperties: false
      properties:
        concentrationUnitId:
          type: string
        concentrationUnitVersionNumber:
          type: integer
        name:
          type: string
        wells:
          items:
            $ref: '#/components/schemas/ConcentrationWellInput'
          type: array
      required:
      - name
      - concentrationUnitId
      - concentrationUnitVersionNumber
      type: object
    ConcentrationWellInput:
      additionalProperties: false
      properties:
        concentrationAmount:
          type:
          - 'null'
          - number
        wellPosition:
          type: string
      required:
      - wellPosition
      - concentrationAmount
      type: object
    ConditionOrderForPmdvInput:
      additionalProperties: false
      properties:
        conditionIds:
          items:
            type: string
          type: array
        templateMethodVersionId:
          type: string
      required:
      - templateMethodVersionId
      - conditionIds
      type: object
    ConfigImportHistoryEntry:
      description: 'Records a configuration import operation from one Benchling tenant
        to another. Each entry

        captures the source tenant, target organization, who performed the import,
        and an optional

        changelog URL documenting the changes. This provides an audit trail for configuration

        migrations between tenants.'
      properties:
        __typename:
          type: string
        changelogUrl:
          type:
          - 'null'
          - string
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        name:
          type:
          - 'null'
          - string
        sourceOrgApiIdentifier:
          type: string
        sourceOrgName:
          type: string
        sourceTenantGlobalIdentifier:
          type: string
        sourceTenantSubdomain:
          type: string
        targetOrganization:
          $ref: '#/components/schemas/OrganizationRef'
      type: object
    ConfigImportHistoryEntryPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ConfigImportHistoryEntry'
          type: array
        nextToken:
          type: string
      type: object
    ConfirmationMethodByParamVersionId:
      description: 'Associates a procedure parameter version with its confirmation
        method, keyed by the parameter

        version ID. Used in `ProcedureRunPlan` to look up how a specific version of
        a parameter''s

        values should be confirmed—either via TABLE (structured table entry) or PLATE_MAP
        (plate-based

        layout).'
      properties:
        __typename:
          type: string
        confirmationMethod:
          enum:
          - TABLE
          - PLATE_MAP
          type: string
        paramVersionId:
          type: string
      type: object
    ConfirmationMethodByParamVersionIdInput:
      additionalProperties: false
      properties:
        confirmationMethod:
          enum:
          - TABLE
          - PLATE_MAP
          type: string
        paramVersionId:
          type: string
      required:
      - paramVersionId
      - confirmationMethod
      type: object
    ConnectionSide:
      description: 'Represents one endpoint of a connection between polymers in a
        complex polymer structure.

        Identifies the specific attachment point including the polymer reference,
        residue position

        (for sequences), modification type (for nucleotides), and R-group number (for
        specific

        attachment sites on monomers). Each ComplexPolymerConnection has a source
        and target

        ConnectionSide defining the two endpoints of the bond.'
      properties:
        __typename:
          type: string
        modificationType:
          description: 'Benchling has no concept of monomer index like HELM does,
            so specifying the modification type is our way

            of telling the particular monomer for an attachment on a nucleotide polymer.


            For non-nucleotide polymers, this is always null since we would only have
            one monomer at a particular

            index.'
          enum:
          - SUGAR
          - BASE
          - PHOSPHATE
          - null
          type:
          - 'null'
          - string
        polymerRef:
          description: The ref of the simple polymer connected at this attachment
            point.
          type: string
        rGroup:
          description: 'The r-group number designates the specific attachment site
            on the monomer used by this connection.

            If not null, always >= 1.'
          type:
          - 'null'
          - integer
        residueIndex:
          description: 'For sequence types, the index of the residue at this attachment
            point.


            residueIndex is always 0 or null for CHEM polymers since we never have
            more than one "residue".'
          type:
          - 'null'
          - integer
      type: object
    ConnectorsInput:
      additionalProperties: false
      properties:
        mode:
          description: '"none" disables connectors and "all_connected" enables all
            active connectors for the current user. A future "explicit" mode with
            an "ids" field is planned but is not currently supported.'
          enum:
          - none
          - all_connected
          type: string
      required:
      - mode
      type: object
    Constraint:
      description: 'Defines uniqueness requirements for entities within a schema.
        Constraints ensure that

        registered entities have unique values across specified fields (see `fieldDefinitionNames`)

        or unique domain-specific properties (see `TypeSpecificConstraint`). The hasUniqueResidues

        field is a legacy indicator for sequence uniqueness.'
      properties:
        __typename:
          type: string
        fieldDefinitionNames:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        hasUniqueResidues:
          type:
          - 'null'
          - boolean
      type: object
    Container:
      allOf:
      - $ref: '#/components/schemas/IContainer'
      - description: 'A Container is a physical vessel (such as a tube, vial, or cryotube)
          that holds

          biological or chemical samples in Benchling''s inventory system. Containers
          track

          their contents (see ContainerContent), quantity, location within storage
          (via

          parentStorage which can be a Box, Plate, or Location), and lifecycle information

          including expiration and freeze-thaw cycles. Each container has a barcode
          for

          physical identification and conforms to a ContainerSchema that defines its
          type

          and schema fields. Containers support checkout tracking (see CheckoutRecord)
          and

          can be associated with Studies. Also known as "tubes" or "sample containers"
          in

          laboratory contexts.'
        properties:
          __typename:
            type: string
          creator:
            $ref: '#/components/schemas/PrincipalRef'
          schemaFields:
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    ContainerContent:
      description: 'Represents a biological or chemical entity stored within a Container
        or well. Each

        ContainerContent links an Entity (such as a DNA sequence, protein, or custom
        entity)

        to its storage location, along with an optional concentration measurement.
        The

        timestamps track when the entity was first placed in the container and when
        the

        concentration was last modified. A container can hold multiple ContainerContent

        items representing different entities or samples stored together.'
      properties:
        __typename:
          type: string
        concentration:
          description: Concentration of the entity in the container.
          oneOf:
          - $ref: '#/components/schemas/Measurement'
          - type: 'null'
        createdAt:
          description: When the container was first filled with this entity.
          format: datetime
          type: string
        entity:
          description: The entity in the container.
          oneOf:
          - $ref: '#/components/schemas/EntityRef'
          - type: 'null'
        modifiedAt:
          description: When the entity was last added to this container or the concentration
            was last changed.
          format: datetime
          type: string
      type: object
    ContainerNameTemplate:
      description: A name template for containers.
      properties:
        __typename:
          type: string
        parts:
          items:
            $ref: '#/components/schemas/ContainerNameTemplatePart'
          type: array
      type: object
    ContainerNameTemplateInput:
      additionalProperties: false
      properties:
        nameTemplateParts:
          items:
            $ref: '#/components/schemas/ContainerNameTemplatePartInput'
          type: array
      required:
      - nameTemplateParts
      type: object
    ContainerNameTemplatePart:
      description: A part in a container name template.
      properties:
        __typename:
          type: string
        configuration:
          description: Union of TextNameTemplatePartConfiguration, FieldNameTemplatePartConfiguration
          oneOf:
          - anyOf:
            - $ref: '#/components/schemas/TextNameTemplatePartConfiguration'
            - $ref: '#/components/schemas/FieldNameTemplatePartConfiguration'
            discriminator:
              propertyName: __typename
          - type: 'null'
        type:
          enum:
          - BARCODE
          - BARCODE_NUMBER
          - CHILD_ENTITY_LOT_NUMBER
          - CONCENTRATION_UNITS
          - CONCENTRATION_VALUE
          - CONTAINED_ENTITY_NAME
          - CONTAINER_CREATED_AT_DATE
          - CONTAINER_CREATED_AT_YEAR
          - FIELD
          - FILL_DATE
          - FILL_YEAR
          - HOISTED_FIELD
          - LINKED_BIOENTITY_REGISTRY_IDENTIFIER
          - PARENT_STORABLE_BARCODE
          - PARENT_STORABLE_NAME
          - POSITION
          - PROJECT
          - QUANTITY_UNITS
          - QUANTITY_VALUE
          - REGISTRY_IDENTIFIER_NUMBER
          - REGISTRY_IDENTIFIER_NUMBER_BASE_26
          - RESTRICTION_STATUS
          - SAMPLE_LOT_NUMBER
          - SEPARATOR
          - TEXT
          type: string
      type: object
    ContainerNameTemplatePartInput:
      additionalProperties: false
      properties:
        configuration:
          anyOf:
          - $ref: '#/components/schemas/TextNameTemplatePartConfigurationInput'
          - $ref: '#/components/schemas/FieldNameTemplatePartConfigurationInput'
        type:
          enum:
          - BARCODE
          - BARCODE_NUMBER
          - CHILD_ENTITY_LOT_NUMBER
          - CONCENTRATION_UNITS
          - CONCENTRATION_VALUE
          - CONTAINED_ENTITY_NAME
          - FIELD
          - FILL_DATE
          - FILL_YEAR
          - LINKED_BIOENTITY_REGISTRY_IDENTIFIER
          - PARENT_STORABLE_BARCODE
          - PARENT_STORABLE_NAME
          - POSITION
          - PROJECT
          - QUANTITY_UNITS
          - QUANTITY_VALUE
          - REGISTRY_IDENTIFIER_NUMBER
          - RESTRICTION_STATUS
          - SAMPLE_LOT_NUMBER
          - SEPARATOR
          - TEXT
          type: string
      required:
      - type
      type: object
    ContainerPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Container'
          type: array
        nextToken:
          type: string
      type: object
    ContainerRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ContainerRemoveContentInput:
      additionalProperties: false
      properties:
        containedItemId:
          type: string
      required:
      - containedItemId
      type: object
    ContainerSchema:
      description: 'Defines the structure and metadata for a category of Containers
        in Benchling''s inventory system. A

        `ContainerSchema` specifies the container type (e.g., "1.5mL Microcentrifuge
        Tube", "2mL Cryovial"), custom

        field definitions for capturing container-specific data, and an optional Registry
        association with display ID

        prefix. `ContainerSchema`s are referenced by box and matrix plate schemas
        to constrain what container types

        can be stored in boxes or plates of that type, and by fixed plate schemas
        to identify the container schema for

        the wells, which are modeled as containers. Examples of container schemas
        include "Eppendorf Tube", "Falcon

        Tube", or custom organization-specific container types.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          description: A description of the schema.
          type: string
        fieldDefinitions:
          format: uri
          type: string
        id:
          type: string
        modifiedAt:
          description: DateTime the Container Schema was last modified
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        prefix:
          type:
          - 'null'
          - string
        registry:
          oneOf:
          - $ref: '#/components/schemas/RegistryRef'
          - type: 'null'
        systemName:
          description: A unique, stable identifier for this schema used for programmatic
            access and integrations.
          type: string
        type:
          type:
          - 'null'
          - string
      type: object
    ContainerSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ContainerSchema'
          type: array
        nextToken:
          type: string
      type: object
    ContainerSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ContainerUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Container'
          type: array
      type: object
    ContainerUpdateContentConcentrationInput:
      additionalProperties: false
      properties:
        concentration:
          $ref: '#/components/schemas/MeasurementInput'
        containedItemId:
          type: string
      required:
      - containedItemId
      - concentration
      type: object
    ContentItemInput:
      additionalProperties: false
      properties:
        columnIndex:
          type: integer
        concentrationAmount:
          type: number
        concentrationUnitId:
          type: string
        concentrationUnitVersionNumber:
          type: integer
        containerId:
          type: string
        contentLayerName:
          type: string
        entityId:
          type: string
        rowIndex:
          type: integer
        transferQuantityAmount:
          type: number
        transferQuantityUnitId:
          type: string
        transferQuantityUnitVersionNumber:
          type: integer
        wellPosition:
          type: string
      required:
      - wellPosition
      - rowIndex
      - columnIndex
      type: object
    CreateAASequenceSchemaConstraintInput:
      additionalProperties: false
      properties:
        fieldDefinitionNames:
          items:
            type: string
          type: array
        uniqueResidues:
          enum:
          - EXACT_MATCH
          - IGNORE_CASE
          type: string
      type: object
    CreateAaPartLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent AA part. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - AA_PART_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateAaSequenceInput:
      additionalProperties: false
      properties:
        aliases:
          description: Array of aliases
          items:
            type: string
          type: array
        aminoAcids:
          description: Amino acids of the AA sequence.
          type: string
        annotations:
          description: Array of annotation objects on the AA sequence.
          items:
            $ref: '#/components/schemas/AaAnnotationInput'
          type: array
        authorIds:
          items:
            type: string
          type: array
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          description: Custom fields set on the AA sequence.
          type: object
        entityRegistryId:
          description: Registry ID of the AA sequence if registered.
          type: string
        folderId:
          type: string
        name:
          description: Name of the AA sequence.
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - folderId
      - name
      - aminoAcids
      type: object
    CreateAaSequenceLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent AA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - AA_SEQUENCE_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateAaSequenceSchemaInput:
      additionalProperties: false
      properties:
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          $ref: '#/components/schemas/CreateAASequenceSchemaConstraintInput'
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        fieldDefinitions:
          description: "The field definitions configured on this schema. Supported
            types include:\n\n- Legacy: `BaseFieldDefinition`, `SchemaLinkFieldDefinition`\n\n-
            Primitive: `TextFieldDefinition`, `LongTextFieldDefinition`, `IntegerFieldDefinition`,\n
            \ `FloatFieldDefinition`, `BooleanFieldDefinition`, `DateFieldDefinition`,
            `DateTimeFieldDefinition`\n\n- Dropdown: `DropdownLinkFieldDefinition`\n\n-
            Blob: `BlobLinkFieldDefinition`\n\n- Entity links: `AnyEntityLinkFieldDefinition`,
            `CustomEntityLinkFieldDefinition`,\n  `AaSequenceLinkFieldDefinition`,
            `DnaSequenceLinkFieldDefinition`, `MixtureLinkFieldDefinition`,\n  `MoleculeLinkFieldDefinition`,
            `AntibodyLinkFieldDefinition`, `OligoConjugateLinkFieldDefinition`,\n
            \ `OligoDuplexLinkFieldDefinition`, `DnaOligoLinkFieldDefinition`, `RnaOligoLinkFieldDefinition`\n\n-
            Storage: `StorableLinkFieldDefinition`\n\n- Assay links: `AssayRequestLinkFieldDefinition`,
            `AssayResultLinkFieldDefinition`,\n  `AssayRunLinkFieldDefinition`\n\n-
            Part links: `AaPartLinkFieldDefinition`\n\n`JsonFieldDefinition` is not
            supported."
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaPartLinkFieldDefinitionInput'
          type: array
        fieldsets:
          items:
            type: string
          type: array
        iconId:
          enum:
          - ANTIBODY
          - BASIC_FOLDER_ITEM
          - LINEAR
          - PROTEIN
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        showResidues:
          description: Controls whether amino acid residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - organizationId
      - description
      - itemIdPrefix
      - showResidues
      type: object
    CreateAgentInput:
      additionalProperties: false
      properties:
        agent:
          deprecated: true
          description: Deprecated agent identifier to use.
          enum:
          - benchling_deep_research_v1
          - benchling_ask_v1
          type: string
        chatId:
          description: Existing chat ID to append to; omit to start a new chat.
          type:
          - 'null'
          - string
        connectors:
          $ref: '#/components/schemas/ConnectorsInput'
          description: 'Connector selection for this request. Omitting this field
            is equivalent to {"mode": "none"}. Only available when "agent" and "sources"
            are omitted.'
        editingTarget:
          $ref: '#/components/schemas/EditingTargetInput'
          description: Benchling object (e.g. entry) to edit via a new chat. Not allowed
            when "agent" or "chatId" are specified.
        input:
          description: Ordered list of user message blocks.
          items:
            $ref: '#/components/schemas/BaseCreateMessageBlockInput'
          type: array
        sources:
          description: Data sources the agent may use. Not available for benchling_ask_v1.
          items:
            $ref: '#/components/schemas/ChatSourceInput'
          type: array
      required:
      - input
      type: object
    CreateAndUploadScratchFileInput:
      additionalProperties: false
      properties:
        contents:
          type: string
        filename:
          type: string
        s3Location:
          type: string
      type: object
    CreateAntibodyLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent Antibody. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - ANTIBODY_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateAntibodySchemaInput:
      additionalProperties: false
      properties:
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        chainLinkedSchemas:
          description: Schema mappings for chain labels in the protein format.
          items:
            $ref: '#/components/schemas/ChainLinkedSchemaInput'
          type: array
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        domainLinkedSchemas:
          description: Schema mappings for each domain label in the protein format.
          items:
            $ref: '#/components/schemas/DomainLinkedSchemaInput'
          type: array
        fieldDefinitions:
          description: Optional schema field definitions to create on the antibody
            schema.
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
          type: array
        fieldsets:
          items:
            type: string
          type: array
        formatId:
          description: API ID of the protein format that defines the antibody schema
            structure.
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - organizationId
      - description
      - itemIdPrefix
      - formatId
      - domainLinkedSchemas
      - chainLinkedSchemas
      type: object
    CreateAnyEntityLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - ENTITY_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      type: object
    CreateAppCanvasInput:
      additionalProperties: false
      properties:
        appId:
          description: API ID of the Benchling App that owns this canvas.
          type: string
        blocks:
          description: UI blocks defining the canvas layout and interactivity.
          items:
            $ref: '#/components/schemas/AppCanvasUiBlockInput'
          type: array
        data:
          description: Optional JSON string (max 5 KiB) of app-managed data not rendered
            in the canvas UI.
          type: string
        enabled:
          description: Whether the canvas is interactable. When false, all blocks
            are disabled regardless of their individual enabled settings.
          type: boolean
        featureId:
          description: Feature ID from the app manifest that this canvas corresponds
            to.
          type: string
        resourceId:
          description: Identifier of the resource object to attach the canvas to.
          type: string
        sessionId:
          description: Optional app session ID whose status messages are shown in
            the canvas.
          type: string
      required:
      - appId
      - resourceId
      - featureId
      - blocks
      type: object
    CreateAppSessionInput:
      additionalProperties: false
      properties:
        appId:
          description: API ID of the Benchling App that owns this session.
          type: string
        messages:
          description: Initial messages to display. If omitted, the session starts
            with no messages.
          items:
            $ref: '#/components/schemas/AppSessionMessageInput'
          type: array
        name:
          description: Human-readable name for this session.
          type: string
        timeoutSeconds:
          description: Maximum session duration in seconds before automatic timeout
            (1 to 2592000).
          type: integer
      required:
      - appId
      - name
      - timeoutSeconds
      type: object
    CreateAssayRequestLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - ASSAY_REQUEST_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateAssayResultLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - ASSAY_RESULT_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateAssayRunLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - ASSAY_RUN_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateBaseUnitInput:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        name:
          type: string
        symbol:
          type: string
      required:
      - name
      - symbol
      - aliases
      type: object
    CreateBlobLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - BLOB_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      type: object
    CreateBooleanFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - BOOLEAN
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      type: object
    CreateBoxInput:
      additionalProperties: false
      properties:
        barcode:
          type: string
        name:
          type: string
        parentStorageId:
          type: string
        projectId:
          type: string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - schemaId
      type: object
    CreateBoxSchemaInput:
      additionalProperties: false
      properties:
        containerSchemaId:
          description: The API ID of the container schema constraining what types
            of containers can be stored in boxes of this type.
          type: string
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
          type: array
        height:
          description: The number of rows in the grid layout.
          type: integer
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        prefix:
          description: The prefix used for auto-generating barcodes for inventory
            items of this schema. Must be unique within the registry and cannot end
            in a digit.
          type: string
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
        width:
          description: The number of columns in the grid layout.
          type: integer
      required:
      - organizationId
      - description
      - prefix
      - height
      - width
      type: object
    CreateChartInput:
      additionalProperties: false
      properties:
        chatSessionId:
          type: string
        duplicatingChartId:
          type: string
        library:
          enum:
          - PLOTLY
          type: string
        libraryConfig:
          description: JSON object representing the direct input to a chart library
            on the front-end.
          type: object
        libraryVersion:
          description: 'Version of the library that the config corresponds to.


            For example, if the library uses semver, we might store "1.2.3", "1.2.3-alpha.1",
            ect.'
          type: string
        name:
          type: string
        originPipelineStepDataName:
          description: The name of the data in originPipelineStep that this chart
            was created from.
          type: string
        originPipelineStepId:
          type: string
        rasterConfig:
          description: "Config used to generate the rasterized image of the chart
            in relation to th library that we're using.\n\nFor example, in Plotly,
            this could be:\n```\n  {\n    width: 600\n    height: 400\n    scale:
            0.5\n    format: \"png\"\n    engine: \"kaleido\"\n  }\n```"
          type: object
      required:
      - name
      - library
      - libraryVersion
      - libraryConfig
      type: object
    CreateCollaborationInput:
      additionalProperties: false
      properties:
        accessPolicyId:
          type: string
        collaborator:
          $ref: '#/components/schemas/CollaboratorReferenceInput'
        isAuditor:
          type: boolean
        itemId:
          type: string
      required:
      - itemId
      - collaborator
      - accessPolicyId
      type: object
    CreateComplexPolymerSchemaFieldSpecInput:
      additionalProperties: false
      properties:
        schemaFieldName:
          type: string
        schemaOrInterfaceId:
          type: string
      required:
      - schemaOrInterfaceId
      - schemaFieldName
      type: object
    CreateConsensusAlignmentInput:
      additionalProperties: false
      properties:
        algorithm:
          enum:
          - MAFFT
          - CLUSTALO
          type: string
        clustaloOptions:
          $ref: '#/components/schemas/ClustalOOptionsInput'
          description: Options to pass to the ClustalO algorithm, only applicable
            for ClustalO.
        files:
          description: Sequence files to align. Minimum 2.
          items:
            $ref: '#/components/schemas/AlignmentFileInput'
          type: array
        mafftOptions:
          $ref: '#/components/schemas/MafftOptionsInput'
          description: Options to pass to the MAFFT algorithm, only applicable for
            MAFFT.
        name:
          description: The name of the alignment. When omitted, a name is automatically
            generated. If specified, it must contain at least one non-whitespace character.
            Up to 255 characters.
          type: string
        newSequence:
          $ref: '#/components/schemas/NewSequenceInput'
        sequenceId:
          type: string
      required:
      - files
      - algorithm
      type: object
    CreateContainerInput:
      additionalProperties: false
      properties:
        barcode:
          type: string
        name:
          type: string
        parentStorageId:
          type: string
        projectId:
          type:
          - 'null'
          - string
        restrictedSamplePartyIds:
          items:
            type: string
          type: array
        restrictionStatus:
          enum:
          - RESTRICTED
          - UNRESTRICTED
          - NOT_APPLICABLE
          type: string
        sampleOwnerIds:
          items:
            type: string
          type: array
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - schemaId
      type: object
    CreateContainerSchemaInput:
      additionalProperties: false
      properties:
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
          type: array
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        prefix:
          description: The prefix used for auto-generating barcodes for inventory
            items of this schema. Must be unique within the registry and cannot end
            in a digit.
          type: string
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
      required:
      - organizationId
      - description
      - prefix
      type: object
    CreateCustomEntityInput:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        authorIds:
          items:
            type: string
          type: array
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        entityRegistryId:
          type: string
        folderId:
          type: string
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - folderId
      - name
      - schemaId
      type: object
    CreateCustomEntityLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent custom entity.
            Important for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - CUSTOM_ENTITY_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateCustomEntitySchemaInput:
      additionalProperties: false
      properties:
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          $ref: '#/components/schemas/CreateEntitySchemaConstraintInput'
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
          type: array
        fieldsets:
          items:
            type: string
          type: array
        iconId:
          enum:
          - ANTIBODY
          - ARROW_ZIG_ZAG_DOWN
          - ARROW_ZIG_ZAG_RIGHT
          - ASSEMBLY
          - BACTERIA
          - BASIC_FOLDER_ITEM
          - BEAKER
          - BOX_ARROW_RIGHT
          - BROKEN_COLUMNS_IN_BRACKET
          - BUILDING_PLUS
          - CELL_LINE
          - CHEMICAL_COMPOUND
          - CHEMICAL_CONCATENATION
          - CHEMICAL_HOMOLOGY
          - CHEMICAL_LADDER
          - CHROMATOGRAPHY
          - CIRCLE_WITH_THICK_SEGMENT
          - CLIPBOARD_IN_BRACKETS
          - COMPOUND
          - DOCK_BOTTOM
          - FILE_BAR_CHART
          - FILE_IN_BRACKETS
          - FILL_GRID
          - FLASK
          - FLASK_RECEIPT
          - FLOWCHART
          - GRID_DOTS
          - HUMAN
          - INSTRUMENT
          - LIGHTBULB_IN_BRACKETS
          - LINEAR
          - LIST_ASTERISK
          - LIST_CHECK_XMARK
          - MATERIAL
          - MICROSCOPE
          - MIXTURE
          - MOLECULE_TO_BACKBONE
          - MOLECULE_TO_MOLECULE
          - MORTAR_PESTLE
          - MOUSE
          - NETWORK_WIRED
          - NODES_CONVERGE
          - OCHEM_MOLECULE
          - OCHEM_MOLECULE_BEAKER
          - OLIGO
          - OLIGO_ALT
          - OLIGO_V2
          - PART
          - PETRI
          - PLANT
          - PLASMID
          - POWDER
          - POWDER_BEAKER
          - PRIMER_PAIR
          - PROCESS
          - PROTEIN
          - PROTEIN_ALT
          - PROTEIN_MAGNIFYING_GLASS
          - REACTION_VESSEL
          - RECEIPT_FLASK
          - RECIPE
          - REQUEST_TEMPLATE
          - RNA
          - RNA_SEQUENCE
          - SAMPLE_SLIDE
          - SEQUENCE
          - SMALL_MOLECULE
          - SMALL_MOLECULE_BEAKER
          - SOLUTION
          - SQUARE_BRACKET_CHECK_EQUALS
          - TABLE_LIST_ALT
          - TEMPLATE
          - TUBE_EMPTY
          - VIAL
          - WELL_PLATE
          - WORKFLOW
          - WORKSHEET
          - WORM
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - organizationId
      - description
      - itemIdPrefix
      type: object
    CreateDateFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - DATE
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      type: object
    CreateDateTimeFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - DATE_TIME
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      type: object
    CreateDnaOligoInput:
      additionalProperties: false
      properties:
        aliases:
          description: Array of aliases
          items:
            type: string
          type: array
        annotations:
          description: Annotations on the Oligo.
          items:
            $ref: '#/components/schemas/OligoAnnotationInput'
          type: array
        authorIds:
          items:
            type: string
          type: array
        bases:
          description: Bases of the Oligo.
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          description: Custom fields set on the Oligo.
          type: object
        customNotation:
          type: string
        customNotationId:
          type: string
        entityRegistryId:
          description: Registry ID of the Oligo if registered.
          type: string
        folderId:
          type: string
        helm:
          type: string
        name:
          description: Name of the Oligo.
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - folderId
      - name
      type: object
    CreateDnaOligoLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent DNA Oligo. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - DNA_OLIGO_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateDnaOligoSchemaInput:
      additionalProperties: false
      properties:
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          $ref: '#/components/schemas/CreateSequenceSchemaConstraintInput'
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
          type: array
        fieldsets:
          items:
            type: string
          type: array
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - OLIGO
          - OLIGO_V2
          - PRIMER_PAIR
          - SEQUENCE
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        showResidues:
          description: Controls whether DNA residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - organizationId
      - description
      - itemIdPrefix
      - showResidues
      type: object
    CreateDnaPartLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent DNA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - DNA_PART_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateDnaSequenceInput:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        annotations:
          description: 'Annotations on the DNA sequence, not including translations
            or primers. Annotations on parts are

            not included.'
          items:
            $ref: '#/components/schemas/NucleotideAnnotationInput'
          type: array
        authorIds:
          items:
            type: string
          type: array
        bases:
          description: Bases of the forward strand of the DNA sequence.
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        entityRegistryId:
          type: string
        folderId:
          type: string
        isCircular:
          description: Field will be set to false if not specified.
          type: boolean
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        parts:
          description: Part features on the DNA sequence.
          items:
            $ref: '#/components/schemas/NucleotidePartInput'
          type: array
        primers:
          description: Primer bind features on the DNA sequence. Primers on parts
            are not included.
          items:
            $ref: '#/components/schemas/PrimerInput'
          type: array
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
        translations:
          description: 'Translation annotations present on the DNA sequence. Translations
            may be one region or split

            across multiple regions. Translations on parts are not included.'
          items:
            $ref: '#/components/schemas/TranslationInput'
          type: array
      required:
      - folderId
      - name
      - bases
      type: object
    CreateDnaSequenceLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent DNA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - DNA_SEQUENCE_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateDnaSequenceSchemaInput:
      additionalProperties: false
      properties:
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          $ref: '#/components/schemas/CreateSequenceSchemaConstraintInput'
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaPartLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTranscriptionLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTranslationLinkFieldDefinitionInput'
          type: array
        fieldsets:
          items:
            type: string
          type: array
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - OLIGO_V2
          - PLASMID
          - PRIMER_PAIR
          - RNA_SEQUENCE
          - SEQUENCE
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        showResidues:
          description: Controls whether DNA residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - organizationId
      - description
      - itemIdPrefix
      - showResidues
      type: object
    CreateDropdownInput:
      additionalProperties: false
      properties:
        name:
          description: Name of the dropdown
          type: string
        options:
          description: Array of dropdown options
          items:
            $ref: '#/components/schemas/CreateDropdownOptionInput'
          type: array
        registryId:
          type: string
      required:
      - name
      - registryId
      - options
      type: object
    CreateDropdownLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        dropdownId:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - DROPDOWN
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - dropdownId
      type: object
    CreateDropdownOptionInput:
      additionalProperties: false
      properties:
        name:
          type: string
      required:
      - name
      type: object
    CreateEntitySchemaConstraintInput:
      additionalProperties: false
      properties:
        fieldDefinitionNames:
          items:
            type: string
          type: array
      type: object
    CreateEntryContentInput:
      allOf:
      - properties:
          contentType:
            enum:
            - external_file
            - registration_table
            - result_table
            - text
            type: string
        required:
        - contentType
      - oneOf:
        - $ref: '#/components/schemas/CreateFileAttachmentInput'
        - $ref: '#/components/schemas/CreateRegistrationTableInput'
        - $ref: '#/components/schemas/CreateResultTableInput'
        - $ref: '#/components/schemas/CreateTextInput'
      discriminator:
        propertyName: contentType
      type: object
    CreateEntryInput:
      additionalProperties: false
      properties:
        authorIds:
          description: IDs of users to set as authors of the new entry. Defaults to
            the creator. Use [] to create an entry with no authors.
          items:
            type: string
          type: array
        folderId:
          description: API ID of the folder to create the entry in.
          type: string
        name:
          description: Title of the entry
          type: string
        parts:
          description: Initial document content parts to insert into the new entry.
          items:
            $ref: '#/components/schemas/DocumentContentInput'
          type: array
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          description: A dictionary of schema key-value pairs which maps fields from
            the assigned schema to their associated values.
          type: object
        schemaId:
          description: The api identifier for the tag schema assigned to the entry.
          type:
          - 'null'
          - string
        studyIds:
          description: IDs of studies to associate with the new entry.
          items:
            type: string
          type: array
      required:
      - name
      - folderId
      type: object
    CreateEntryLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - ENTRY_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      type: object
    CreateEquipmentLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent Equipment. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - EQUIPMENT_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateEquipmentSchemaInput:
      additionalProperties: false
      properties:
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          $ref: '#/components/schemas/CreateEntitySchemaConstraintInput'
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
          type: array
        fieldsets:
          items:
            type: string
          type: array
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - MICROSCOPE
          - SAMPLE_SLIDE
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - organizationId
      - description
      - itemIdPrefix
      type: object
    CreateFieldsetConstraintInput:
      additionalProperties: false
      properties:
        fieldDefinitionNames:
          items:
            type: string
          type: array
        hasUniqueCanonicalSmiles:
          type: boolean
        uniqueResidues:
          enum:
          - EXACT_MATCH
          - IGNORE_CASE
          type: string
      type: object
    CreateFieldsetInput:
      additionalProperties: false
      properties:
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          $ref: '#/components/schemas/CreateFieldsetConstraintInput'
        description:
          description: A description of the fieldset. At most 1000 characters.
          type: string
        displayName:
          type: string
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
          type: array
        itemIdPrefix:
          type: string
        itemType:
          description: 'The entity item type that schemas implementing this Fieldset
            contain (e.g. DNA_SEQUENCE,

            AA_SEQUENCE, MIXTURE). Null when the Fieldset declares no base bioentity
            type.'
          enum:
          - AA_SEQUENCE
          - ANTIBODY
          - CUSTOM_ENTITY
          - DNA_OLIGO
          - DNA_SEQUENCE
          - ENTRY
          - EQUIPMENT
          - MIXTURE
          - MOLECULE
          - OLIGO_CONJUGATE
          - OLIGO_DUPLEX
          - RNA_OLIGO
          - RNA_SEQUENCE
          - TRIAL_SUBJECT
          type: string
        organizationId:
          type: string
        systemName:
          type: string
      required:
      - displayName
      - organizationId
      - itemIdPrefix
      type: object
    CreateFieldsetLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - FIELDSET_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateFileAttachmentInput:
      additionalProperties: false
      properties:
        contentType:
          enum:
          - external_file
          type: string
        url:
          type: string
      required:
      - contentType
      - url
      type: object
    CreateFileInput:
      additionalProperties: false
      properties:
        folderId:
          type: string
        name:
          type: string
        scratchFileId:
          type: string
      required:
      - name
      - folderId
      - scratchFileId
      type: object
    CreateFloatFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        displayPrecision:
          type: integer
        isRequired:
          type: boolean
        name:
          type: string
        numericMax:
          type: number
        numericMin:
          type: number
        systemName:
          type: string
        type:
          enum:
          - FLOAT
          type: string
        unitId:
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      type: object
    CreateFolderInput:
      additionalProperties: false
      properties:
        description:
          type: string
        name:
          type: string
        parentId:
          type: string
      required:
      - name
      - parentId
      type: object
    CreateFormulaUnitTermInput:
      additionalProperties: false
      properties:
        exponent:
          type: integer
        value:
          type: string
      required:
      - value
      - exponent
      type: object
    CreateIntegerFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isRequired:
          type: boolean
        name:
          type: string
        numericMax:
          type: number
        numericMin:
          type: number
        systemName:
          type: string
        type:
          enum:
          - INTEGER
          type: string
        unitId:
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      type: object
    CreateJsonFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - JSON
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      type: object
    CreateLibraryParameterDefinitionInput:
      additionalProperties: false
      example:
        dataType: FLOAT
        description: The temperature at which the sample is incubated during the reaction
          step.
        name: Incubation Temperature
        unitTypeId: qnty_k8Rt4vNp
      properties:
        creatorId:
          deprecated: true
          description: Deprecated. This field is ignored — the creator is always set
            to the authenticated user.
          type: string
        dataType:
          description: 'The data type of values recorded for this parameter. Determines
            which additional fields are required: `FLOAT` requires `unitTypeId`, `DROPDOWN`
            requires `schemaFieldSelectorId`. Cannot be changed after creation.'
          enum:
          - FLOAT
          - DATETIME
          - TEXT
          - DROPDOWN
          type: string
        description:
          description: A description of what this parameter measures or represents.
            Maximum 2048 characters.
          type: string
        name:
          description: Display name for the parameter definition. Must contain at
            least one alphanumeric character. Maximum 44 characters.
          type: string
        unitTypeId:
          description: 'The ID of the unit type for this parameter. Required when
            `dataType` is `FLOAT`, forbidden otherwise. Use `GET /benchling/unit-type/items`
            to list available unit types. Format: `qnty_XXXXXXXX`.'
          type:
          - 'null'
          - string
      required:
      - name
      - description
      - dataType
      type: object
    CreateLocationInput:
      additionalProperties: false
      properties:
        barcode:
          type: string
        name:
          type: string
        parentStorageId:
          type: string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - name
      - schemaId
      type: object
    CreateLocationSchemaInput:
      additionalProperties: false
      properties:
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
          type: array
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        prefix:
          description: The prefix used for auto-generating barcodes for inventory
            items of this schema. Must be unique within the registry and cannot end
            in a digit.
          type: string
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
      required:
      - organizationId
      - description
      - prefix
      type: object
    CreateLongTextFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - LONG_TEXT
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      type: object
    CreateMatrixPlateInput:
      additionalProperties: false
      properties:
        barcode:
          description: Barcode of the plate
          type: string
        containerSchemaId:
          type: string
        name:
          description: Name of the plate; defaults to barcode if name is not provided
          type: string
        parentStorageId:
          type: string
        positions:
          description: The wells of the plate
          items:
            $ref: '#/components/schemas/MatrixPlatePositionInput'
          type: array
        projectId:
          type: string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - schemaId
      type: object
    CreateMatrixPlateSchemaInput:
      additionalProperties: false
      properties:
        containerSchemaId:
          description: The API ID of the container schema constraining what types
            of containers can be inserted into plates of this type.
          type: string
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        fieldDefinitions:
          description: The fields inherited by plates of this schema.
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
          type: array
        height:
          description: The number of rows in the grid layout.
          type: integer
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        prefix:
          description: The prefix used for auto-generating barcodes for inventory
            items of this schema. Must be unique within the registry and cannot end
            in a digit.
          type: string
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
        width:
          description: The number of columns in the grid layout.
          type: integer
      required:
      - organizationId
      - description
      - prefix
      - height
      - width
      type: object
    CreateMixtureLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent mixture. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - MIXTURE_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateMixtureSchemaInput:
      additionalProperties: false
      properties:
        allowMeasuredIngredients:
          description: 'Whether this mixture schema allows recording measured values
            for ingredients.

            When enabled, users can track actual measured amounts in addition to target
            amounts.'
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        componentLotStorageEnabled:
          description: 'Whether mixture ingredients can specify their component lot
            as a container and/or entity from inventory.

            Only applicable when allowMeasuredIngredients is true.

            Will be null when allowMeasuredIngredients is false.'
          type: boolean
        componentLotTextEnabled:
          description: 'Whether mixture ingredients can specify their component lot
            as a text value.

            Only applicable when allowMeasuredIngredients is true.

            Will be null when allowMeasuredIngredients is false.'
          type: boolean
        constraint:
          $ref: '#/components/schemas/CreateEntitySchemaConstraintInput'
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
          type: array
        fieldsets:
          items:
            type: string
          type: array
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - MIXTURE
          - MORTAR_PESTLE
          - POWDER
          - POWDER_BEAKER
          - RECIPE
          - SOLUTION
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - organizationId
      - description
      - itemIdPrefix
      - allowMeasuredIngredients
      type: object
    CreateMoleculeInput:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        authorIds:
          items:
            type: string
          type: array
        chemicalStructure:
          $ref: '#/components/schemas/ChemicalStructureInput'
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        entityRegistryId:
          type: string
        folderId:
          type: string
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - folderId
      - name
      - chemicalStructure
      type: object
    CreateMoleculeLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent molecule. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - MOLECULE_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateMoleculeSchemaConstraintInput:
      additionalProperties: false
      properties:
        fieldDefinitionNames:
          items:
            type: string
          type: array
        hasUniqueCanonicalSmiles:
          type: boolean
      type: object
    CreateMoleculeSchemaInput:
      additionalProperties: false
      properties:
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          $ref: '#/components/schemas/CreateMoleculeSchemaConstraintInput'
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
          type: array
        fieldsets:
          items:
            type: string
          type: array
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - SMALL_MOLECULE
          - SMALL_MOLECULE_BEAKER
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - organizationId
      - description
      - itemIdPrefix
      type: object
    CreateOligoConjugateLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent Oligo Conjugate.
            Important for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - OLIGO_CONJUGATE_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateOligoConjugateSchemaInput:
      additionalProperties: false
      properties:
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        backboneSchemaFieldSpec:
          $ref: '#/components/schemas/CreateComplexPolymerSchemaFieldSpecInput'
        conjugatesSchemaFieldSpecs:
          items:
            $ref: '#/components/schemas/CreateComplexPolymerSchemaFieldSpecInput'
          type: array
        constraint:
          $ref: '#/components/schemas/CreateEntitySchemaConstraintInput'
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
          type: array
        fieldsets:
          items:
            type: string
          type: array
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - NETWORK_WIRED
          - OLIGO
          - OLIGO_V2
          - PRIMER_PAIR
          - PROTEIN
          - RNA_SEQUENCE
          - SEQUENCE
          - SMALL_MOLECULE
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - organizationId
      - description
      - itemIdPrefix
      - backboneSchemaFieldSpec
      - conjugatesSchemaFieldSpecs
      type: object
    CreateOligoDuplexLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent Oligo Duplex. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - OLIGO_DUPLEX_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateOligoDuplexSchemaInput:
      additionalProperties: false
      properties:
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        conjugatesSchemaFieldSpecs:
          items:
            $ref: '#/components/schemas/CreateComplexPolymerSchemaFieldSpecInput'
          type: array
        constraint:
          $ref: '#/components/schemas/CreateEntitySchemaConstraintInput'
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
          type: array
        fieldsets:
          items:
            type: string
          type: array
        forwardStrandSchemaFieldSpec:
          $ref: '#/components/schemas/CreateComplexPolymerSchemaFieldSpecInput'
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - NETWORK_WIRED
          - PRIMER_PAIR
          - SEQUENCE
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        reverseStrandSchemaFieldSpec:
          $ref: '#/components/schemas/CreateComplexPolymerSchemaFieldSpecInput'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - organizationId
      - description
      - itemIdPrefix
      - forwardStrandSchemaFieldSpec
      - reverseStrandSchemaFieldSpec
      - conjugatesSchemaFieldSpecs
      type: object
    CreatePlateDesignTemplateInput:
      additionalProperties: false
      properties:
        name:
          type: string
        scratchPlateId:
          type: string
        templateCollectionId:
          type: string
      required:
      - scratchPlateId
      - templateCollectionId
      - name
      type: object
    CreateProcedureRunPlanConditionInput:
      additionalProperties: false
      example:
        description: 10mg/kg treatment group
        methodParametersPlan:
          dataParameterValues:
          - parameterId: schver_Rm4nTvWz
            value:
              value:
                floatValue: 10.0
                type: ft_float
                value: '10.0'
          equipmentValues: []
          materialInputValues: []
        name: Low Dose
        procedureRunPlanId: prp_Xk9mLpQr
        replicates:
        - replicateNumber: 1
        - replicateNumber: 2
        - replicateNumber: 3
        templateMethodVersionId: pcmdv_Hn5kRtYw
      properties:
        description:
          description: Description of the condition. Must not exceed 255 characters.
          type: string
        methodParametersPlan:
          description: Pre-filled parameter values for this condition's unit operation.
            Pass null to use default values from the procedure template upon run creation.
          oneOf:
          - $ref: '#/components/schemas/MethodParametersPlanInput'
          - type: 'null'
        name:
          description: Display name of the condition. Must not be empty and must not
            exceed 255 characters.
          type: string
        procedureRunPlanId:
          description: 'The ID of the parent run plan. Format: `prp_XXXXXXXX`.'
          type: string
        replicates:
          description: The replicates for this condition. Must contain between 1 and
            999 replicates, with consecutive `replicateNumber` values starting from
            1.
          items:
            $ref: '#/components/schemas/ProcedureRunPlanConditionReplicateInput'
          type: array
        templateMethodVersionId:
          description: 'The ID of the procedure method definition version (PMDV) this
            condition belongs to. Format: `pcmdv_XXXXXXXX`. Must reference a method
            in the parent run plan''s flowchart.'
          type: string
      required:
      - name
      - description
      - procedureRunPlanId
      - methodParametersPlan
      - replicates
      - templateMethodVersionId
      type: object
    CreateProcedureRunPlanInput:
      additionalProperties: false
      example:
        confirmationMethodByParamVersionId:
        - confirmationMethod: TABLE
          paramVersionId: schver_Rm4nTvWz
        dataEntryMode: INDIVIDUAL_CONDITION_REPLICATES
        description: Dose-response run plan
        studyId: stdy_9CYiCggY
        workflowFlowchartConfigVersionId: wffccv_Lk3mQpXn
      properties:
        confirmationMethodByParamVersionId:
          description: Override the default confirmation method for specific procedure
            parameters. Each entry maps a parameter version ID to a confirmation method
            (TABLE or PLATE_MAP). Omit or pass an empty array to use the default confirmation
            methods.
          items:
            $ref: '#/components/schemas/ConfirmationMethodByParamVersionIdInput'
          type: array
        dataEntryMode:
          description: Controls how data entry worksheets are created upon promotion.
            `INDIVIDUAL_CONDITION_REPLICATES` creates one worksheet per condition-replicate.
            `ALL_CONDITION_REPLICATES_TOGETHER` creates a single shared worksheet
            (not supported for assay run plans). Defaults to `INDIVIDUAL_CONDITION_REPLICATES`
            if omitted.
          enum:
          - INDIVIDUAL_CONDITION_REPLICATES
          - ALL_CONDITION_REPLICATES_TOGETHER
          type: string
        description:
          description: A human-readable description of the run plan. Must not exceed
            255 characters.
          type: string
        studyId:
          description: 'The ID of the study this run plan belongs to. Format: `stdy_XXXXXXXX`.'
          type: string
        workflowFlowchartConfigVersionId:
          description: 'The ID of the workflow flowchart config version that defines
            the procedure template for this run plan. Format: `wffccv_XXXXXXXX`. Set
            to null to create a run plan with no linked procedure.'
          type:
          - 'null'
          - string
      required:
      - description
      - studyId
      - dataEntryMode
      - workflowFlowchartConfigVersionId
      - confirmationMethodByParamVersionId
      type: object
    CreateProjectInput:
      additionalProperties: false
      properties:
        description:
          type:
          - 'null'
          - string
        name:
          type: string
        ownerId:
          type: string
        reviewLifecycleIds:
          items:
            type: string
          type: array
        useAuditorReview:
          type: boolean
      required:
      - name
      - ownerId
      type: object
    CreateProteinFormatInput:
      additionalProperties: false
      example:
        displayName: IgG-Fab format
        veritasName: IgG-Fab
      properties:
        displayName:
          description: The display name of the protein format. If not provided, the
            VERITAS name will be used.
          type: string
        veritasName:
          description: The VERITAS name of the protein format, used to build the structure
            and visualization.
          type: string
      required:
      - veritasName
      type: object
    CreateProteinInput:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        authorIds:
          items:
            type: string
          type: array
        chains:
          description: A chain input for each chain on the relevant format. All must
            be provided.
          items:
            $ref: '#/components/schemas/ProteinChainInput'
          type: array
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        domains:
          description: A domain input for each domain on the relevant format. All
            must be provided.
          items:
            $ref: '#/components/schemas/ProteinDomainInput'
          type: array
        entityRegistryId:
          type: string
        folderId:
          type: string
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          description: The ID of the schema to create the protein in.
          type: string
        studyIds:
          description: Study IDs to add the new protein to.
          items:
            type: string
          type: array
      required:
      - folderId
      - name
      - schemaId
      - domains
      - chains
      type: object
    CreateRegistrationTableInput:
      additionalProperties: false
      properties:
        contentType:
          enum:
          - registration_table
          type: string
        entitySchemaId:
          type: string
      required:
      - contentType
      - entitySchemaId
      type: object
    CreateRequestV2DefinitionInput:
      additionalProperties: false
      properties:
        description:
          description: Description of the request template.
          type:
          - 'null'
          - string
        name:
          type: string
        prefix:
          description: The prefix for the displayId of tasks of this schema.
          type: string
        taskSchemaId:
          type: string
        templateCollectionId:
          type: string
      required:
      - name
      - taskSchemaId
      - templateCollectionId
      - prefix
      type: object
    CreateResultInput:
      additionalProperties: false
      properties:
        projectId:
          type: string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
        tableHandleId:
          type: string
      required:
      - schemaId
      - schemaFields
      - projectId
      type: object
    CreateResultTableInput:
      additionalProperties: false
      properties:
        contentType:
          enum:
          - result_table
          type: string
        resultSchemaId:
          type: string
      required:
      - contentType
      - resultSchemaId
      type: object
    CreateRnaOligoInput:
      additionalProperties: false
      properties:
        aliases:
          description: Array of aliases
          items:
            type: string
          type: array
        annotations:
          description: Annotations on the Oligo.
          items:
            $ref: '#/components/schemas/OligoAnnotationInput'
          type: array
        authorIds:
          items:
            type: string
          type: array
        bases:
          description: Bases of the Oligo.
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          description: Custom fields set on the Oligo.
          type: object
        customNotation:
          type: string
        customNotationId:
          type: string
        entityRegistryId:
          description: Registry ID of the Oligo if registered.
          type: string
        folderId:
          type: string
        helm:
          type: string
        name:
          description: Name of the Oligo.
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - folderId
      - name
      type: object
    CreateRnaOligoLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent RNA Oligo. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - RNA_OLIGO_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateRnaOligoSchemaInput:
      additionalProperties: false
      properties:
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          $ref: '#/components/schemas/CreateSequenceSchemaConstraintInput'
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
          type: array
        fieldsets:
          items:
            type: string
          type: array
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - OLIGO
          - OLIGO_V2
          - SEQUENCE
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        showResidues:
          description: Controls whether RNA residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - organizationId
      - description
      - itemIdPrefix
      - showResidues
      type: object
    CreateRnaSequenceInput:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        annotations:
          description: 'Annotations on the RNA sequence, not including translations
            or primers. Annotations on parts are

            not included.'
          items:
            $ref: '#/components/schemas/RnaAnnotationInput'
          type: array
        authorIds:
          items:
            type: string
          type: array
        bases:
          description: Bases of the RNA sequence.
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        customNotation:
          type:
          - 'null'
          - string
        customNotationId:
          type:
          - 'null'
          - string
        entityRegistryId:
          type: string
        folderId:
          type: string
        helm:
          type: string
        isCircular:
          description: Field will be set to false if not specified.
          type: boolean
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        parts:
          description: Part features on the RNA sequence.
          items:
            $ref: '#/components/schemas/RnaPartInput'
          type: array
        primers:
          description: Primer bind features on the RNA sequence. Primers on parts
            are not included.
          items:
            $ref: '#/components/schemas/PrimerInput'
          type: array
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
        translations:
          description: 'Translation annotations present on the RNA sequence. Translations
            may be one region or split

            across multiple regions. Translations on parts are not included.'
          items:
            $ref: '#/components/schemas/RnaTranslationInput'
          type: array
      required:
      - folderId
      - name
      type: object
    CreateRnaSequenceLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent RNA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - RNA_SEQUENCE_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateRnaSequenceSchemaInput:
      additionalProperties: false
      properties:
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          $ref: '#/components/schemas/CreateSequenceSchemaConstraintInput'
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTranslationLinkFieldDefinitionInput'
          type: array
        fieldsets:
          items:
            type: string
          type: array
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - OLIGO_V2
          - PRIMER_PAIR
          - RNA_SEQUENCE
          - SEQUENCE
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        showResidues:
          description: Controls whether RNA residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - organizationId
      - description
      - itemIdPrefix
      - showResidues
      type: object
    CreateScratchFileInput:
      additionalProperties: false
      properties:
        filename:
          type: string
        name:
          type: string
      required:
      - filename
      type: object
    CreateScratchPlateInput:
      additionalProperties: false
      properties:
        concentrationLayers:
          items:
            $ref: '#/components/schemas/ConcentrationLayerInput'
          type: array
        contents:
          items:
            $ref: '#/components/schemas/ContentItemInput'
          type: array
        height:
          type: integer
        measurements:
          items:
            $ref: '#/components/schemas/ScratchPlateMeasurementInput'
          type: array
        metadataLayers:
          items:
            $ref: '#/components/schemas/MetadataColumnInput'
          type: array
        name:
          type: string
        originDesignId:
          type: string
        parameterLayers:
          items:
            $ref: '#/components/schemas/ParameterLayerInput'
          type: array
        plateDesignTemplateId:
          type: string
        plateReaderAsm:
          $ref: '#/components/schemas/ScratchPlatePlateReaderAsmInput'
        plateSchemaId:
          type: string
        storageId:
          description: Inventory storage ID to record as a plate field in the metadata
            layer.
          type: string
        vendorFile:
          $ref: '#/components/schemas/ScratchPlateVendorFileInput'
        wells:
          items:
            $ref: '#/components/schemas/ScratchPlateWellInput'
          type: array
        width:
          type: integer
      required:
      - name
      type: object
    CreateSequenceSchemaConstraintInput:
      additionalProperties: false
      properties:
        fieldDefinitionNames:
          items:
            type: string
          type: array
        uniqueResidues:
          enum:
          - IGNORE_CASE
          type: string
      type: object
    CreateStorableLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - STORAGE_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateStudyInput:
      additionalProperties: false
      example:
        authorIds:
        - ent_a0SApq3z
        description: Study Description
        designEntryId: etr_kT6BHBdZ
        displayId: STUDY-001
        folderId: lib_o2thOLlq
        name: Study Name
        schemaFields:
          boolean_field_system_name:
            value: true
          date_field_system_name:
            value: '2025-01-01'
          datetime_field_system_name:
            value: '2025-01-01T00:00:00Z'
          dropdown_field_system_name:
            value: sfso_UcQuhAwx
          entity_field_system_name:
            value:
            - bfi_jdf8BV24
            - bfi_laGnl8vB
          inventory_field_system_name:
            value: con_YvTFCWmh
          json_field_system_name:
            value:
              key: value
          number_field_system_name:
            value: 123
          text_field_system_name:
            value: Text value
        schemaId: stdysch_ztQQGSSF
      properties:
        authorIds:
          description: The IDs of the users or apps to set as study authors. Omit
            to default to the creator. Pass an empty array to create the study without
            authors.
          items:
            type: string
          type: array
        description:
          type: string
        designEntryId:
          description: The ID of an entry to use as the study design entry. Each study
            must have a unique design entry. Custom Studies require a design entry.
            Should be omitted for all other study types.
          type: string
        displayId:
          description: The ID to assign to the study. Only allowed when the study
            schema is configured for manual ID assignment (i.e., `idGenerationMode`
            is `MANUAL`). Must be unique within the tenant.
          type: string
        folderId:
          description: The ID of the folder to create the study in.
          type: string
        name:
          description: The name of the study. Should be omitted if using a study schema
            with a naming template.
          type: string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          description: The ID of the schema to associate with this object.
          type: string
        studySchemaId:
          deprecated: true
          description: Deprecated. Use `schemaId` instead. The ID of the study schema.
          type: string
        tags:
          deprecated: true
          description: 'Deprecated. Use `schemaFields` instead. Schema fields to set
            on the study. Must correspond with the study schema''s field definitions.
            Every field should have its display name (not system name) or API ID as
            a key, mapping to the value of the field. See the example for the supported
            field value types and formatting. For date and datetime fields, use the
            RFC 3339 format. For single link fields, supply a single object specifying
            the id of the item you want to link, (eg. `{''targetFiles'': [{''id'':
            ''bfi_jdf8BV24''}]}`). For multi-link fields, supply an array of objects
            specifying the ids of the items you want to link, (eg. `{''targetFiles'':
            [{''id'': ''bfi_jdf8BV24''}, {''id'': ''bfi_laGnl8vB''}]}`). Exactly one
            of `schemaFields` or the deprecated `tags` must be specified.'
          type: object
      required:
      - description
      - folderId
      type: object
    CreateStudyItemAssociationInput:
      additionalProperties: false
      example:
        itemId: bfi_ldOK8IUg
        studyId: stdy_9CYiCggY
      properties:
        itemId:
          type: string
        studyId:
          type: string
      required:
      - studyId
      - itemId
      type: object
    CreateStudySchemaInput:
      additionalProperties: false
      example:
        description: Schema for phase II clinical trials.
        entryTemplateIds:
        - etr_kT6BHBdZ
        fieldDefinitions:
        - isRequired: true
          name: Therapeutic Area
          systemName: therapeutic_area
          type: TEXT
        - isRequired: false
          name: Target Enrollment
          systemName: target_enrollment
          type: INTEGER
        - isRequired: true
          name: Blinded
          systemName: blinded
          type: BOOLEAN
        idGenerationMode: AUTO_GENERATED_FROM_PREFIX
        isDesignApprovalRequired: true
        name: Phase II Clinical Study
        organizationId: org_a0SApq3z
        prefix: CLIN
        studyType: CLINICAL
      properties:
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        entryTemplateIds:
          description: Entry template IDs associated with this schema.
          items:
            type: string
          type: array
        fieldDefinitions:
          description: Field definitions for this schema.
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateJsonFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
          type: array
        idGenerationMode:
          description: 'How study IDs are assigned for studies created from this schema.
            AUTO_GENERATED_FROM_PREFIX requires a non-empty prefix. MANUAL requires
            an empty prefix and IDs to be provided at study creation. '
          enum:
          - AUTO_GENERATED_FROM_PREFIX
          - MANUAL
          type: string
        isDesignApprovalRequired:
          description: Whether design approval is required for studies of this schema.
          type: boolean
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        prefix:
          description: ID prefix for studies of this schema.
          type: string
        studyType:
          description: Type of studies created from this schema.
          enum:
          - CUSTOM
          - PROCESS_DEVELOPMENT
          - ASSAY_DEVELOPMENT
          - CLINICAL
          - PRECLINICAL
          type: string
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
      required:
      - organizationId
      - description
      - studyType
      - idGenerationMode
      type: object
    CreateSystemCategoryLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - SYSTEM_CATEGORY_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateTemplateAlignmentInput:
      additionalProperties: false
      properties:
        algorithm:
          enum:
          - MAFFT
          - CLUSTALO
          type: string
        clustaloOptions:
          $ref: '#/components/schemas/ClustalOOptionsInput'
          description: Options to pass to the ClustalO algorithm, only applicable
            for ClustalO.
        disableCircularSequenceRotation:
          description: When true, disables circular sequence rotation during template
            alignment.
          type: boolean
        files:
          description: Sequence files to align against the template. Minimum 1.
          items:
            $ref: '#/components/schemas/AlignmentFileInput'
          type: array
        mafftOptions:
          $ref: '#/components/schemas/MafftOptionsInput'
          description: Options to pass to the MAFFT algorithm, only applicable for
            MAFFT.
        name:
          description: The name of the alignment. When omitted, a name is automatically
            generated. If specified, it must contain at least one non-whitespace character.
            Up to 255 characters.
          type: string
        templateSequenceId:
          description: The API ID of the template (reference) sequence to align against.
          type: string
      required:
      - templateSequenceId
      - files
      - algorithm
      type: object
    CreateTestDefinitionInput:
      additionalProperties: false
      example:
        description: Standard blood chemistry measurements collected for study samples.
        name: Blood Chemistry Panel
        organizationId: org_v7Q9m2Kx
        resultSchemaId: assaysch_Z3xY7vQb
      properties:
        description:
          description: Human-readable description for the test definition. Empty strings
            are allowed; values must be at most 255 characters.
          type: string
        name:
          description: Display name for the test definition. Must be non-empty after
            trimming whitespace and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization that owns the test definition.
            Use `GET /benchling/organization/items` to list available organizations.
          type: string
        resultSchemaId:
          description: The API ID of the result schema that defines the shape of results
            captured for this test. Use `GET /benchling/result-schema/items` to list
            available result schemas.
          type: string
      required:
      - name
      - organizationId
      - resultSchemaId
      - description
      type: object
    CreateTextFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - TEXT
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      type: object
    CreateTextInput:
      additionalProperties: false
      properties:
        contentType:
          enum:
          - text
          type: string
        text:
          type: string
      required:
      - contentType
      - text
      type: object
    CreateTextMessageBlockInput:
      additionalProperties: false
      properties:
        text:
          type: string
        type:
          enum:
          - text
          type: string
      required:
      - type
      - text
      type: object
    CreateTranscriptionLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent RNA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - TRANSCRIPTION_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateTranslationLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        description:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent AA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - TRANSLATION_LINK
          type: string
      required:
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    CreateUnitInput:
      additionalProperties: false
      properties:
        aliases:
          description: Any additional short-form labels that should be recognized
            in input
          items:
            type: string
          type: array
        conversionFactor:
          format: decimal
          type: string
        name:
          type: string
        symbol:
          type: string
        unitTypeId:
          type: string
      required:
      - name
      - symbol
      - aliases
      - conversionFactor
      - unitTypeId
      type: object
    CreateUnitTypeInput:
      additionalProperties: false
      properties:
        baseUnit:
          $ref: '#/components/schemas/CreateBaseUnitInput'
        formula:
          items:
            $ref: '#/components/schemas/CreateFormulaUnitTermInput'
          type: array
        name:
          type: string
        overrideIsConcentration:
          description: When true, forces this UnitType to be treated as a concentration
            type regardless of its terms. When false, the classification is determined
            by the UnitType's terms. Mutually exclusive with `overrideIsContainerQuantity`.
          type: boolean
        overrideIsContainerQuantity:
          description: When true, forces this UnitType to be treated as a container
            quantity type regardless of its terms. When false, the classification
            is determined by the UnitType's terms. Mutually exclusive with `overrideIsConcentration`.
          type: boolean
        terms:
          items:
            $ref: '#/components/schemas/CreateUnitTypeTermInput'
          type: array
      required:
      - name
      - terms
      - baseUnit
      - overrideIsConcentration
      - overrideIsContainerQuantity
      type: object
    CreateUnitTypeTermInput:
      additionalProperties: false
      properties:
        exponent:
          type: integer
        value:
          enum:
          - TIME
          - LENGTH
          - MASS
          - CURRENT
          - TEMPERATURE
          - AMOUNT
          - LUMINOUS_INTENSITY
          type: string
      required:
      - value
      - exponent
      type: object
    CreateWarehouseCredentialCustomMethodInput:
      additionalProperties: false
      properties:
        expiresAt:
          description: The time after which new connections using the username/password
            will not be permitted. Upon expiration, currently open connections are
            not terminated.
          format: datetime
          type:
          - 'null'
          - string
        label:
          description: An optional label defined by the user who created the WarehouseCredential.
          type:
          - 'null'
          - string
      type: object
    CreateWarehouseCredentialOutput:
      description: 'Output of the create warehouse credential custom method. Contains
        the created credential

        and the one-time password that must be saved by the caller.'
      properties:
        password:
          description: 'The generated password for the warehouse credential. This
            value is only returned once

            at creation time and cannot be retrieved again.'
          type: string
        warehouseCredential:
          $ref: '#/components/schemas/WarehouseCredentialRef'
          description: The created WarehouseCredential.
      type: object
    CreateWellPlateInput:
      additionalProperties: false
      properties:
        barcode:
          description: Barcode of the plate
          type: string
        name:
          description: Name of the plate; defaults to barcode if name is not provided
          type: string
        parentStorageId:
          type: string
        projectId:
          type: string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          description: Schema field values that belong to the plate
          type: object
        schemaId:
          type: string
      required:
      - schemaId
      type: object
    CreateWellPlateSchemaInput:
      additionalProperties: false
      properties:
        containerSchemaId:
          description: The API ID of the container schema defining the well type for
            plates of this type.
          type: string
        description:
          description: A human-readable description of the schema. At most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        fieldDefinitions:
          description: The fields inherited by plates of this schema.
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
          type: array
        height:
          description: The number of rows in the grid layout.
          type: integer
        name:
          description: The user-facing name of the schema. Must be non-empty after
            stripping whitespace, at most 255 characters, and unique within the organization.
          type: string
        organizationId:
          description: The API ID of the organization this schema belongs to. The
            organization must exist and be accessible to the caller.
          type: string
        prefix:
          description: The prefix used for auto-generating barcodes for inventory
            items of this schema. Must be unique within the registry and cannot end
            in a digit.
          type: string
        systemName:
          description: The SQL identifier used as the warehouse table name. If not
            provided, one is auto-generated from the display name. Must match the
            pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start
            with 'bnch$', and must be unique within the organization.
          type: string
        width:
          description: The number of columns in the grid layout.
          type: integer
      required:
      - organizationId
      - description
      - prefix
      - height
      - width
      - containerSchemaId
      type: object
    CreateWorkflowOutputInput:
      additionalProperties: false
      properties:
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        taskId:
          type: string
      required:
      - taskId
      type: object
    CreateWorkflowTaskGroupInput:
      additionalProperties: false
      properties:
        folderId:
          type: string
        name:
          description: The name of the workflow task group
          type: string
        schemaId:
          type: string
        watcherIds:
          items:
            type: string
          type: array
      required:
      - folderId
      - schemaId
      type: object
    CreateWorkflowTaskInput:
      additionalProperties: false
      properties:
        assigneeId:
          type: string
        scheduledOn:
          description: The date on which the task is scheduled to be executed
          format: date
          type: string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        studyIds:
          items:
            type: string
          type: array
        workflowTaskGroupId:
          type: string
      required:
      - workflowTaskGroupId
      type: object
    CreateWorklistInput:
      additionalProperties: false
      properties:
        itemIds:
          items:
            type: string
          type: array
        itemType:
          enum:
          - CONTAINER
          - ENTITY
          - PLATE
          type: string
        name:
          type: string
      required:
      - name
      - itemType
      type: object
    CustomEntity:
      allOf:
      - $ref: '#/components/schemas/ICustomEntity'
      - description: 'A flexible, user-defined entity type in Benchling''s Registry.
          Unlike specialized entity

          types such as DnaSequence or Molecule, CustomEntities allow organizations
          to model any

          kind of scientific or business object using configurable EntitySchemas (see
          `schema`).

          CustomEntities support customFields for storing structured data, can be
          organized into

          Folders and Projects, and integrate with Benchling''s collaboration, search,
          and audit

          systems. They are commonly used to represent cell lines, reagents, instruments,
          or any

          domain-specific items that don''t fit predefined entity categories.'
        properties:
          __typename:
            type: string
          authors:
            oneOf:
            - format: uri
              type: string
            - type: 'null'
          creator:
            oneOf:
            - $ref: '#/components/schemas/PrincipalRef'
            - type: 'null'
          schemaFields:
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    CustomEntityCreatedWebhookEnvelopeV3:
      allOf:
      - $ref: '#/components/schemas/WebhookEnvelopeBaseV0'
      - properties:
          message:
            $ref: '#/components/schemas/CustomEntityCreatedWebhookV3'
        required:
        - message
        type: object
      description: Request body Benchling sends for a `v3.customEntity.created` event.
    CustomEntityCreatedWebhookV3:
      allOf:
      - $ref: '#/components/schemas/V3EventBase'
      - properties:
          type:
            description: The event type.
            enum:
            - v3.customEntity.created
            type: string
        required:
        - type
        type: object
      description: Message body of a `v3.customEntity.created` event.
    CustomEntityLinkFieldDefinition:
      description: A schema field definition for linking to custom entities.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent custom entity.
            Important for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinition:
          oneOf:
          - $ref: '#/components/schemas/CustomEntitySchemaRef'
          - type: 'null'
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    CustomEntityPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/CustomEntity'
          type: array
        nextToken:
          type: string
      type: object
    CustomEntityRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    CustomEntitySchema:
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/Constraint'
          - type: 'null'
        containableType:
          enum:
          - NONE
          - ENTITY
          - BATCH
          type: string
        containerNameTemplate:
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplate'
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          type: string
        fieldDefinitions:
          format: uri
          type: string
        fieldsets:
          format: uri
          type: string
        iconId:
          enum:
          - ANTIBODY
          - ARROW_ZIG_ZAG_DOWN
          - ARROW_ZIG_ZAG_RIGHT
          - ASSEMBLY
          - BACTERIA
          - BASIC_FOLDER_ITEM
          - BEAKER
          - BOX_ARROW_RIGHT
          - BROKEN_COLUMNS_IN_BRACKET
          - BUILDING_PLUS
          - CELL_LINE
          - CHEMICAL_COMPOUND
          - CHEMICAL_CONCATENATION
          - CHEMICAL_HOMOLOGY
          - CHEMICAL_LADDER
          - CHROMATOGRAPHY
          - CIRCLE_WITH_THICK_SEGMENT
          - CLIPBOARD_IN_BRACKETS
          - COMPOUND
          - DOCK_BOTTOM
          - FILE_BAR_CHART
          - FILE_IN_BRACKETS
          - FILL_GRID
          - FLASK
          - FLASK_RECEIPT
          - FLOWCHART
          - GRID_DOTS
          - HUMAN
          - INSTRUMENT
          - LIGHTBULB_IN_BRACKETS
          - LINEAR
          - LIST_ASTERISK
          - LIST_CHECK_XMARK
          - MATERIAL
          - MICROSCOPE
          - MIXTURE
          - MOLECULE_TO_BACKBONE
          - MOLECULE_TO_MOLECULE
          - MORTAR_PESTLE
          - MOUSE
          - NETWORK_WIRED
          - NODES_CONVERGE
          - OCHEM_MOLECULE
          - OCHEM_MOLECULE_BEAKER
          - OLIGO
          - OLIGO_ALT
          - OLIGO_V2
          - PART
          - PETRI
          - PLANT
          - PLASMID
          - POWDER
          - POWDER_BEAKER
          - PRIMER_PAIR
          - PROCESS
          - PROTEIN
          - PROTEIN_ALT
          - PROTEIN_MAGNIFYING_GLASS
          - REACTION_VESSEL
          - RECEIPT_FLASK
          - RECIPE
          - REQUEST_TEMPLATE
          - RNA
          - RNA_SEQUENCE
          - SAMPLE_SLIDE
          - SEQUENCE
          - SMALL_MOLECULE
          - SMALL_MOLECULE_BEAKER
          - SOLUTION
          - SQUARE_BRACKET_CHECK_EQUALS
          - TABLE_LIST_ALT
          - TEMPLATE
          - TUBE_EMPTY
          - VIAL
          - WELL_PLATE
          - WORKFLOW
          - WORKSHEET
          - WORM
          type: string
        id:
          type: string
        includeRegistryIdInChips:
          type: boolean
        itemIdPrefix:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        nameTemplate:
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplate'
          - type: 'null'
        organization:
          $ref: '#/components/schemas/OrganizationRef'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfiguration'
          type: array
        systemName:
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    CustomEntitySchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/CustomEntitySchema'
          type: array
        nextToken:
          type: string
      type: object
    CustomEntitySchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    CustomEntitySchemaSetFieldDefinitionsInput:
      additionalProperties: false
      properties:
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateSystemCategoryLinkFieldDefinitionInput'
          type: array
      required:
      - fieldDefinitions
      type: object
    CustomEntityUpdatedWebhookEnvelopeV3:
      allOf:
      - $ref: '#/components/schemas/WebhookEnvelopeBaseV0'
      - properties:
          message:
            $ref: '#/components/schemas/CustomEntityUpdatedWebhookV3'
        required:
        - message
        type: object
      description: Request body Benchling sends for a `v3.customEntity.updated` event.
    CustomEntityUpdatedWebhookV3:
      allOf:
      - $ref: '#/components/schemas/V3UpdateEventBase'
      - properties:
          type:
            description: The event type.
            enum:
            - v3.customEntity.updated
            type: string
        required:
        - type
        type: object
      description: Message body of a `v3.customEntity.updated` event.
    CustomField:
      description: 'A name-value pair for storing additional metadata on objects that
        support custom fields.

        CustomFields provide a flexible way to attach arbitrary string data to entities,
        containers,

        datasets, and other Benchling objects without modifying their schemas. Objects
        that can

        have custom fields implement the HasCustomFields interface. Unlike schema-defined
        fields,

        custom fields are not validated against a schema and can be freely added or
        modified.'
      properties:
        __typename:
          type: string
        name:
          type:
          - 'null'
          - string
        value:
          type:
          - 'null'
          - string
      type: object
    CustomFieldInput:
      additionalProperties: false
      properties:
        name:
          type: string
        value:
          type: string
      required:
      - name
      type: object
    CustomTransform:
      description: 'A data transform that delegates processing to an external Benchling
        App. The app

        is identified by its API ID in the transformation properties.'
      properties:
        __typename:
          type: string
        transformationProperties:
          description: Additional parameters for this transform
          oneOf:
          - $ref: '#/components/schemas/CustomTransformationProperties'
          - type: 'null'
        type:
          description: The type of this transform (CUSTOM)
          enum:
          - ADD_COLUMN
          - ARITHMETIC
          - CUSTOM
          - DUPLICATE
          - EXTRA_HEADERS
          - EXTRA_FOOTERS
          - FILTER
          - FIND_REPLACE
          - MERGE
          - MELT
          - PLATE_SHAPE
          - PIVOT
          - REMOVE_QUOTES
          - SPLIT
          - null
          type:
          - 'null'
          - string
      type: object
    CustomTransformationProperties:
      description: 'Properties for a CUSTOM transform, identifying the Benchling App
        that performs the

        transformation via its API ID.'
      properties:
        __typename:
          type: string
        transformId:
          description: API ID of a Benchling App that performs the transform
          type:
          - 'null'
          - string
      type: object
    CutSiteDetail:
      description: 'Describes the cleavage pattern of a restriction enzyme relative
        to its recognition site.

        The position field indicates where the 5'' strand is cut, while offset specifies
        the distance

        from position where the 3'' strand is cut. A zero offset produces blunt ends;
        non-zero offsets

        create sticky ends (overhangs). Enzymes that cut once have a single CutSiteDetail,
        while

        rare double-cutting enzymes have two. This information is essential for predicting
        fragment

        sizes and compatible ends when designing cloning strategies.'
      properties:
        __typename:
          type: string
        offset:
          description: Location, relative to `position`, where the 3' cut is made.
          type: integer
        position:
          description: Location, relative to the restriction site bases, where the
            5' cut is made.
          type: integer
      type: object
    DataFrame:
      description: '`DataFrame` stores non-schematized tabular data, with Benchling-aware
        column types (see `DataFrameColumn`).

        Data frames are not searchable and lack their own permissions; rather, they
        are child objects of pipelines

        (via `PipelineStepData`), datasets (see `Dataset`), and app canvases. Row
        data is stored in S3. Data frames

        are immutable; if data is updated, a new `DataFrame` is created.'
      properties:
        __typename:
          type: string
        columns:
          items:
            $ref: '#/components/schemas/DataFrameColumn'
          type: array
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        dataset:
          oneOf:
          - $ref: '#/components/schemas/DatasetRef'
          - type: 'null'
        errorMessage:
          type:
          - 'null'
          - string
        id:
          type: string
        manifest:
          items:
            $ref: '#/components/schemas/DataFrameManifestItem'
          type: array
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        size:
          type: integer
        uploadStatus:
          enum:
          - SUCCEEDED
          - FAILED_VALIDATION
          - IN_PROGRESS
          - NOT_UPLOADED
          type: string
      type: object
    DataFrameColumn:
      description: 'Defines a column within a DataFrame, including its internal system
        name, user-facing

        display name, and data type specification.'
      properties:
        __typename:
          type: string
        displayName:
          type: string
        systemName:
          type: string
        type:
          type: object
      type: object
    DataFrameManifestItem:
      description: 'Represents one part of a DataFrame''s downloadable row data. Currently,
        the manifest

        always contains exactly one item. The array structure is forward-compatible
        with future

        multi-part download support for large data frames.'
      properties:
        __typename:
          type: string
        fileName:
          type: string
        url:
          type: string
      type: object
    DataFramePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/DataFrame'
          type: array
        nextToken:
          type: string
      type: object
    DataFrameRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    DataParameterValuePlan:
      description: 'A pre-filled value for a data parameter within a `MethodParametersPlan`.
        The `parameterId`

        references the `ProcedureParameterVersion` this value applies to. The `value`
        field contains

        the planned data in JSON format, which may be a number, string, or structured
        value depending

        on the parameter''s data type configuration. Used during experiment planning
        to specify default

        values that will populate the parameter when the procedure run is created.'
      properties:
        __typename:
          type: string
        parameterId:
          type: string
        value:
          type: object
      type: object
    DataParameterValuePlanInput:
      additionalProperties: false
      properties:
        parameterId:
          description: 'The ID of the procedure parameter version. Format: `schver_XXXXXXXX`.'
          type: string
        value:
          description: 'A dict with the shape {"value": <TypedValue | null>}. The
            inner TypedValue must match the referenced parameter''s configured data
            type. Supported types are ft_float, ft_string, and ft_datetime (e.g.,
            {"type": "ft_float", "floatValue": 1.5, "value": "1.5"} for numeric, {"type":
            "ft_string", "value": "text"} for text, or {"type": "ft_datetime", ...}
            for datetime). For plate-map-confirmed parameters with multiple setpoints,
            send one DataParameterValuePlanInput per setpoint, each with a scalar
            TypedValue.'
          type: object
      required:
      - parameterId
      - value
      type: object
    Dataset:
      description: '`Dataset` stores non-schematized tabular data, with Benchling-aware
        column types.


        Datasets are first-class, searchable, archivable folder items. A Dataset''s
        actual data is stored in a

        `DataFrame`.'
      properties:
        __typename:
          type: string
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        dataFrameId:
          type:
          - 'null'
          - string
        displayId:
          type:
          - 'null'
          - string
        folder:
          $ref: '#/components/schemas/FolderRef'
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type:
          - 'null'
          - string
      type: object
    DatasetPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Dataset'
          type: array
        nextToken:
          type: string
      type: object
    DatasetRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    DateAppConfigSpec:
      description: Specifies that an app configuration field should accept a date
        value.
      properties:
        __typename:
          type: string
        requiredConfig:
          type:
          - 'null'
          - boolean
      type: object
    DateAppConfigValue:
      description: Stores a date value in an app configuration field.
      properties:
        __typename:
          type: string
        value:
          format: date
          type:
          - 'null'
          - string
      type: object
    DateCellEvaluationValue:
      description: A date evaluation value.
      properties:
        __typename:
          type: string
        value:
          format: date
          type: string
      type: object
    DateFieldDefinition:
      description: A date field definition for date-only values (without time).
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    DateTimeAppConfigSpec:
      description: Specifies that an app configuration field should accept a datetime
        value.
      properties:
        __typename:
          type: string
        requiredConfig:
          type:
          - 'null'
          - boolean
      type: object
    DateTimeAppConfigValue:
      description: Stores a datetime value in an app configuration field.
      properties:
        __typename:
          type: string
        value:
          type:
          - 'null'
          - string
      type: object
    DateTimeCellEvaluationValue:
      description: A datetime evaluation value.
      properties:
        __typename:
          type: string
        value:
          format: datetime
          type: string
      type: object
    DateTimeFieldDefinition:
      description: A datetime field definition for date and time values with timezone
        support.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    DateTimeValue:
      description: A type that represents datetime values.
      properties:
        __typename:
          type: string
        value:
          description: The datetime value with UTC as the timezone.
          format: datetime
          type: string
      type: object
    DateValue:
      description: A type that represents date values.
      properties:
        __typename:
          type: string
        value:
          description: The date value.
          format: date
          type: string
      type: object
    DecimalValue:
      description: A type that represents decimal value as strings.
      properties:
        __typename:
          type: string
        numericValue:
          deprecated: true
          description: Deprecated. The float representation of the decimal value.
          type:
          - 'null'
          - number
        value:
          description: The decimal value in a string representation
          type:
          - 'null'
          - string
      type: object
    DeleteCollaborationInputWithPathParams:
      additionalProperties: false
      properties:
        id:
          type: string
      required:
      - id
      type: object
    DeleteDocumentPartsInput:
      additionalProperties: false
      properties:
        coordinates:
          $ref: '#/components/schemas/RangeCoordinates'
        operationType:
          enum:
          - delete
          type: string
        version:
          type: string
      required:
      - operationType
      - version
      - coordinates
      type: object
    DeleteFolderInputWithPathParams:
      additionalProperties: false
      properties:
        id:
          type: string
      required:
      - id
      type: object
    DeleteNucleotideAlignmentInputWithPathParams:
      additionalProperties: false
      properties:
        id:
          type: string
      required:
      - id
      type: object
    DeleteProcedureMethodExecutionInstanceAssociationInputWithPathParams:
      additionalProperties: false
      properties:
        id:
          type: string
      required:
      - id
      type: object
    DeleteStudyItemAssociationInputWithPathParams:
      additionalProperties: false
      properties:
        id:
          type: string
      required:
      - id
      type: object
    DeleteWorklistInputWithPathParams:
      additionalProperties: false
      properties:
        id:
          type: string
      required:
      - id
      type: object
    DnaChainConfigurationInput:
      additionalProperties: false
      properties:
        systemCategoryId:
          enum:
          - ssi_dnachain
          type: string
      required:
      - systemCategoryId
      type: object
    DnaDomainConfigurationInput:
      additionalProperties: false
      properties:
        systemCategoryId:
          enum:
          - ssi_dnadomain
          type: string
      required:
      - systemCategoryId
      type: object
    DnaOligo:
      allOf:
      - $ref: '#/components/schemas/IDnaOligo'
      - description: 'Represents a short single-stranded DNA oligonucleotide in Benchling''s
          molecular biology

          platform. DNA oligos are typically synthetic sequences used as primers for
          PCR, probes

          for hybridization assays, or components in cloning workflows. Each oligo
          stores its

          nucleotide base sequence, annotations for features of interest, and any
          chemical

          modifications (see ModifiedNucleotide) such as phosphorothioate backbones
          or fluorescent

          labels. Oligos can be registered in the Registry with unique identifiers,
          organized in

          folders, and linked to other entities via schema fields. Unlike DnaSequence,
          oligos are

          specifically designed for shorter, synthesizable sequences. Also referred
          to as primers

          or probes depending on their application.'
        properties:
          __typename:
            type: string
          authors:
            oneOf:
            - format: uri
              type: string
            - type: 'null'
          creator:
            oneOf:
            - $ref: '#/components/schemas/PrincipalRef'
            - type: 'null'
          schemaFields:
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    DnaOligoCreatedWebhookEnvelopeV3:
      allOf:
      - $ref: '#/components/schemas/WebhookEnvelopeBaseV0'
      - properties:
          message:
            $ref: '#/components/schemas/DnaOligoCreatedWebhookV3'
        required:
        - message
        type: object
      description: Request body Benchling sends for a `v3.dnaOligo.created` event.
    DnaOligoCreatedWebhookV3:
      allOf:
      - $ref: '#/components/schemas/V3EventBase'
      - properties:
          type:
            description: The event type.
            enum:
            - v3.dnaOligo.created
            type: string
        required:
        - type
        type: object
      description: Message body of a `v3.dnaOligo.created` event.
    DnaOligoLinkFieldDefinition:
      description: A schema field definition for linking to DNA Oligos.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent DNA Oligo. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinition:
          $ref: '#/components/schemas/DnaOligoSchemaRef'
          description: The linked item must be of this schema. This is required because
            we do not allow linking to a generic DNA Oligo.
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    DnaOligoPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/DnaOligo'
          type: array
        nextToken:
          type: string
      type: object
    DnaOligoSchema:
      description: Defines the structure, field definitions, and configuration options
        for DNA oligos.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/Constraint'
          - type: 'null'
        containableType:
          enum:
          - NONE
          - ENTITY
          - BATCH
          type: string
        containerNameTemplate:
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplate'
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          type: string
        fieldDefinitions:
          format: uri
          type: string
        fieldsets:
          format: uri
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - OLIGO
          - OLIGO_V2
          - PRIMER_PAIR
          - SEQUENCE
          type: string
        id:
          type: string
        includeRegistryIdInChips:
          type: boolean
        itemIdPrefix:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        nameTemplate:
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplate'
          - type: 'null'
        organization:
          $ref: '#/components/schemas/OrganizationRef'
        showResidues:
          description: Controls whether DNA residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfiguration'
          type: array
        systemName:
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    DnaOligoSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/DnaOligoSchema'
          type: array
        nextToken:
          type: string
      type: object
    DnaOligoSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    DnaOligoSchemaSetFieldDefinitionsInput:
      additionalProperties: false
      properties:
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateSystemCategoryLinkFieldDefinitionInput'
          type: array
      required:
      - fieldDefinitions
      type: object
    DnaOligoUpdatedWebhookEnvelopeV3:
      allOf:
      - $ref: '#/components/schemas/WebhookEnvelopeBaseV0'
      - properties:
          message:
            $ref: '#/components/schemas/DnaOligoUpdatedWebhookV3'
        required:
        - message
        type: object
      description: Request body Benchling sends for a `v3.dnaOligo.updated` event.
    DnaOligoUpdatedWebhookV3:
      allOf:
      - $ref: '#/components/schemas/V3UpdateEventBase'
      - properties:
          type:
            description: The event type.
            enum:
            - v3.dnaOligo.updated
            type: string
        required:
        - type
        type: object
      description: Message body of a `v3.dnaOligo.updated` event.
    DnaPairConfigurationInput:
      additionalProperties: false
      properties:
        systemCategoryId:
          enum:
          - ssi_dnapair
          type: string
      required:
      - systemCategoryId
      type: object
    DnaPart:
      description: 'Represents a region on a DNA sequence that matches or is derived
        from another registered

        DNA sequence. DnaPart features enable tracking the provenance of sequence
        regions, such

        as identifying that a particular gene in a construct originates from a specific
        source

        sequence. Each part specifies the referenced DnaSequence, the strand orientation
        (forward

        or reverse), and the position range using 0-based coordinates with an exclusive
        end index.

        Parts appear as visual features on the sequence viewer and support traceability
        from

        assembled constructs back to their component sequences.'
      properties:
        __typename:
          type: string
        containerSequence:
          $ref: '#/components/schemas/DnaSequenceRef'
          description: The DNA sequence that contains this part.
        end:
          description: '0-based exclusive end index. For ranges ending at the end
            of a circular sequence, this value is

            always the length of the sequence, never 0.'
          type: integer
        id:
          description: The ID of the DNA Part.
          type: string
        sequence:
          $ref: '#/components/schemas/DnaSequenceRef'
          description: DNA sequence this part refers to.
        start:
          description: 0-based inclusive start index.
          type: integer
        strand:
          description: Strand for this part; 1 for forward strand, -1 for reverse
            strand.
          type: integer
      type: object
    DnaPartLinkFieldDefinition:
      description: A schema field definition for linking to DNA parts.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent DNA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    DnaPartUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/DnaPart'
          type: array
      type: object
    DnaSequence:
      allOf:
      - $ref: '#/components/schemas/IDnaSequence'
      - description: 'Represents a DNA sequence in Benchling''s molecular biology
          platform. A `DnaSequence` stores the nucleotide

          bases of the forward strand along with rich annotations for biological features
          such as genes, promoters, and

          regulatory elements. Sequences can be linear or circular (controlled by
          `isCircular`) and support translation

          annotations for protein-coding regions (see `Translation`), primer binding
          sites (see `Primer`), and part

          features linking to other sequences (see `DnaPart`). DNA sequences can be
          registered in the Registry with a

          unique `entityRegistryId`, organized in folders, and linked to other entities
          via schema fields. Also known as

          "Sequence" in the Benchling interface, with IDs prefixed by ''seq''.'
        properties:
          __typename:
            type: string
          authors:
            oneOf:
            - format: uri
              type: string
            - type: 'null'
          creator:
            oneOf:
            - $ref: '#/components/schemas/PrincipalRef'
            - type: 'null'
          schemaFields:
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    DnaSequenceCreatedWebhookEnvelopeV3:
      allOf:
      - $ref: '#/components/schemas/WebhookEnvelopeBaseV0'
      - properties:
          message:
            $ref: '#/components/schemas/DnaSequenceCreatedWebhookV3'
        required:
        - message
        type: object
      description: Request body Benchling sends for a `v3.dnaSequence.created` event.
    DnaSequenceCreatedWebhookV3:
      allOf:
      - $ref: '#/components/schemas/V3EventBase'
      - properties:
          type:
            description: The event type.
            enum:
            - v3.dnaSequence.created
            type: string
        required:
        - type
        type: object
      description: Message body of a `v3.dnaSequence.created` event.
    DnaSequenceLinkFieldDefinition:
      description: A schema field definition for linking to DNA sequences.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent DNA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinition:
          oneOf:
          - $ref: '#/components/schemas/DnaSequenceSchemaRef'
          - type: 'null'
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    DnaSequencePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/DnaSequence'
          type: array
        nextToken:
          type: string
      type: object
    DnaSequenceRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    DnaSequenceSchema:
      description: Defines the structure, field definitions, and configuration options
        for DNA sequences.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/Constraint'
          - type: 'null'
        containableType:
          enum:
          - NONE
          - ENTITY
          - BATCH
          type: string
        containerNameTemplate:
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplate'
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          type: string
        fieldDefinitions:
          format: uri
          type: string
        fieldsets:
          format: uri
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - OLIGO_V2
          - PLASMID
          - PRIMER_PAIR
          - RNA_SEQUENCE
          - SEQUENCE
          type: string
        id:
          type: string
        includeRegistryIdInChips:
          type: boolean
        itemIdPrefix:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        nameTemplate:
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplate'
          - type: 'null'
        organization:
          $ref: '#/components/schemas/OrganizationRef'
        showResidues:
          description: Controls whether DNA residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfiguration'
          type: array
        systemName:
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    DnaSequenceSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/DnaSequenceSchema'
          type: array
        nextToken:
          type: string
      type: object
    DnaSequenceSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    DnaSequenceSchemaSetFieldDefinitionsInput:
      additionalProperties: false
      properties:
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaPartLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTranscriptionLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTranslationLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaPartLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateTranscriptionLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateTranslationLinkFieldDefinitionInput'
          type: array
      required:
      - fieldDefinitions
      type: object
    DnaSequenceUpdatedWebhookEnvelopeV3:
      allOf:
      - $ref: '#/components/schemas/WebhookEnvelopeBaseV0'
      - properties:
          message:
            $ref: '#/components/schemas/DnaSequenceUpdatedWebhookV3'
        required:
        - message
        type: object
      description: Request body Benchling sends for a `v3.dnaSequence.updated` event.
    DnaSequenceUpdatedWebhookV3:
      allOf:
      - $ref: '#/components/schemas/V3UpdateEventBase'
      - properties:
          type:
            description: The event type.
            enum:
            - v3.dnaSequence.updated
            type: string
        required:
        - type
        type: object
      description: Message body of a `v3.dnaSequence.updated` event.
    DnaSubElementConfigurationInput:
      additionalProperties: false
      properties:
        systemCategoryId:
          enum:
          - ssi_dnasubelement
          type: string
      required:
      - systemCategoryId
      type: object
    DocumentContentInput:
      allOf:
      - properties:
          contentType:
            enum:
            - attachment
            - benchling_item
            - code_block
            - header
            - list_item
            - section
            - text
            - unstructured_table
            type: string
        required:
        - contentType
      - oneOf:
        - $ref: '#/components/schemas/AttachmentContentInput'
        - $ref: '#/components/schemas/BenchlingItemContentInput'
        - $ref: '#/components/schemas/CodeBlockContentInput'
        - $ref: '#/components/schemas/HeaderContentInput'
        - $ref: '#/components/schemas/ListItemContentInput'
        - $ref: '#/components/schemas/SectionContentInput'
        - $ref: '#/components/schemas/TextContentInput'
        - $ref: '#/components/schemas/UnstructuredTableContentInput'
      discriminator:
        propertyName: contentType
      type: object
    DocumentEmbeddable:
      anyOf:
      - $ref: '#/components/schemas/AaSequence'
      - $ref: '#/components/schemas/CustomEntity'
      - $ref: '#/components/schemas/DnaSequence'
      - $ref: '#/components/schemas/Entry'
      - $ref: '#/components/schemas/OligoConjugate'
      - $ref: '#/components/schemas/OligoDuplex'
      - $ref: '#/components/schemas/Protein'
      - $ref: '#/components/schemas/UnresolvableEmbeddedItem'
      discriminator:
        propertyName: __typename
      type: object
    DocumentLikeRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    DocumentLikeVersionMetadata:
      description: 'Version metadata for a DocumentLike-style entry. Captures the
        API identifier of a

        particular version snapshot together with the time that version was produced.
        Useful for

        change tracking, history pinning, and consumers that need to detect or reference
        a

        specific revision of an entry, template, subtemplate, or stage entry without
        fetching the

        full version record.'
      properties:
        __typename:
          type: string
        createdAt:
          description: 'DateTime this version was created. Versions are immutable
            snapshots, so this is the

            moment the version came into existence — i.e., when the DocumentLike''s
            content was

            last edited to produce this version.'
          format: datetime
          type:
          - 'null'
          - string
        versionId:
          description: API ID of this version of the DocumentLike.
          type: string
      type: object
    DocumentPart:
      description: 'Represents an ordered piece of content within an entry, template,
        subtemplate, or document.

        Each document part wraps one content block and records its container, version,
        and audit metadata.'
      properties:
        __typename:
          type: string
        content:
          description: Union of SectionDocumentContent, TextDocumentContent, ListItemDocumentContent,
            HeaderDocumentContent, CodeBlockDocumentContent, UnstructuredTableDocumentContentSummary,
            AttachmentDocumentContent, BenchlingItemDocumentContent, RunDocumentContent,
            TextBoxDocumentContent
          oneOf:
          - anyOf:
            - $ref: '#/components/schemas/SectionDocumentContent'
            - $ref: '#/components/schemas/TextDocumentContent'
            - $ref: '#/components/schemas/ListItemDocumentContent'
            - $ref: '#/components/schemas/HeaderDocumentContent'
            - $ref: '#/components/schemas/CodeBlockDocumentContent'
            - $ref: '#/components/schemas/UnstructuredTableDocumentContentSummary'
            - $ref: '#/components/schemas/AttachmentDocumentContent'
            - $ref: '#/components/schemas/BenchlingItemDocumentContent'
            - $ref: '#/components/schemas/RunDocumentContent'
            - $ref: '#/components/schemas/TextBoxDocumentContent'
            discriminator:
              propertyName: __typename
          - type: 'null'
        createdAt:
          description: 'Timestamp inherited from the document content backing this
            part. For entry and

            document content, this can reflect when the containing document was created,

            not when the DocumentPart identifier was created.'
          format: datetime
          type:
          - 'null'
          - string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        modifier:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        versionId:
          type: string
      type: object
    DocumentPartPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/DocumentPart'
          type: array
        nextToken:
          type: string
      type: object
    DomainLinkedSchema:
      description: 'Links a specific domain type and specificity combination to an
        entity schema or interface.

        Used in protein schema configurations to specify which schema governs entities
        created

        for each domain position in the protein structure.'
      properties:
        __typename:
          type: string
        domainType:
          enum:
          - VL
          - CL
          - VH
          - VHH
          - CH1
          - CH2
          - CH3
          - CH4
          - J
          - H
          - L
          - VA
          - CA
          - VB
          - CB
          - VG
          - CG
          - VD
          - CD
          - F
          - ELEMENT
          type: string
        schemaOrInterfaceId:
          type:
          - 'null'
          - string
        specificity:
          type:
          - 'null'
          - string
      type: object
    DomainLinkedSchemaInput:
      additionalProperties: false
      properties:
        label:
          description: Domain label from the protein format to map to a schema.
          type: string
        schemaOrInterfaceId:
          description: API ID of the schema or schema interface to use for the domain
            label.
          type: string
      required:
      - label
      - schemaOrInterfaceId
      type: object
    Dropdown:
      description: 'A configurable list of predefined values used for standardizing
        data entry in schema fields.

        Dropdowns provide controlled vocabulary choices that ensure consistency when
        users fill out

        entity and object fields. Each Dropdown belongs to a Registry (see `registry`)
        and contains

        one or more selectable options (see `DropdownOption`). Dropdowns are referenced
        by schema

        field definitions (see `DropdownLinkFieldDefinition`) to constrain the allowed
        values for a

        field. Organizations use dropdowns to enforce standardized terminology across
        experiments,

        samples, and other registered entities.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        id:
          description: ID of the dropdown
          type: string
        name:
          description: Name of the dropdown
          type: string
        options:
          description: Array of dropdown options
          format: uri
          type: string
        registry:
          $ref: '#/components/schemas/RegistryRef'
          description: The registry that the dropdown belongs to
      type: object
    DropdownAppConfigSpec:
      description: Specifies that an app configuration field should be a dropdown
        with predefined options.
      properties:
        __typename:
          type: string
        options:
          oneOf:
          - items:
              $ref: '#/components/schemas/AppConfigDropdownOption'
            type: array
          - type: 'null'
        requiredConfig:
          type:
          - 'null'
          - boolean
      type: object
    DropdownLinkFieldDefinition:
      description: 'A schema field definition that links to a dropdown for value selection.
        The `linkDefinition` field

        references the `Dropdown` configuration that defines the available options.
        When `isMulti`

        is true, users can select multiple dropdown options for a single field value.
        The dropdown

        provides controlled vocabulary for consistent data entry across the organization.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        linkDefinition:
          $ref: '#/components/schemas/DropdownRef'
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    DropdownLinkFieldDefinitionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/DropdownLinkFieldDefinition'
          type: array
        nextToken:
          type: string
      type: object
    DropdownMultiValueUiBlock:
      description: A multi-select dropdown block backed by a Benchling dropdown registry.
      properties:
        __typename:
          type: string
        dropdownId:
          type: string
        enabled:
          type:
          - 'null'
          - boolean
        id:
          type: string
        label:
          type:
          - 'null'
          - string
        placeholder:
          type:
          - 'null'
          - string
        required:
          type:
          - 'null'
          - boolean
        value:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
      type: object
    DropdownMultiValueUiBlockInput:
      additionalProperties: false
      properties:
        dropdownId:
          type: string
        enabled:
          type: boolean
        id:
          type: string
        label:
          type: string
        placeholder:
          type: string
        required:
          type: boolean
        type:
          enum:
          - DROPDOWN_MULTIVALUE
          type: string
        value:
          items:
            type: string
          type: array
      required:
      - type
      - id
      - dropdownId
      type: object
    DropdownOption:
      description: 'An individual selectable value within a Dropdown. Each DropdownOption
        represents one valid

        choice that users can select when populating a schema field configured with
        the parent

        Dropdown. Options can be archived to remove them from the available choices
        while preserving

        historical data that references them. The option''s name is displayed to users
        when selecting

        values.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        id:
          type: string
        name:
          type: string
      type: object
    DropdownOptionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/DropdownOption'
          type: array
        nextToken:
          type: string
      type: object
    DropdownOptionUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/DropdownOption'
          type: array
      type: object
    DropdownPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Dropdown'
          type: array
        nextToken:
          type: string
      type: object
    DropdownRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    DropdownUiBlock:
      description: A dropdown block backed by a Benchling dropdown registry.
      properties:
        __typename:
          type: string
        dropdownId:
          type: string
        enabled:
          type:
          - 'null'
          - boolean
        id:
          type: string
        label:
          type:
          - 'null'
          - string
        placeholder:
          type:
          - 'null'
          - string
        required:
          type:
          - 'null'
          - boolean
        value:
          type:
          - 'null'
          - string
      type: object
    DropdownUiBlockInput:
      additionalProperties: false
      properties:
        dropdownId:
          type: string
        enabled:
          type: boolean
        id:
          type: string
        label:
          type: string
        placeholder:
          type: string
        required:
          type: boolean
        type:
          enum:
          - DROPDOWN
          type: string
        value:
          type: string
      required:
      - type
      - id
      - dropdownId
      type: object
    DuplicateTransform:
      description: A data transform that copies an existing column to a new column
        with a different name.
      properties:
        __typename:
          type: string
        transformationProperties:
          description: Additional parameters for this transform
          oneOf:
          - $ref: '#/components/schemas/DuplicateTransformationProperties'
          - type: 'null'
        type:
          description: The type of this transform (DUPLICATE)
          enum:
          - ADD_COLUMN
          - ARITHMETIC
          - CUSTOM
          - DUPLICATE
          - EXTRA_HEADERS
          - EXTRA_FOOTERS
          - FILTER
          - FIND_REPLACE
          - MERGE
          - MELT
          - PLATE_SHAPE
          - PIVOT
          - REMOVE_QUOTES
          - SPLIT
          - null
          type:
          - 'null'
          - string
      type: object
    DuplicateTransformationProperties:
      description: 'Properties for a DUPLICATE transform, specifying the source column
        to copy and the

        name for the new duplicate column.'
      properties:
        __typename:
          type: string
        columnToDuplicate:
          description: Name of column to be duplicated
          type:
          - 'null'
          - string
        newColumnName:
          description: Name of new column created by duplicating
          type:
          - 'null'
          - string
      type: object
    EditingTargetInput:
      allOf:
      - properties:
          type:
            enum:
            - entry
            type: string
        required:
        - type
      - oneOf:
        - $ref: '#/components/schemas/EntryEditingTargetInput'
      discriminator:
        propertyName: type
      type: object
    EntityAssociation:
      description: 'Every entity association maps a Benchling entity to one or more
        HELM references in the complex polymer.

        These HELM polymers each have the same chemical structure as the Benchling
        entity.


        For example, if a molecule entity maps to two CHEM polymers, it means that
        the molecule appears twice in the complex polymer.'
      properties:
        __typename:
          type: string
        entity:
          $ref: '#/components/schemas/ObjectRef'
          description: Union of RnaOligo, DnaOligo, RnaSequence, DnaSequence, Molecule,
            AaSequence
        polymerRefs:
          description: HELM polymer references identifying which polymers in the structure
            correspond to this entity.
          items:
            type: string
          type: array
      type: object
    EntityLinkCellEvaluationValue:
      description: An entity-link evaluation value referencing a registry entity.
      properties:
        __typename:
          type: string
        id:
          type: string
        name:
          type: string
      type: object
    EntityNameTemplate:
      description: A name template for entities.
      properties:
        __typename:
          type: string
        parts:
          items:
            $ref: '#/components/schemas/EntityNameTemplatePart'
          type: array
        shouldOrderPartsBySequence:
          type: boolean
      type: object
    EntityNameTemplateInput:
      additionalProperties: false
      properties:
        nameTemplateParts:
          items:
            $ref: '#/components/schemas/EntityNameTemplatePartInput'
          type: array
        shouldOrderPartsBySequence:
          type: boolean
      required:
      - nameTemplateParts
      - shouldOrderPartsBySequence
      type: object
    EntityNameTemplatePart:
      description: A part in an entity name template.
      properties:
        __typename:
          type: string
        configuration:
          description: Union of TextNameTemplatePartConfiguration, FieldNameTemplatePartConfiguration,
            ProteinChainNameTemplatePartConfiguration, ProteinDomainNameTemplatePartConfiguration
          oneOf:
          - anyOf:
            - $ref: '#/components/schemas/TextNameTemplatePartConfiguration'
            - $ref: '#/components/schemas/FieldNameTemplatePartConfiguration'
            - $ref: '#/components/schemas/ProteinChainNameTemplatePartConfiguration'
            - $ref: '#/components/schemas/ProteinDomainNameTemplatePartConfiguration'
            discriminator:
              propertyName: __typename
          - type: 'null'
        type:
          enum:
          - CHILD_ENTITY_LOT_NUMBER
          - COMPLEX_POLYMER_COMPONENT
          - CREATED_AT_DATE
          - CREATED_AT_YEAR
          - FIELD
          - HOISTED_FIELD
          - LINKED_BIOENTITY_REGISTRY_IDENTIFIER
          - PROJECT
          - PROTEIN_CHAIN
          - PROTEIN_DOMAIN
          - REGISTRY_IDENTIFIER_NUMBER
          - REGISTRY_IDENTIFIER_NUMBER_BASE_26
          - SALT_CODES
          - SEPARATOR
          - TEXT
          type: string
      type: object
    EntityNameTemplatePartInput:
      additionalProperties: false
      properties:
        configuration:
          anyOf:
          - $ref: '#/components/schemas/TextNameTemplatePartConfigurationInput'
          - $ref: '#/components/schemas/FieldNameTemplatePartConfigurationInput'
          - $ref: '#/components/schemas/ProteinChainNameTemplatePartConfigurationInput'
          - $ref: '#/components/schemas/ProteinDomainNameTemplatePartConfigurationInput'
        type:
          enum:
          - CHILD_ENTITY_LOT_NUMBER
          - COMPLEX_POLYMER_COMPONENT
          - CREATED_AT_DATE
          - CREATED_AT_YEAR
          - FIELD
          - LINKED_BIOENTITY_REGISTRY_IDENTIFIER
          - PROJECT
          - PROTEIN_CHAIN
          - PROTEIN_DOMAIN
          - REGISTRY_IDENTIFIER_NUMBER
          - SALT_CODES
          - SEPARATOR
          - TEXT
          type: string
      required:
      - type
      type: object
    EntityRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    EntitySchema:
      description: 'Defines the structure and behavior for a category of registered
        entities in Benchling.

        EntitySchemas specify the field definitions (see `fieldDefinitions` and `SchemaFieldDefinition`)

        that determine what data can be stored on entities of this type. Each schema
        belongs to a

        Registry (see `registry`) and has a prefix used for generating entity IDs.
        Schemas can

        enforce uniqueness constraints (see `constraint`) and configure whether entities
        can be

        stored in containers (see `containableType`). Access is controlled through
        collaborations

        (see `Collaboration`). Common entity types include DNA sequences, proteins,
        molecules,

        and custom entities, determined by the schema''s type field.'
      properties:
        __typename:
          type: string
        archiveReason:
          description: Reason the EntitySchema was archived
          type:
          - 'null'
          - string
        archived:
          description: If the EntitySchema is archived
          type: boolean
        availableRegistrationNamingOptions:
          description: Naming strategies allowed when registering entities of this
            schema
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/Constraint'
          - type: 'null'
        containableType:
          enum:
          - NONE
          - ENTITY
          - BATCH
          type: string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          type: string
        fieldDefinitions:
          format: uri
          type: string
        id:
          type: string
        modifiedAt:
          description: DateTime the Entity Schema was last modified
          format: datetime
          type: string
        name:
          type: string
        prefix:
          type: string
        registry:
          $ref: '#/components/schemas/RegistryRef'
          description: Registry the EntitySchema is in
        type:
          type: string
      type: object
    EntitySchemaAppConfigSpec:
      description: 'Specifies that an app configuration field should reference an
        entity schema.

        Kept separate from SchemaAppConfigSpec because it carries a subtype constraint.'
      properties:
        __typename:
          type: string
        fieldDefinitions:
          oneOf:
          - items:
              $ref: '#/components/schemas/AppConfigFieldDefinition'
            type: array
          - type: 'null'
        requiredConfig:
          type:
          - 'null'
          - boolean
        subtype:
          description: 'Optional subtype constraint — if present, the referenced schema
            must be of this

            entity type (e.g. DNA_SEQUENCE, AA_SEQUENCE).'
          enum:
          - AA_SEQUENCE
          - CUSTOM_ENTITY
          - DNA_OLIGO
          - DNA_SEQUENCE
          - MIXTURE
          - MOLECULE
          - RNA_OLIGO
          - RNA_SEQUENCE
          - null
          type:
          - 'null'
          - string
      type: object
    EntitySchemaAppConfigValue:
      description: 'Stores a reference to an entity schema in an app configuration
        field.

        Kept separate from ResourceAppConfigValue because it carries a subtype

        identifying the kind of entity (DNA sequence, AA sequence, etc.).'
      properties:
        __typename:
          type: string
        subtype:
          description: Identifies the entity subtype of the configured schema (e.g.
            DNA_SEQUENCE, AA_SEQUENCE).
          enum:
          - AA_SEQUENCE
          - CUSTOM_ENTITY
          - DNA_OLIGO
          - DNA_SEQUENCE
          - MIXTURE
          - MOLECULE
          - RNA_OLIGO
          - RNA_SEQUENCE
          - null
          type:
          - 'null'
          - string
        value:
          type:
          - 'null'
          - string
      type: object
    EntitySchemaApplyFieldsetInput:
      additionalProperties: false
      properties:
        acknowledgeWarnings:
          description: If false, operation will only commit if there are no warnings
            in the output. If true, operation will commit even if there are warnings.
          type: boolean
        fieldsetId:
          description: The API ID of the fieldset to apply to the schema. The fieldset
            must exist and be accessible.
          type: string
      required:
      - fieldsetId
      type: object
    EntitySchemaApplyFieldsetOutput:
      description: Return shape for the apply_fieldset API on entity schemas.
      properties:
        schema:
          oneOf:
          - $ref: '#/components/schemas/EntitySchemaBaseRef'
          - type: 'null'
        warnings:
          items:
            $ref: '#/components/schemas/EntitySchemaApplyFieldsetWarning'
          type: array
      type: object
    EntitySchemaApplyFieldsetWarning:
      description: A warning raised when attempting to apply a fieldset to an entity
        schema.
      properties:
        __typename:
          type: string
        fieldId:
          type: string
        supportingInfo:
          type: string
        warningType:
          enum:
          - FIELD_TYPE_CHANGE
          - FIELD_IS_REQUIRED_CHANGE
          - FIELD_IS_MULTI_CHANGE
          - FIELD_PARENT_LINK_CHANGE
          - FIELD_SYSTEM_NAME_CHANGE
          - FIELD_UNIT_CHANGE
          - FIELD_ARCHIVE_RECORD_CHANGE
          - WAREHOUSE_CHANGE
          type: string
      type: object
    EntitySchemaBaseRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    EntitySchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/EntitySchema'
          type: array
        nextToken:
          type: string
      type: object
    EntitySchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    Entry:
      allOf:
      - $ref: '#/components/schemas/IEntry'
      - description: 'An Entry is the core document type in Benchling''s Electronic
          Lab Notebook (ELN), used

          by scientists to record experimental work and observations. Entries are
          organized into

          sections (days) containing various content types such as text, tables, file
          attachments,

          and structured data tables for results. Entries support rich collaboration
          features

          including authorship tracking, review workflows (see `Review` and `ReviewProcess`),

          access control through Projects and Folders, and can be linked to Studies.
          Entries may

          optionally conform to an `EntrySchema` that defines custom fields. They
          can be created

          from scratch or from an `EntryTemplate` to ensure consistent structure.
          Entry mutation

          endpoints are currently in closed LA.'
        properties:
          __typename:
            type: string
          authors:
            description: 'Array of User Resources of the authors of the entry. This
              defaults to

              the creator but can be manually changed.'
            oneOf:
            - format: uri
              type: string
            - type: 'null'
          creator:
            description: User Resource of the user who created the entry
            oneOf:
            - $ref: '#/components/schemas/PrincipalRef'
            - type: 'null'
          schemaFields:
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    EntryContent:
      description: 'Represents a single content item within an EntrySection. The `type`
        field indicates

        what kind of content this is (see `ContentType`). This provides a simplified
        view of

        entry content categorization.'
      properties:
        __typename:
          type: string
        type:
          enum:
          - TEXT
          - LIST_ITEM
          - HEADER
          - CODE_BLOCK
          - UNSTRUCTURED_TABLE
          - PLACEHOLDER
          - EXTERNAL_FILE
          - ASSAY_RUN
          - STRUCTURED_TABLE
          - OTHER
          - null
          type:
          - 'null'
          - string
      type: object
    EntryCreatedWebhookEnvelopeV3:
      allOf:
      - $ref: '#/components/schemas/WebhookEnvelopeBaseV0'
      - properties:
          message:
            $ref: '#/components/schemas/EntryCreatedWebhookV3'
        required:
        - message
        type: object
      description: Request body Benchling sends for a `v3.entry.created` event.
    EntryCreatedWebhookV3:
      allOf:
      - $ref: '#/components/schemas/V3EventBase'
      - properties:
          type:
            description: The event type.
            enum:
            - v3.entry.created
            type: string
        required:
        - type
        type: object
      description: Message body of a `v3.entry.created` event.
    EntryEditingTargetInput:
      additionalProperties: false
      properties:
        id:
          description: API ID of the notebook entry to edit.
          type: string
        type:
          enum:
          - entry
          type: string
      required:
      - type
      - id
      type: object
    EntryLinkFieldDefinition:
      description: A schema field definition for linking to notebook entries.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    EntryPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Entry'
          type: array
        nextToken:
          type: string
      type: object
    EntryRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    EntrySchema:
      description: 'Defines a schema that can be applied to Entries to add structured
        metadata through custom fields.

        Entry schemas allow organizations to standardize the information captured
        in notebook entries by defining

        required or optional fields with specific data types.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          type: string
        fieldDefinitions:
          format: uri
          type: string
        iconId:
          deprecated: true
          description: Use typedIconId instead, which provides enum validation.
          type: string
        id:
          type: string
        itemIdPrefix:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        organization:
          $ref: '#/components/schemas/OrganizationRef'
        systemName:
          type: string
        typedIconId:
          enum:
          - ENTRY
          type: string
      type: object
    EntrySchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/EntrySchema'
          type: array
        nextToken:
          type: string
      type: object
    EntrySchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    EntrySection:
      description: 'Represents a logical section within an Entry used to organize
        content into collapsible

        groups. While sections include a date field and were historically known as
        "Entry Days,"

        they are flexible groupings that users can organize however they want—chronologically,

        thematically, or by any other criteria. Each section may have a title, date,
        and contains a

        list of content items (see `EntryContent`) such as text blocks, tables, and
        attachments.

        Sections are collapsible in the UI, which helps when rendering large notebook
        entries.'
      properties:
        __typename:
          type: string
        contents:
          oneOf:
          - items:
              $ref: '#/components/schemas/EntryContent'
            type: array
          - type: 'null'
        date:
          type:
          - 'null'
          - string
        provenanceUuid:
          type: string
        title:
          type:
          - 'null'
          - string
      type: object
    EntrySubtemplate:
      description: 'A reusable content block that can be inserted into `DocumentLike`
        objects.

        Subtemplates contain pre-defined note content (text, tables, etc.) that scientists

        commonly need to repeat across multiple entries. Unlike `EntryTemplates` which
        create

        entire new entries, subtemplates are inserted as sections within existing
        documents.

        Subtemplates belong to a `TemplateCollection` and support versioned publishing
        (see

        `PublishingRecord`) to ensure consistent use across the organization. In the
        UI,

        these may be referred to simply as "Subtemplates" or "Insertable Content."'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          description: DateTime the subtemplate was created at
          format: datetime
          type:
          - 'null'
          - string
        creator:
          description: User that created the subtemplate
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        id:
          description: ID of the subtemplate
          type: string
        modifiedAt:
          description: DateTime the subtemplate was last modified
          format: datetime
          type:
          - 'null'
          - string
        name:
          description: Title of the subtemplate
          type:
          - 'null'
          - string
        templateCollection:
          $ref: '#/components/schemas/TemplateCollectionRef'
          description: Template collection that contains the template collectible
      type: object
    EntrySubtemplatePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/EntrySubtemplate'
          type: array
        nextToken:
          type: string
      type: object
    EntryTemplate:
      description: 'A template used to create new `DocumentLike` objects with pre-populated
        content and structure.

        `EntryTemplate`s contain boilerplate text, tables, placeholders, and other
        note content that provides a

        consistent starting point for documentation. When a new `DocumentLike` object
        is created from a template, the

        template''s content is cloned into the new object. Templates can optionally
        have an `EntrySchema` to ensure

        created objects capture required metadata. typeemplates belong to a `TemplateCollection`
        and support versioned

        publishing (see `PublishingRecord`). In the UI, these are typically called
        "Templates" within the

        Template Collections feature.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          description: DateTime the template was created at
          format: datetime
          type:
          - 'null'
          - string
        creator:
          description: User Resource of the user who created the template
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        customFields:
          oneOf:
          - items:
              $ref: '#/components/schemas/CustomField'
            type: array
          - type: 'null'
        id:
          description: ID of the entry template
          type: string
        modifiedAt:
          description: DateTime the template was last modified
          format: datetime
          type:
          - 'null'
          - string
        name:
          description: Title of the template
          type:
          - 'null'
          - string
        schema:
          description: Entry schema if set
          oneOf:
          - $ref: '#/components/schemas/EntrySchemaRef'
          - type: 'null'
        schemaFields:
          oneOf:
          - items:
              $ref: '#/components/schemas/SchemaFieldValue'
            type: array
          - type: 'null'
        templateCollection:
          $ref: '#/components/schemas/TemplateCollectionRef'
          description: Template collection that contains the template collectible
      type: object
    EntryTemplatePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/EntryTemplate'
          type: array
        nextToken:
          type: string
      type: object
    EntryTemplateRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    EntryTemplateUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/EntryTemplate'
          type: array
      type: object
    Enzyme:
      description: 'Represents a restriction enzyme from Benchling''s global catalog
        of commercially available

        enzymes. Restriction enzymes (also known as restriction endonucleases) are
        molecular scissors

        that recognize specific DNA sequences and cleave the DNA at defined positions.
        Each enzyme

        has a recognition sequence (restrictionSiteBases), such as GAATTC for EcoRI,
        and cut site

        details (see CutSiteDetail) specifying where the enzyme cuts relative to that
        recognition

        site. Enzymes can produce blunt ends or sticky ends (overhangs) depending
        on their cut

        pattern. Users can organize frequently used enzymes into EnzymeLists for convenient
        access

        during cloning workflow design.'
      properties:
        __typename:
          type: string
        cutSites:
          description: Either one (for single cutters) or two (for double cutters)
            cut details.
          items:
            $ref: '#/components/schemas/CutSiteDetail'
          type: array
        id:
          description: Id of the Enzyme
          type: string
        isoschizomers:
          description: Other enzymes in the catalog that recognize the same restriction
            site.
          format: uri
          type: string
        name:
          description: The name of the Enzyme, like EcoRI.
          type: string
        restrictionSiteBases:
          description: The DNA bases recognized by the Enzyme.
          type: string
      type: object
    EnzymeList:
      description: 'Represents a user-curated collection of restriction enzymes for
        molecular cloning workflows.

        EnzymeLists allow users and organizations to organize commonly used enzymes
        into named groups

        for easy access when planning restriction digests, cloning strategies, or
        analyzing DNA

        sequences. Each list has an owner (either a user or organization) who controls
        access

        permissions. See `Enzyme` for the individual restriction enzymes that can
        be added to a list.'
      properties:
        __typename:
          type: string
        createdAt:
          description: DateTime the Enzyme List was created
          format: datetime
          type: string
        description:
          description: Description of the Enzyme List
          type:
          - 'null'
          - string
        enzymes:
          description: List of Enzymes that are part of this Enzyme List
          format: uri
          type: string
        id:
          description: Id of the Enzyme List
          type: string
        modifiedAt:
          description: DateTime the Enzyme List was last modified
          format: datetime
          type: string
        name:
          description: Name of the Enzyme List
          type: string
        owner:
          $ref: '#/components/schemas/OwnerRef'
          description: User or Organization owner
      type: object
    EnzymeListPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/EnzymeList'
          type: array
        nextToken:
          type: string
      type: object
    EnzymePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Enzyme'
          type: array
        nextToken:
          type: string
      type: object
    EnzymeUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Enzyme'
          type: array
      type: object
    EquipmentLinkFieldDefinition:
      description: A schema field definition for linking to Equipment.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent Equipment. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinition:
          oneOf:
          - $ref: '#/components/schemas/EquipmentSchemaRef'
          - type: 'null'
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    EquipmentSchema:
      description: Defines the structure, field definitions, and configuration options
        for Equipments.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/Constraint'
          - type: 'null'
        containableType:
          enum:
          - NONE
          - ENTITY
          - BATCH
          type: string
        containerNameTemplate:
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplate'
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          type: string
        fieldDefinitions:
          format: uri
          type: string
        fieldsets:
          format: uri
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - MICROSCOPE
          - SAMPLE_SLIDE
          type: string
        id:
          type: string
        includeRegistryIdInChips:
          type: boolean
        itemIdPrefix:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        nameTemplate:
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplate'
          - type: 'null'
        organization:
          $ref: '#/components/schemas/OrganizationRef'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfiguration'
          type: array
        systemName:
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    EquipmentSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/EquipmentSchema'
          type: array
        nextToken:
          type: string
      type: object
    EquipmentSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    EquipmentSchemaSetFieldDefinitionsInput:
      additionalProperties: false
      properties:
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateSystemCategoryLinkFieldDefinitionInput'
          type: array
      required:
      - fieldDefinitions
      type: object
    EquipmentValuePlan:
      description: 'A pre-filled value for an equipment parameter within a `MethodParametersPlan`.
        The

        `equipmentId` references the `ProcedureParameterVersion` for the equipment
        parameter this

        value applies to. The `value` field contains the planned equipment assignment
        in JSON format,

        typically specifying which piece of lab equipment will be used. Used during
        experiment planning

        to pre-assign instruments or devices that will be used when the procedure
        run is executed.'
      properties:
        __typename:
          type: string
        equipmentId:
          type: string
        value:
          type: object
      type: object
    EquipmentValuePlanInput:
      additionalProperties: false
      properties:
        equipmentId:
          description: 'The ID of the equipment parameter version. Format: `schver_XXXXXXXX`.'
          type: string
        value:
          description: 'A dict with the shape {"value": {"equipment": <TypedValue
            | null>}}. The equipment TypedValue must match the referenced equipment
            parameter''s configured type: {"type": "ft_string", "value": "..."} for
            text inputs, or {"type": "ft_file_link", "targetFiles": [...]} for entity
            link inputs.'
          type: object
      required:
      - equipmentId
      - value
      type: object
    EventSubscription:
      description: 'Configures delivery of Benchling events to external systems via
        AWS EventBridge. Event

        subscriptions enable real-time integration by streaming events (such as entity
        creation,

        updates, or workflow state changes) to a customer''s AWS EventBridge event
        bus. The

        subscription includes the destination AWS ARN (see `destinationAddress`),
        routing metadata,

        and lifecycle management through expiration (see `expiresAt`) and pause controls.
        Paused

        subscriptions stop emitting events but retain their configuration for later
        resumption.

        Event subscriptions are typically managed through Benchling Apps (see `BenchlingApp`).'
      properties:
        __typename:
          type: string
        awsRegion:
          description: The AWS region of the eventbridge subscription.
          type:
          - 'null'
          - string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        destinationAddress:
          description: The AWS ARN of the EventBridge event bus that Benchling will
            deliver events to.
          type:
          - 'null'
          - string
        destinationMetadata:
          description: Semi-structured metadata used for routing events.
          type:
          - 'null'
          - object
        destinationType:
          enum:
          - EVENTBRIDGE
          - null
          type:
          - 'null'
          - string
        eventBusName:
          description: The name of the event bus of the eventbridge subscription .
          type:
          - 'null'
          - string
        expiresAt:
          description: The time after which the event subscription expires and will
            be paused.
          format: datetime
          type:
          - 'null'
          - string
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        paused:
          description: 'Indicates whether the event subscription is paused.

            Paused event subscriptions will not emit events to the configured

            destination.'
          type:
          - 'null'
          - boolean
      type: object
    EventSubscriptionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/EventSubscription'
          type: array
        nextToken:
          type: string
      type: object
    ExperimentalRole:
      description: 'Represents the complete experimental designation of a well or
        container within an assay,

        combining a primary role (see PrimaryExperimentalRole), replicate group number,
        and

        optional subrole. The group field identifies replicate sets: wells with the
        same primary

        role and group number are treated as technical replicates for statistical
        analysis. The

        subrole field provides additional categorization for controls (e.g., POSITIVE,
        NEGATIVE,

        MAXIMUM, MINIMUM); only CONTROL primary roles may have subroles. ExperimentalRole
        is

        used in plate-based workflows to define experimental layouts (see PlateMapPosition)
        and

        annotate wells in FixedPlate and Container objects.'
      properties:
        __typename:
          type: string
        group:
          description: Role group (aka replicate id)
          type: integer
        primaryRole:
          description: Primary role
          enum:
          - CONTROL
          - SAMPLE
          - BLANK
          - STANDARD
          type: string
        subrole:
          description: Subrole, used to differentiate different sub types of a role
            (e.g. positive control)
          type:
          - 'null'
          - string
      type: object
    ExperimentalRoleInput:
      additionalProperties: false
      properties:
        group:
          type: integer
        primaryRole:
          enum:
          - CONTROL
          - SAMPLE
          - BLANK
          - STANDARD
          type: string
        subrole:
          type:
          - 'null'
          - string
      required:
      - group
      - primaryRole
      - subrole
      type: object
    ExpirationInfo:
      description: 'Provides expiration tracking for inventory items such as containers
        and their

        contents. The expirationDate may be explicitly set on the container or inherited

        from the stored entity''s properties. The isExpired flag is a computed convenience

        field that returns true if the current date is past the expiration date. Items

        without an expiration date are considered non-expiring (isExpired returns
        false).'
      properties:
        __typename:
          type: string
        expirationDate:
          description: Expiration date of the item, potentially inherited from the
            contents or overridden.
          format: datetime
          type:
          - 'null'
          - string
        isExpired:
          description: Whether the item is past its expiration date. Items without
            an expiration date return False.
          type: boolean
      type: object
    ExplicitBarcodeInput:
      additionalProperties: false
      properties:
        barcode:
          type: string
        barcodeMode:
          enum:
          - SPECIFY_BARCODE
          type: string
      required:
      - barcodeMode
      - barcode
      type: object
    ExternalLinkedMolecule:
      description: Linked molecule from external registries/catalogs
      properties:
        __typename:
          type: string
        casId:
          type:
          - 'null'
          - string
        externalDbId:
          type:
          - 'null'
          - string
        externalDbName:
          type:
          - 'null'
          - string
        molecularFormula:
          type:
          - 'null'
          - string
        molecularFormulaOverride:
          type:
          - 'null'
          - string
        molecularWeight:
          type:
          - 'null'
          - string
        molecularWeightOverride:
          format: decimal
          type:
          - 'null'
          - string
        smiles:
          type:
          - 'null'
          - string
      type: object
    ExtraFootersTransform:
      description: 'A data transform that removes trailing footer rows from a file.
        Useful for instrument

        output files that append summary or metadata rows after the data.'
      properties:
        __typename:
          type: string
        transformationProperties:
          description: Additional parameters for this transform
          oneOf:
          - $ref: '#/components/schemas/ExtraFootersTransformationProperties'
          - type: 'null'
        type:
          description: The type of this transform (EXTRA_FOOTERS)
          enum:
          - ADD_COLUMN
          - ARITHMETIC
          - CUSTOM
          - DUPLICATE
          - EXTRA_HEADERS
          - EXTRA_FOOTERS
          - FILTER
          - FIND_REPLACE
          - MERGE
          - MELT
          - PLATE_SHAPE
          - PIVOT
          - REMOVE_QUOTES
          - SPLIT
          - null
          type:
          - 'null'
          - string
      type: object
    ExtraFootersTransformationProperties:
      description: 'Properties for an EXTRA_FOOTERS transform, specifying how many
        trailing rows to

        remove from the bottom of the file.'
      properties:
        __typename:
          type: string
        numRowsToRemove:
          description: Number of rows to remove from the bottom of the file
          type:
          - 'null'
          - integer
      type: object
    ExtraHeadersTransform:
      description: 'A data transform that handles files with extra header rows above
        the standard column

        header. Strips the specified header rows so downstream processing sees clean
        tabular

        data.'
      properties:
        __typename:
          type: string
        transformationProperties:
          description: Additional parameters for this transform
          oneOf:
          - $ref: '#/components/schemas/ExtraHeadersTransformationProperties'
          - type: 'null'
        type:
          description: The type of this transform (EXTRA_HEADERS)
          enum:
          - ADD_COLUMN
          - ARITHMETIC
          - CUSTOM
          - DUPLICATE
          - EXTRA_HEADERS
          - EXTRA_FOOTERS
          - FILTER
          - FIND_REPLACE
          - MERGE
          - MELT
          - PLATE_SHAPE
          - PIVOT
          - REMOVE_QUOTES
          - SPLIT
          - null
          type:
          - 'null'
          - string
      type: object
    ExtraHeadersTransformationProperties:
      description: 'Properties for an EXTRA_HEADERS transform, specifying the row
        range that contains

        non-standard header rows to skip during file processing.'
      properties:
        __typename:
          type: string
        headerRowIndex:
          description: Index of the first row of the header
          type:
          - 'null'
          - integer
        lastHeaderRowIndex:
          description: Index of the last row of the header. Optional, can be omitted
            if header is a single row
          type:
          - 'null'
          - integer
      type: object
    FeatureLibrary:
      description: 'Represents a reusable collection of biological features for auto-annotating
        nucleotide and AA sequences.

        FeatureLibraries enable users to define common sequence motifs (such as genes,
        promoters, terminators, or

        protein domains) with associated patterns, then automatically detect and annotate
        those features across many

        sequences. Each library contains `FeatureLibraryItem`s that specify the pattern
        to match and the annotation

        details to apply. Libraries can be shared with collaborators through ownership
        and permission controls, making

        them useful for standardizing annotation practices across a team. When running
        auto-annotate on a sequence,

        users select which libraries to search against.'
      properties:
        __typename:
          type: string
        createdAt:
          description: DateTime the Feature Library was created
          format: datetime
          type: string
        description:
          description: Description of the Feature Library
          type:
          - 'null'
          - string
        features:
          description: List of Feature Library Items in this library
          format: uri
          type: string
        id:
          type: string
        modifiedAt:
          description: DateTime the Feature Library was last modified
          format: datetime
          type: string
        name:
          description: Name of the Feature Library
          type: string
        owner:
          $ref: '#/components/schemas/OwnerRef'
      type: object
    FeatureLibraryItem:
      description: 'Represents a single feature definition within a FeatureLibrary
        used for auto-annotation.

        Each item defines a searchable pattern (nucleotide or amino acid sequence),
        a feature type

        classification (such as ''gene'', ''promoter'', or ''domain''), a display
        name, and a color for

        visualization. When auto-annotate runs against a sequence, the pattern is
        matched according

        to the matchType (see FeatureLibraryMatchType), and matching regions are annotated
        with the

        item''s name, type, and color. Patterns can include special characters for
        flexible matching,

        such as wildcards for arbitrary bases or optional flanking regions.'
      properties:
        __typename:
          type: string
        color:
          description: The color of the annotations generated by the Feature Library
            Item. Must be a valid hex string
          type: string
        createdAt:
          description: DateTime the Feature Library Item was created
          format: datetime
          type: string
        featureLibrary:
          $ref: '#/components/schemas/FeatureLibraryRef'
          description: The Feature Library the Feature Library Item belongs to
        featureType:
          description: 'The type of the Feature Library Item, like gene, promoter,
            etc. Note: This is an arbitrary string, not an enum'
          type:
          - 'null'
          - string
        id:
          type: string
        matchType:
          description: The match type of the Feature Library Item. Used to determine
            how auto-annotate matches are made
          enum:
          - NUCLEOTIDE
          - AA_SEQUENCE
          type: string
        modifiedAt:
          description: DateTime the Feature Library Item was last modified
          format: datetime
          type: string
        name:
          description: The name of the Feature Library Item
          type: string
        pattern:
          description: The pattern used for matching during auto-annotation
          type: string
      type: object
    FeatureLibraryItemPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/FeatureLibraryItem'
          type: array
        nextToken:
          type: string
      type: object
    FeatureLibraryPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/FeatureLibrary'
          type: array
        nextToken:
          type: string
      type: object
    FeatureLibraryRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    FieldNameTemplatePartConfiguration:
      description: Configuration for a schema field name template part.
      properties:
        __typename:
          type: string
        field:
          $ref: '#/components/schemas/SchemaFieldDefinitionRef'
      type: object
    FieldNameTemplatePartConfigurationInput:
      additionalProperties: false
      properties:
        fieldId:
          type: string
      required:
      - fieldId
      type: object
    FieldValueInput:
      additionalProperties: false
      properties:
        value:
          $ref: '#/components/schemas/AnyType'
      required:
      - value
      type: object
    Fieldset:
      description: 'A tenant-defined schema interface (also known as a "Fieldset")
        that groups related fields

        to be shared across multiple schemas. Fieldsets are created and managed by
        tenant

        administrators and belong to an `Organization`. Schemas can implement an interface
        to inherit

        its `fieldDefinitions`, ensuring consistent field definitions across entity
        types. Unlike

        `StaticSchemaInterface` (which is Benchling-defined and read-only), Fieldsets

        can be modified by users. May include a `constraint` for uniqueness validation
        and a `prefix`

        for ID generation on implementing entities. Can be archived when no longer
        needed.'
      properties:
        __typename:
          type: string
        archiveReason:
          description: Reason the Fieldset was archived
          type:
          - 'null'
          - string
        archived:
          description: If the Fieldset is archived
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/Constraint'
          - type: 'null'
        createdAt:
          description: DateTime the Fieldset was created
          format: datetime
          type: string
        description:
          description: The description of this Fieldset.
          type: string
        displayName:
          type: string
        fieldDefinitions:
          format: uri
          type: string
        id:
          type: string
        itemIdPrefix:
          type:
          - 'null'
          - string
        itemType:
          description: 'The entity item type that schemas implementing this Fieldset
            contain (e.g. DNA_SEQUENCE,

            AA_SEQUENCE, MIXTURE). Null when the Fieldset declares no base bioentity
            type.'
          enum:
          - AA_SEQUENCE
          - ANTIBODY
          - CUSTOM_ENTITY
          - DNA_OLIGO
          - DNA_SEQUENCE
          - ENTRY
          - EQUIPMENT
          - MIXTURE
          - MOLECULE
          - OLIGO_CONJUGATE
          - OLIGO_DUPLEX
          - RNA_OLIGO
          - RNA_SEQUENCE
          - TRIAL_SUBJECT
          - null
          type:
          - 'null'
          - string
        modifiedAt:
          description: DateTime the Fieldset was last modified
          format: datetime
          type: string
        nameTemplate:
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplate'
          - type: 'null'
        organization:
          $ref: '#/components/schemas/OrganizationRef'
          description: Organization the Fieldset is in
        systemName:
          type: string
      type: object
    FieldsetLinkFieldDefinition:
      description: A schema field definition for linking to entities that implement
        a fieldset (custom schema interface).
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent entity. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinition:
          $ref: '#/components/schemas/FieldsetRef'
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    FieldsetPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Fieldset'
          type: array
        nextToken:
          type: string
      type: object
    FieldsetRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    FieldsetSetFieldDefinitionsInput:
      additionalProperties: false
      properties:
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateSystemCategoryLinkFieldDefinitionInput'
          type: array
      required:
      - fieldDefinitions
      type: object
    FieldsetUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Fieldset'
          type: array
      type: object
    File:
      description: 'A File represents an uploaded document or data file that is surfaced
        in Benchling''s

        Data Catalog for discovery and organization. Files are primarily created through

        Benchling Connect (for external file integrations) and the Analysis Tool (for

        pipeline outputs). Each File is backed by a ScratchFile containing the actual

        binary content and upload state. Files are folder-based items that can be

        starred for quick access, linked to Studies, and support custom fields.

        Files differ from EntryExternalFile (attachments within notebook entries)

        and Blob (raw binary storage) in that they are first-class data catalog

        items with full metadata and discovery capabilities.'
      properties:
        __typename:
          type: string
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        displayId:
          type:
          - 'null'
          - string
        folder:
          $ref: '#/components/schemas/FolderRef'
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type:
          - 'null'
          - string
        scratchFile:
          $ref: '#/components/schemas/ScratchFileRef'
      type: object
    FilePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/File'
          type: array
        nextToken:
          type: string
      type: object
    FileRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    FileUploadUiBlock:
      description: A file upload block that accepts one or more file attachments.
      properties:
        __typename:
          type: string
        enabled:
          type:
          - 'null'
          - boolean
        fileTypes:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        id:
          type: string
        label:
          type:
          - 'null'
          - string
        maxFiles:
          type:
          - 'null'
          - integer
        required:
          type:
          - 'null'
          - boolean
        value:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
      type: object
    FileUploadUiBlockInput:
      additionalProperties: false
      properties:
        enabled:
          type: boolean
        fileTypes:
          items:
            type: string
          type: array
        id:
          type: string
        label:
          type: string
        maxFiles:
          type: integer
        required:
          type: boolean
        type:
          enum:
          - FILE_UPLOAD
          type: string
        value:
          items:
            type: string
          type: array
      required:
      - type
      - id
      type: object
    FilterTransform:
      description: 'A data transform that removes rows from the file based on column
        value conditions.

        Supports null checks, string/number comparisons, and set membership filters.'
      properties:
        __typename:
          type: string
        transformationProperties:
          description: Additional parameters for this transform
          oneOf:
          - anyOf:
            - $ref: '#/components/schemas/NullFilterTransformationProperties'
            - $ref: '#/components/schemas/StringValueFilterTransformationProperties'
            - $ref: '#/components/schemas/NumberValueFilterTransformationProperties'
            - $ref: '#/components/schemas/MultipleValuesFilterTransformationProperties'
            discriminator:
              propertyName: __typename
          - type: 'null'
        type:
          description: The type of this transform (FILTER)
          enum:
          - ADD_COLUMN
          - ARITHMETIC
          - CUSTOM
          - DUPLICATE
          - EXTRA_HEADERS
          - EXTRA_FOOTERS
          - FILTER
          - FIND_REPLACE
          - MERGE
          - MELT
          - PLATE_SHAPE
          - PIVOT
          - REMOVE_QUOTES
          - SPLIT
          - null
          type:
          - 'null'
          - string
      type: object
    FindReplaceTransform:
      description: 'A data transform that substitutes values in the file by finding
        occurrences and

        replacing them. Replacement values can be specified inline or resolved via
        a

        LookupConfig.'
      properties:
        __typename:
          type: string
        type:
          description: The type of this transform (FIND_REPLACE)
          enum:
          - ADD_COLUMN
          - ARITHMETIC
          - CUSTOM
          - DUPLICATE
          - EXTRA_HEADERS
          - EXTRA_FOOTERS
          - FILTER
          - FIND_REPLACE
          - MERGE
          - MELT
          - PLATE_SHAPE
          - PIVOT
          - REMOVE_QUOTES
          - SPLIT
          - null
          type:
          - 'null'
          - string
      type: object
    FloatAppConfigSpec:
      description: Specifies that an app configuration field should accept a floating-point
        number.
      properties:
        __typename:
          type: string
        enum:
          description: Optional enum constraint — if present, the value must be one
            of these floats.
          oneOf:
          - items:
              type: number
            type: array
          - type: 'null'
        requiredConfig:
          type:
          - 'null'
          - boolean
      type: object
    FloatAppConfigValue:
      description: Stores a floating-point number value in an app configuration field.
      properties:
        __typename:
          type: string
        value:
          type:
          - 'null'
          - number
      type: object
    FloatFieldDefinition:
      description: A float field definition for decimal number values. Supports numeric
        constraints (min/max), display precision, and units.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        displayPrecision:
          type:
          - 'null'
          - integer
        id:
          type: string
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        numericMax:
          type:
          - 'null'
          - number
        numericMin:
          type:
          - 'null'
          - number
        systemName:
          type: string
        unit:
          oneOf:
          - $ref: '#/components/schemas/UnitRef'
          - type: 'null'
      type: object
    Folder:
      description: 'A hierarchical container for organizing entities, notebook entries,
        and other items within

        a Project. Folders support nested structures through parent-child relationships
        (see

        `parent`), enabling users to create logical groupings that mirror laboratory
        organization

        or experimental workflows. Folders belong to a Project (see `project`) and
        inherit access

        control through collaborations (see `Collaboration`). Items stored in folders
        implement

        the FolderItem interface. Folders can be starred for quick access (via `Starrable`)
        and

        archived with lineage tracking that affects contained items (via `ArchivableWithLineage`).'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        children:
          description: The folders directly nested under this folder.
          format: uri
          type: string
        createdAt:
          format: datetime
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type:
          - 'null'
          - string
        parent:
          description: The parent folder, if it exists. Root folders (one per Project)
            have no parent.
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        project:
          description: ID of the containing project
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
      type: object
    FolderPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Folder'
          type: array
        nextToken:
          type: string
      type: object
    FolderRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    FolderUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Folder'
          type: array
      type: object
    FormulaUnitTerm:
      description: 'A term in the original formula of a `UnitType` that references
        an actual `Unit`

        rather than a base dimension. This is used to define relationships between
        units

        across different UnitTypes, such as defining that Liter = decimeter³. Unlike

        `UnitTypeTerm` which uses abstract SI dimensions, FormulaUnitTerm references

        concrete Unit definitions and is the crucial piece for establishing mathematical

        relationships when composing derived unit types.'
      properties:
        __typename:
          type: string
        exponent:
          type: integer
        value:
          $ref: '#/components/schemas/UnitRef'
      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
    Germline:
      description: A database of reference sequences used to characterize protein
        sequences via alignment.
      properties:
        __typename:
          type: string
        id:
          description: Id of the Germline
          type: string
        name:
          description: Name of the Germline
          type: string
      type: object
    GermlinePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Germline'
          type: array
        nextToken:
          type: string
      type: object
    GridCoordinates:
      description: Read model representing a fillable position in a box or plate.
      properties:
        __typename:
          type: string
        column:
          description: The 0-indexed column index of the position
          type: integer
        index:
          description: 'The 1-indexed position determined by counting across rows.

            For example, for a six-well plate:

            +---+---+---+

            | 1 | 2 | 3 |

            +---+---+---+

            | 4 | 5 | 6 |

            +---+---+---+'
          type: integer
        position:
          description: 'The alphanumeric position, where rows are indexed alphabetically
            and columns are indexed numerically,

            starting from "A1"'
          type: string
        row:
          description: The 0-indexed row index of the position
          type: integer
      type: object
    Group:
      anyOf:
      - $ref: '#/components/schemas/Organization'
      - $ref: '#/components/schemas/Team'
      discriminator:
        propertyName: __typename
      type: object
    GroupCollaboratorInfo:
      description: 'Represents a Group that is the subject of a Collaboration, along
        with sub-group information.

        In Group Collaborations, the Resource may be shared with a sub-group of the
        Group, e.g.

        the Admins of a Team.'
      properties:
        __typename:
          type: string
        collaborator:
          $ref: '#/components/schemas/Group'
        role:
          enum:
          - MEMBER
          - ADMIN
          type: string
      type: object
    GroupMembership:
      description: 'Indicates that a Principal is a member of Group. Role indicates
        that the Principal is

        a member of a subgroup, such as Admins of the Group. Teams are the canonical
        example

        of a Group.'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type: string
        group:
          $ref: '#/components/schemas/Group'
        id:
          type: string
        member:
          $ref: '#/components/schemas/PrincipalRef'
        modifiedAt:
          format: datetime
          type: string
        role:
          enum:
          - MEMBER
          - ADMIN
          type: string
      type: object
    GroupMembershipPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/GroupMembership'
          type: array
        nextToken:
          type: string
      type: object
    GroupMembershipUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/GroupMembership'
          type: array
      type: object
    HeaderContentInput:
      additionalProperties: false
      properties:
        contentType:
          enum:
          - header
          type: string
        formats:
          items:
            $ref: '#/components/schemas/TextFormatInput'
          type: array
        headerType:
          enum:
          - HEADER_1
          - HEADER_2
          - SUBHEADER_1
          type: string
        indentation:
          type: integer
        links:
          items:
            $ref: '#/components/schemas/LinkSpanInput'
          type: array
        mentions:
          items:
            $ref: '#/components/schemas/MentionInput'
          type: array
        text:
          type: string
      required:
      - contentType
      - headerType
      - text
      type: object
    HeaderDocumentContent:
      description: 'Represents a heading block within notebook or document content.

        Headers store the heading level, rich text, and indentation used to organize
        document sections.'
      properties:
        __typename:
          type: string
        formats:
          items:
            $ref: '#/components/schemas/TextFormat'
          type: array
        headerType:
          enum:
          - HEADER_1
          - HEADER_2
          - SUBHEADER_1
          type: string
        indentation:
          type: integer
        links:
          items:
            $ref: '#/components/schemas/LinkSpan'
          type: array
        mentions:
          items:
            $ref: '#/components/schemas/Mention'
          type: array
        text:
          type: string
      type: object
    IAaSequence:
      properties:
        __typename:
          type: string
        aliases:
          description: Array of aliases
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        aminoAcids:
          description: Amino acids of the AA sequence.
          type: string
        annotations:
          description: Array of annotation objects on the AA sequence.
          items:
            $ref: '#/components/schemas/AaAnnotation'
          type: array
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          description: DateTime the AA sequence was created.
          format: datetime
          type:
          - 'null'
          - string
        customFields:
          description: Custom fields set on the AA sequence.
          oneOf:
          - items:
              $ref: '#/components/schemas/CustomField'
            type: array
          - type: 'null'
        entityRegistryId:
          description: Registry ID of the AA sequence if registered.
          type:
          - 'null'
          - string
        folder:
          description: ID of the folder that contains the AA sequence.
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        id:
          description: ID of the AA sequence.
          type: string
        modifiedAt:
          description: DateTime the AA sequence was last modified.
          format: datetime
          type:
          - 'null'
          - string
        name:
          description: Name of the AA sequence.
          type: string
        project:
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        registrationOrigin:
          oneOf:
          - $ref: '#/components/schemas/RegistrationOrigin'
          - type: 'null'
        registry:
          description: Registry the AA sequence is registered in.
          oneOf:
          - $ref: '#/components/schemas/RegistryRef'
          - type: 'null'
        schema:
          oneOf:
          - $ref: '#/components/schemas/EntitySchemaRef'
          - type: 'null'
      type: object
    IAppInstallationRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    IBox:
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        availableCapacity:
          description: The number of available positions in the box.
          type: integer
        barcode:
          type:
          - 'null'
          - string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        emptyContainers:
          description: The number of containers in the box that have no contents.
          type:
          - 'null'
          - integer
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type:
          - 'null'
          - string
        occupiedCapacity:
          description: The number of containers currently in the box.
          type: integer
        parentStorage:
          oneOf:
          - $ref: '#/components/schemas/LocationRef'
          - type: 'null'
        project:
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        schema:
          oneOf:
          - $ref: '#/components/schemas/BoxSchemaRef'
          - type: 'null'
        totalCapacity:
          description: The total capacity of the box (i.e. how many containers it
            can store).
          type: integer
      type: object
    IContainer:
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        barcode:
          type:
          - 'null'
          - string
        checkoutRecord:
          $ref: '#/components/schemas/CheckoutRecord'
        contents:
          items:
            $ref: '#/components/schemas/ContainerContent'
          type: array
        coordinates:
          description: Coordinates of the container within its contained grid, if
            it is contained within a grid.
          oneOf:
          - $ref: '#/components/schemas/GridCoordinates'
          - type: 'null'
        createdAt:
          format: datetime
          type: string
        expirationInfo:
          $ref: '#/components/schemas/ExpirationInfo'
          description: Expiration info for the container.
        gridNumber:
          deprecated: true
          description: Please use coordinates.index
          type:
          - 'null'
          - number
        gridPosition:
          deprecated: true
          description: Please use coordinates.position
          type:
          - 'null'
          - string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        parentStorage:
          description: Union of Box, Plate, Location
          oneOf:
          - $ref: '#/components/schemas/ObjectRef'
          - type: 'null'
        parentStorageSchema:
          description: Union of BoxSchema, PlateSchema, LocationSchema
          oneOf:
          - $ref: '#/components/schemas/ObjectRef'
          - type: 'null'
        project:
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        quantity:
          description: 'Quantity of a container, well, or transfer. Supports mass,
            volume, and

            other quantities.'
          oneOf:
          - $ref: '#/components/schemas/Measurement'
          - type: 'null'
        role:
          oneOf:
          - $ref: '#/components/schemas/ExperimentalRole'
          - type: 'null'
        schema:
          $ref: '#/components/schemas/ContainerSchemaRef'
      type: object
    ICustomEntity:
      properties:
        __typename:
          type: string
        aliases:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        customFields:
          oneOf:
          - items:
              $ref: '#/components/schemas/CustomField'
            type: array
          - type: 'null'
        entityRegistryId:
          type:
          - 'null'
          - string
        folder:
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type:
          - 'null'
          - string
        project:
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        registrationOrigin:
          oneOf:
          - $ref: '#/components/schemas/RegistrationOrigin'
          - type: 'null'
        registry:
          oneOf:
          - $ref: '#/components/schemas/RegistryRef'
          - type: 'null'
        schema:
          oneOf:
          - $ref: '#/components/schemas/EntitySchemaRef'
          - type: 'null'
      type: object
    IDnaOligo:
      properties:
        __typename:
          type: string
        aliases:
          description: Array of aliases
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        annotations:
          description: Annotations on the Oligo.
          items:
            $ref: '#/components/schemas/NucleotideAnnotation'
          type: array
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        bases:
          description: Bases of the Oligo.
          type: string
        createdAt:
          description: DateTime the Oligo was created.
          format: datetime
          type:
          - 'null'
          - string
        customFields:
          description: Custom fields set on the Oligo.
          oneOf:
          - items:
              $ref: '#/components/schemas/CustomField'
            type: array
          - type: 'null'
        entityRegistryId:
          description: Registry ID of the Oligo if registered.
          type:
          - 'null'
          - string
        folder:
          description: ID of the folder that contains the Oligo.
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        id:
          description: ID of the Oligo.
          type: string
        modifiedAt:
          description: DateTime the Oligo was last modified.
          format: datetime
          type:
          - 'null'
          - string
        modifiedNucleotides:
          description: Modifications applied to this oligo.
          format: uri
          type: string
        name:
          description: Name of the Oligo.
          type: string
        project:
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        registrationOrigin:
          oneOf:
          - $ref: '#/components/schemas/RegistrationOrigin'
          - type: 'null'
        registry:
          description: Registry the Oligo is registered in.
          oneOf:
          - $ref: '#/components/schemas/RegistryRef'
          - type: 'null'
        schema:
          oneOf:
          - $ref: '#/components/schemas/EntitySchemaRef'
          - type: 'null'
      type: object
    IDnaSequence:
      properties:
        __typename:
          type: string
        aliases:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        annotations:
          description: 'Annotations on the DNA sequence, not including translations
            or primers. Annotations on parts are

            not included.'
          items:
            $ref: '#/components/schemas/NucleotideAnnotation'
          type: array
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        bases:
          description: Bases of the forward strand of the DNA sequence.
          type: string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        customFields:
          oneOf:
          - items:
              $ref: '#/components/schemas/CustomField'
            type: array
          - type: 'null'
        entityRegistryId:
          type:
          - 'null'
          - string
        folder:
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        id:
          type: string
        isCircular:
          description: Whether the DNA sequence is circular or linear.
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        parts:
          description: Part features on the DNA sequence.
          format: uri
          type: string
        primers:
          description: Primer bind features on the DNA sequence. Primers on parts
            are not included.
          items:
            $ref: '#/components/schemas/Primer'
          type: array
        project:
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        registrationOrigin:
          oneOf:
          - $ref: '#/components/schemas/RegistrationOrigin'
          - type: 'null'
        registry:
          oneOf:
          - $ref: '#/components/schemas/RegistryRef'
          - type: 'null'
        schema:
          oneOf:
          - $ref: '#/components/schemas/EntitySchemaRef'
          - type: 'null'
        startIndex:
          description: Starting index for the sequence residues of linear DNA sequences.
            Implicitly 1 for other sequence types.
          type: integer
        transcriptions:
          description: Transcriptions, derived from schema field data.
          items:
            $ref: '#/components/schemas/Transcription'
          type: array
        translations:
          description: 'Translation annotations present on the DNA sequence. Translations
            may be one region or split

            across multiple regions. Translations on parts are not included.'
          items:
            $ref: '#/components/schemas/Translation'
          type: array
      type: object
    IEntry:
      properties:
        __typename:
          type: string
        applicableReviewProcesses:
          description: 'The review processes configured for this entry''s project.
            Use the paginated

            `/applicable-review-processes/items` sub-resource to retrieve the full
            list of

            ReviewProcess objects including their stages and version details.'
          format: uri
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          description: DateTime the entry was created at
          format: datetime
          type:
          - 'null'
          - string
        customFields:
          oneOf:
          - items:
              $ref: '#/components/schemas/CustomField'
            type: array
          - type: 'null'
        displayId:
          description: User-friendly ID of the entry
          type:
          - 'null'
          - string
        folder:
          description: ID of the folder that contains the entry
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        id:
          description: ID of the entry
          type: string
        modifiedAt:
          description: DateTime the entry was last modified
          format: datetime
          type:
          - 'null'
          - string
        name:
          description: Title of the entry
          type:
          - 'null'
          - string
        parts:
          description: The parts of the Entry
          format: uri
          type: string
        review:
          description: 'The active review for this entry, if one exists. Returns a
            Review object with status,

            reviewers, review process, and review history. Null when the entry has
            not been sent

            for review or the review has been retracted.'
          oneOf:
          - $ref: '#/components/schemas/ReviewRef'
          - type: 'null'
        reviewSource:
          $ref: '#/components/schemas/ProjectRef'
          description: The project that this entry belongs to, used to determine which
            review processes apply.
        schema:
          description: Entry schema if set
          oneOf:
          - $ref: '#/components/schemas/EntrySchemaRef'
          - type: 'null'
        sections:
          description: The sections of the entry
          oneOf:
          - items:
              $ref: '#/components/schemas/EntrySection'
            type: array
          - type: 'null'
        selectors:
          description: Selectors available to table cells in this entry.
          items:
            $ref: '#/components/schemas/TableCellSelector'
          type: array
        versionMetadata:
          $ref: '#/components/schemas/DocumentLikeVersionMetadata'
          description: Version metadata for the current version of this Entry.
      type: object
    ILocation:
      properties:
        __typename:
          type: string
        allowNonLocationChildren:
          description: Whether this location can store plates, boxes, and containers.
          type: boolean
        allowedInventorySchemas:
          description: 'The plate, box, and container schemas that can be stored in
            this location.

            If allowsNonLocationChildren is true and this list is empty, all schemas
            are allowed.'
          items:
            $ref: '#/components/schemas/ObjectRef'
            description: Union of BoxSchema, PlateSchema, ContainerSchema
          type: array
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        availableCapacity:
          description: The number of available positions in this location. Null if
            totalCapacity is not set.
          type:
          - 'null'
          - integer
        barcode:
          type:
          - 'null'
          - string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type:
          - 'null'
          - string
        occupiedCapacity:
          description: 'The number of plates, boxes, and containers currently in this
            location.

            Null if totalCapacity is not set.'
          type:
          - 'null'
          - integer
        parentStorage:
          oneOf:
          - $ref: '#/components/schemas/LocationRef'
          - type: 'null'
        schema:
          oneOf:
          - $ref: '#/components/schemas/LocationSchemaRef'
          - type: 'null'
        totalCapacity:
          description: 'The total capacity of this location (i.e. how many plates,
            boxes, and containers it can store).

            If null, capacity is not limited.'
          type:
          - 'null'
          - integer
        validationStatus:
          description: Whether this location is passing all validation checks.
          enum:
          - PASSED
          - FAILED
          type: string
      type: object
    IMatrixPlate:
      properties:
        __typename:
          type: string
        archiveReason:
          description: Why the plate is archived
          type:
          - 'null'
          - string
        archived:
          description: Whether the plate is archived
          type: boolean
        availableCapacity:
          description: The number of available positions in a matrix plate.
          type: integer
        barcode:
          description: Barcode of the plate
          type:
          - 'null'
          - string
        createdAt:
          description: DateTime the plate was created
          format: datetime
          type: string
        id:
          description: The ID of the plate.
          type: string
        modifiedAt:
          description: DateTime the plate was last modified
          format: datetime
          type: string
        name:
          description: Name of the plate; defaults to barcode if name is not provided
          type: string
        occupiedCapacity:
          description: The number of containers currently in a matrix plate.
          type: integer
        parentStorage:
          description: Containing parent storage
          oneOf:
          - $ref: '#/components/schemas/LocationRef'
          - type: 'null'
        positions:
          description: The wells of the plate
          items:
            $ref: '#/components/schemas/MatrixPlatePosition'
          type: array
        project:
          description: The project the plate is associated with
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        schema:
          $ref: '#/components/schemas/MatrixPlateSchemaRef'
          description: The schema of the plate
        totalCapacity:
          description: The total capacity of a matrix plate (i.e. how many containers
            it can store).
          type: integer
      type: object
    IMixture:
      properties:
        __typename:
          type: string
        aliases:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        allowMeasuredIngredients:
          description: Derived from the mixture's schema.
          type:
          - 'null'
          - boolean
        amount:
          description: 'The positive numerical amount value of this mixture in string
            format

            (to preserve full precision). Pair with `units`. Supports scientific

            notation (1.23e4).'
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        customFields:
          oneOf:
          - items:
              $ref: '#/components/schemas/CustomField'
            type: array
          - type: 'null'
        entityRegistryId:
          type:
          - 'null'
          - string
        folder:
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        id:
          type: string
        ingredients:
          description: List of ingredients on this mixture.
          oneOf:
          - items:
              $ref: '#/components/schemas/Ingredient'
            type: array
          - type: 'null'
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type:
          - 'null'
          - string
        project:
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        registrationOrigin:
          oneOf:
          - $ref: '#/components/schemas/RegistrationOrigin'
          - type: 'null'
        registry:
          oneOf:
          - $ref: '#/components/schemas/RegistryRef'
          - type: 'null'
        schema:
          oneOf:
          - $ref: '#/components/schemas/EntitySchemaRef'
          - type: 'null'
        units:
          enum:
          - NL
          - UL
          - ML
          - L
          - G
          - KG
          - UNITS
          - UG
          - MG
          - null
          type:
          - 'null'
          - string
      type: object
    IMolecule:
      properties:
        __typename:
          type: string
        aliases:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        canonicalSmiles:
          description: 'The canonicalized chemical structure in SMILES format. E.g.,

            Nc1nc(=O)n([H:1])cc1C1CC1'
          type:
          - 'null'
          - string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        customFields:
          oneOf:
          - items:
              $ref: '#/components/schemas/CustomField'
            type: array
          - type: 'null'
        entityRegistryId:
          type:
          - 'null'
          - string
        folder:
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type:
          - 'null'
          - string
        originalSmiles:
          description: 'The original chemical structure in SMILES format. Null if
            the user did not originally provide SMILES. E.g.,

            Nc1nc(=O)n([H:1])cc1C1CC1'
          type:
          - 'null'
          - string
        project:
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        registrationOrigin:
          oneOf:
          - $ref: '#/components/schemas/RegistrationOrigin'
          - type: 'null'
        registry:
          oneOf:
          - $ref: '#/components/schemas/RegistryRef'
          - type: 'null'
        schema:
          oneOf:
          - $ref: '#/components/schemas/EntitySchemaRef'
          - type: 'null'
      type: object
    IOligoConjugate:
      description: 'An oligo conjugate is a specific type of complex polymer that
        consists of a single short DNA/RNA strand with

        multiple attached molecules (aka conjugates).'
      properties:
        __typename:
          type: string
        aliases:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        backbone:
          oneOf:
          - $ref: '#/components/schemas/NucleotideSimplePolymer'
          - type: 'null'
        canonicalHelm:
          type: string
        conjugates:
          oneOf:
          - items:
              anyOf:
              - $ref: '#/components/schemas/NucleotideSimplePolymer'
              - $ref: '#/components/schemas/ChemSimplePolymer'
              description: Union of NucleotideSimplePolymer, ChemSimplePolymer
              discriminator:
                propertyName: __typename
            type: array
          - type: 'null'
        createdAt:
          format: datetime
          type: string
        customFields:
          oneOf:
          - items:
              $ref: '#/components/schemas/CustomField'
            type: array
          - type: 'null'
        entityAssociations:
          items:
            $ref: '#/components/schemas/EntityAssociation'
          type: array
        entityRegistryId:
          type:
          - 'null'
          - string
        folder:
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        originalHelm:
          type:
          - 'null'
          - string
        outOfSync:
          type: boolean
        outOfSyncReason:
          type:
          - 'null'
          - string
        project:
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        registrationOrigin:
          oneOf:
          - $ref: '#/components/schemas/RegistrationOrigin'
          - type: 'null'
        registry:
          oneOf:
          - $ref: '#/components/schemas/RegistryRef'
          - type: 'null'
        schema:
          $ref: '#/components/schemas/EntitySchemaRef'
        structure:
          $ref: '#/components/schemas/ComplexPolymerStructure'
      type: object
    IOligoDuplex:
      description: 'An oligo duplex is a specific type of complex polymer that consists
        of two complementary DNA/RNA strands, with

        multiple attached molecules on either strand (aka conjugates).'
      properties:
        __typename:
          type: string
        aliases:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        canonicalHelm:
          type: string
        conjugates:
          oneOf:
          - items:
              anyOf:
              - $ref: '#/components/schemas/NucleotideSimplePolymer'
              - $ref: '#/components/schemas/ChemSimplePolymer'
              description: Union of NucleotideSimplePolymer, ChemSimplePolymer
              discriminator:
                propertyName: __typename
            type: array
          - type: 'null'
        createdAt:
          format: datetime
          type: string
        customFields:
          oneOf:
          - items:
              $ref: '#/components/schemas/CustomField'
            type: array
          - type: 'null'
        entityAssociations:
          items:
            $ref: '#/components/schemas/EntityAssociation'
          type: array
        entityRegistryId:
          type:
          - 'null'
          - string
        folder:
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        forwardOffset:
          type:
          - 'null'
          - integer
        forwardStrand:
          oneOf:
          - $ref: '#/components/schemas/NucleotideSimplePolymer'
          - type: 'null'
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        originalHelm:
          type:
          - 'null'
          - string
        outOfSync:
          type: boolean
        outOfSyncReason:
          type:
          - 'null'
          - string
        project:
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        registrationOrigin:
          oneOf:
          - $ref: '#/components/schemas/RegistrationOrigin'
          - type: 'null'
        registry:
          oneOf:
          - $ref: '#/components/schemas/RegistryRef'
          - type: 'null'
        reverseStrand:
          oneOf:
          - $ref: '#/components/schemas/NucleotideSimplePolymer'
          - type: 'null'
        schema:
          $ref: '#/components/schemas/EntitySchemaRef'
        structure:
          $ref: '#/components/schemas/ComplexPolymerStructure'
      type: object
    IPlate:
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        availableCapacity:
          description: The number of available positions in a matrix plate. Null for
            well plates.
          type:
          - 'null'
          - integer
        barcode:
          description: Barcode of the plate
          type:
          - 'null'
          - string
        createdAt:
          description: DateTime the plate was created
          format: datetime
          type:
          - 'null'
          - string
        id:
          description: ID of the plate
          type: string
        modifiedAt:
          description: DateTime the plate was last modified
          format: datetime
          type:
          - 'null'
          - string
        name:
          description: Name of the plate, defaults to barcode if name is not provided.
          type:
          - 'null'
          - string
        occupiedCapacity:
          description: The number of containers currently in a matrix plate. Null
            for well plates.
          type:
          - 'null'
          - integer
        parentStorage:
          description: Containing parent storage.
          oneOf:
          - $ref: '#/components/schemas/LocationRef'
          - type: 'null'
        project:
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        schema:
          oneOf:
          - $ref: '#/components/schemas/PlateSchemaRef'
          - type: 'null'
        totalCapacity:
          description: 'The total capacity of a matrix plate (i.e. how many containers
            it can store).

            Null for well plates.'
          type:
          - 'null'
          - integer
        type:
          enum:
          - MATRIX_PLATE
          - FIXED_PLATE
          - null
          type:
          - 'null'
          - string
        wells:
          description: Well contents of the plate, keyed by position string (eg. "A1").
          oneOf:
          - format: uri
            type: string
          - type: 'null'
      type: object
    IProtein:
      properties:
        __typename:
          type: string
        aliases:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        chains:
          description: The chains and associated amino acid sequences on the protein.
          items:
            $ref: '#/components/schemas/ProteinChain'
          type: array
        createdAt:
          format: datetime
          type: string
        customFields:
          oneOf:
          - items:
              $ref: '#/components/schemas/CustomField'
            type: array
          - type: 'null'
        domains:
          description: The domains and associated amino acid sequences on the protein.
          items:
            $ref: '#/components/schemas/ProteinDomain'
          type: array
        entityRegistryId:
          type:
          - 'null'
          - string
        folder:
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        format:
          $ref: '#/components/schemas/ProteinFormatRef'
          description: The protein format that defines the structure (domains, chains,
            interactions) for the protein.
        fullHistory:
          description: '`fullHistory` is a superset of `history` that also returns
            inactive versions that are not part of the

            current version history. Versions are returned in chronological order
            (oldest first).'
          format: uri
          type: string
        history:
          description: 'Only the currently active version lineage, in chronological
            order (oldest first).


            If a change was made and then undone by resetting to an earlier version,
            the version recording

            that change is not relevant to the current state of the entity, so it
            is not included in this listing.'
          format: uri
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        outOfSync:
          description: Indicates if constituent domain or chain entities have changed
            since the protein was last updated.
          type: boolean
        outOfSyncReason:
          description: Any additional information about why the protein is out of
            sync.
          type:
          - 'null'
          - string
        project:
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        registrationOrigin:
          oneOf:
          - $ref: '#/components/schemas/RegistrationOrigin'
          - type: 'null'
        registry:
          oneOf:
          - $ref: '#/components/schemas/RegistryRef'
          - type: 'null'
        schema:
          $ref: '#/components/schemas/EntitySchemaRef'
      type: object
    IResult:
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          description: DateTime at which the the result was created
          format: datetime
          type:
          - 'null'
          - string
        id:
          description: ID of the result
          type: string
        modifiedAt:
          description: DateTime at which the the result was last modified
          format: datetime
          type:
          - 'null'
          - string
        project:
          description: The project that the result is in
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        schema:
          description: Schema that the result belongs to
          oneOf:
          - $ref: '#/components/schemas/ResultSchemaRef'
          - type: 'null'
      type: object
    IRnaOligo:
      properties:
        __typename:
          type: string
        aliases:
          description: Array of aliases
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        annotations:
          description: Annotations on the Oligo.
          items:
            $ref: '#/components/schemas/NucleotideAnnotation'
          type: array
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        bases:
          description: Bases of the Oligo.
          type: string
        createdAt:
          description: DateTime the Oligo was created.
          format: datetime
          type:
          - 'null'
          - string
        customFields:
          description: Custom fields set on the Oligo.
          oneOf:
          - items:
              $ref: '#/components/schemas/CustomField'
            type: array
          - type: 'null'
        entityRegistryId:
          description: Registry ID of the Oligo if registered.
          type:
          - 'null'
          - string
        folder:
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        id:
          description: ID of the Oligo.
          type: string
        modifiedAt:
          description: DateTime the Oligo was last modified.
          format: datetime
          type:
          - 'null'
          - string
        modifiedNucleotides:
          description: Modifications applied to this oligo.
          format: uri
          type: string
        name:
          description: Name of the Oligo.
          type: string
        project:
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        registrationOrigin:
          oneOf:
          - $ref: '#/components/schemas/RegistrationOrigin'
          - type: 'null'
        registry:
          description: Registry the Oligo is registered in.
          oneOf:
          - $ref: '#/components/schemas/RegistryRef'
          - type: 'null'
        schema:
          oneOf:
          - $ref: '#/components/schemas/EntitySchemaRef'
          - type: 'null'
      type: object
    IRnaSequence:
      properties:
        __typename:
          type: string
        aliases:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        annotations:
          description: 'Annotations on the RNA sequence, not including translations
            or primers. Annotations on parts are

            not included.'
          items:
            $ref: '#/components/schemas/NucleotideAnnotation'
          type: array
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        bases:
          description: Bases of the RNA sequence.
          type: string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        customFields:
          oneOf:
          - items:
              $ref: '#/components/schemas/CustomField'
            type: array
          - type: 'null'
        entityRegistryId:
          type:
          - 'null'
          - string
        folder:
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        modifiedNucleotides:
          description: Modifications applied to this RNA sequence.
          format: uri
          type: string
        name:
          type: string
        parts:
          description: Part features on the RNA sequence.
          format: uri
          type: string
        primers:
          description: Primer bind features on the RNA sequence. Primers on parts
            are not included.
          items:
            $ref: '#/components/schemas/Primer'
          type: array
        project:
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        registrationOrigin:
          oneOf:
          - $ref: '#/components/schemas/RegistrationOrigin'
          - type: 'null'
        registry:
          oneOf:
          - $ref: '#/components/schemas/RegistryRef'
          - type: 'null'
        schema:
          oneOf:
          - $ref: '#/components/schemas/EntitySchemaRef'
          - type: 'null'
        translations:
          description: 'Translation annotations present on the RNA sequence. Translations
            may be one region or split

            across multiple regions. Translations on parts are not included.'
          items:
            $ref: '#/components/schemas/Translation'
          type: array
      type: object
    IRun:
      properties:
        __typename:
          type: string
        archiveReason:
          description: If the Run is archived, reason for archiving
          type:
          - 'null'
          - string
        archived:
          description: Whether the Run is archived
          type: boolean
        createdAt:
          description: DateTime at which the run was created
          format: datetime
          type:
          - 'null'
          - string
        id:
          type: string
        isReviewed:
          description: Whether this run is in a reviewed entry
          type:
          - 'null'
          - boolean
        modifiedAt:
          description: DateTime at which the run was last modified
          format: datetime
          type:
          - 'null'
          - string
        project:
          description: Project this run is in
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        schema:
          description: Schema that this run belongs to
          oneOf:
          - $ref: '#/components/schemas/RunSchemaRef'
          - type: 'null'
        validationComment:
          description: Comment for this run's validation status
          type:
          - 'null'
          - string
        validationStatus:
          description: Validation status of this run - must be either VALID or INVALID
          enum:
          - VALID
          - INVALID
          - null
          type:
          - 'null'
          - string
      type: object
    IWellPlate:
      properties:
        __typename:
          type: string
        archiveReason:
          description: Why the plate is archived
          type:
          - 'null'
          - string
        archived:
          description: Whether the plate is archived
          type: boolean
        barcode:
          description: Barcode of the plate
          type:
          - 'null'
          - string
        createdAt:
          description: DateTime the plate was created
          format: datetime
          type: string
        id:
          description: ID of the plate
          type: string
        modifiedAt:
          description: DateTime the plate was last modified
          format: datetime
          type: string
        name:
          description: Name of the plate; defaults to barcode if name is not provided
          type: string
        parentStorage:
          description: Containing parent storage
          oneOf:
          - $ref: '#/components/schemas/LocationRef'
          - type: 'null'
        project:
          description: The project the plate is associated with
          oneOf:
          - $ref: '#/components/schemas/ProjectRef'
          - type: 'null'
        schema:
          $ref: '#/components/schemas/WellPlateSchemaRef'
          description: The schema of the plate
      type: object
    Ingredient:
      description: 'Represents a single component within a Mixture, specifying the
        substance and its

        amount. Each Ingredient references a componentEntity (the substance being
        added),

        an amount with units (see IngredientMeasurementUnits), and optional lot tracking

        information. The amount can be a numeric value or "QS" (quantum satis, meaning

        "as much as is needed") for one ingredient per mixture. Ingredients may optionally

        track component lots either as Container references (for physical inventory
        tracking)

        or as text. The targetAmount field is used when a mixture is derived from
        a parent

        mixture and indicates the proportional amount needed.'
      properties:
        __typename:
          type: string
        amount:
          description: 'The amount value of this ingredient in its mixture, in string
            format

            (to preserve full precision). Pair with `units`. Supports scientific

            notation (1.23e4). One ingredient on this mixture can have an amount

            value of `"QS"`.'
          type:
          - 'null'
          - string
        catalogIdentifier:
          type:
          - 'null'
          - string
        componentEntity:
          oneOf:
          - $ref: '#/components/schemas/EntityRef'
          - type: 'null'
        componentLotContainer:
          description: 'The container representing the component lot for this ingredient.
            This

            is only present if the mixture schema supports component lots in

            "storage" format.'
          oneOf:
          - $ref: '#/components/schemas/ContainerRef'
          - type: 'null'
        componentLotEntity:
          description: 'The entity representing the component lot for this ingredient.
            This is

            only present if the mixture schema supports component lots in

            "storage" format.'
          oneOf:
          - $ref: '#/components/schemas/EntityRef'
          - type: 'null'
        componentLotText:
          description: 'Text representing the component lot for this ingredient. This
            is only

            present if the mixture schema supports component lots in "text"

            format.'
          type:
          - 'null'
          - string
        hasParent:
          type:
          - 'null'
          - boolean
        notes:
          type:
          - 'null'
          - string
        targetAmount:
          description: 'The target amount for this ingredient such that this ingredient''s

            proportion in its mixture would preserve the equivalent ingredient''s

            proportion in the parent mixture. Pair with `units`.'
          type:
          - 'null'
          - string
        units:
          enum:
          - NL
          - UL
          - ML
          - L
          - MG
          - G
          - UNITS
          - CELLS
          - KG
          - MOL
          - UMOL
          - MMOL
          - UG
          - null
          type:
          - 'null'
          - string
      type: object
    InsertCoordinates:
      additionalProperties: false
      properties:
        position:
          anyOf:
          - enum:
            - beginning_of_document
            - end_of_document
            type: string
          - type: string
      type: object
    InsertDocumentPartsInput:
      additionalProperties: false
      properties:
        coordinates:
          $ref: '#/components/schemas/InsertCoordinates'
        operationType:
          enum:
          - insert
          type: string
        parts:
          items:
            $ref: '#/components/schemas/DocumentContentInput'
          type: array
        version:
          type: string
      required:
      - operationType
      - version
      - coordinates
      - parts
      type: object
    IntegerAppConfigSpec:
      description: Specifies that an app configuration field should accept an integer
        value.
      properties:
        __typename:
          type: string
        enum:
          description: Optional enum constraint — if present, the value must be one
            of these integers.
          oneOf:
          - items:
              type: integer
            type: array
          - type: 'null'
        requiredConfig:
          type:
          - 'null'
          - boolean
      type: object
    IntegerAppConfigValue:
      description: Stores an integer value in an app configuration field.
      properties:
        __typename:
          type: string
        value:
          type:
          - 'null'
          - integer
      type: object
    IntegerFieldDefinition:
      description: An integer field definition for whole number values. Supports numeric
        constraints (min/max) and units.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        numericMax:
          type:
          - 'null'
          - number
        numericMin:
          type:
          - 'null'
          - number
        systemName:
          type: string
        unit:
          oneOf:
          - $ref: '#/components/schemas/UnitRef'
          - type: 'null'
      type: object
    IntegerValue:
      description: A type that represents integer values.
      properties:
        __typename:
          type: string
        value:
          description: The integer value.
          type: integer
      type: object
    InternalLinkedMolecule:
      description: Linked molecule from the Benchling registry (internal)
      properties:
        __typename:
          type: string
        molecularFormulaOverride:
          type:
          - 'null'
          - string
        molecularWeightOverride:
          format: decimal
          type:
          - 'null'
          - string
        molecule:
          $ref: '#/components/schemas/MoleculeRef'
      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
    JsonAppConfigSpec:
      description: Specifies that an app configuration field should accept a JSON
        value.
      properties:
        __typename:
          type: string
        requiredConfig:
          type:
          - 'null'
          - boolean
      type: object
    JsonAppConfigValue:
      description: Stores a JSON value (as a string) in an app configuration field.
      properties:
        __typename:
          type: string
        value:
          type:
          - 'null'
          - string
      type: object
    JsonFieldDefinition:
      description: A JSON field definition for storing structured JSON data.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    JsonValue:
      description: A type that represents JSON values.
      properties:
        __typename:
          type: string
        value:
          description: The JSON value.
          type: object
      type: object
    LabelTemplate:
      description: 'A `LabelTemplate` defines the format for printing physical labels
        for inventory items, such as containers,

        plates, and boxes. Each template contains a template string, `zplTemplate`,
        that is populated with item data

        and sent to a compatible label printer. Template strings typically use ZPL
        (Zebra Programming Language), but

        for the most part, Benchling code treats them in a language agnostic way,
        and they can contain other printer

        languages, such as JScript, to work with less common printers. `LabelTemplate`s
        are associated with a Registry

        and enable consistent barcode labeling across an organization''s inventory.
        `LabelTemplate`s can include

        dynamic fields for barcodes, names, dates, and custom metadata.'
      properties:
        __typename:
          type: string
        createdAt:
          description: DateTime the label template was created
          format: datetime
          type:
          - 'null'
          - string
        id:
          description: ID of the label template.
          type: string
        modifiedAt:
          description: DateTime the label template was last modified
          format: datetime
          type:
          - 'null'
          - string
        name:
          description: Name of the label template.
          type: string
        registry:
          $ref: '#/components/schemas/RegistryRef'
          description: The registry associated with the label template
        zplTemplate:
          description: The ZPL template that will be filled in and sent to a printer.
          type: string
      type: object
    LabelTemplatePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/LabelTemplate'
          type: array
        nextToken:
          type: string
      type: object
    LegacyAppInstallation:
      description: 'Represents a legacy (pre-App Store) Benchling App installation
        on a tenant. Legacy apps

        are configured directly with webhook URLs and configuration specs rather than
        through

        app definition versions. This type is maintained for backward compatibility
        with older

        app integrations. For new apps, see `AppInstallation`.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        configurationSpecs:
          items:
            $ref: '#/components/schemas/AppConfigOption'
          type: array
        configurationValues:
          format: uri
          type: string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        creator:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        description:
          type:
          - 'null'
          - string
        featureSpecs:
          items:
            anyOf:
            - $ref: '#/components/schemas/CanvasFeatureSpec'
            - $ref: '#/components/schemas/AssayRunFeatureSpec'
            - $ref: '#/components/schemas/AppHomepageFeatureSpec'
            description: Union of CanvasFeatureSpec, AssayRunFeatureSpec, AppHomepageFeatureSpec
            discriminator:
              propertyName: __typename
          type: array
        featureValues:
          items:
            $ref: '#/components/schemas/AssayRunFeatureValue'
          type: array
        id:
          type: string
        messageSubscriptions:
          items:
            $ref: '#/components/schemas/AppMessageSubscription'
          type: array
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        publicKey:
          type:
          - 'null'
          - string
        versionNumber:
          type:
          - 'null'
          - string
        webhookUrl:
          type:
          - 'null'
          - string
      type: object
    LegacyAppInstallationPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/LegacyAppInstallation'
          type: array
        nextToken:
          type: string
      type: object
    LibraryParameterDefinition:
      description: 'A reusable parameter definition stored in the Parameter Library.
        LibraryParameterDefinitions allow

        organizations to standardize parameters used across multiple procedures by
        defining a name, description, data

        type, and optional unit type. When creating procedure parameters, users can
        link to a library parameter

        definition to inherit its settings, ensuring consistency across experiments.'
      properties:
        __typename:
          type: string
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        dataType:
          enum:
          - AA_PART_LINK
          - AA_SEQUENCE_LINK
          - ASSAY_REQUEST_LINK
          - ASSAY_RESULT_LINK
          - ASSAY_RUN_LINK
          - BATCH_LINK
          - BLOB_LINK
          - BOOLEAN
          - CUSTOM_ENTITY_LINK
          - DATE
          - DATETIME
          - DNA_SEQUENCE_LINK
          - ENTITY_LINK
          - ENTRY_LINK
          - FLOAT
          - INTEGER
          - JSON
          - LONG_TEXT
          - MIXTURE_LINK
          - MOLECULE_LINK
          - BASE_MOLECULE_LINK
          - PART_LINK
          - SAMPLE_LINK
          - DROPDOWN
          - STORAGE_LINK
          - TEXT
          - TRANSCRIPTION_LINK
          - TRANSLATION_LINK
          type: string
        description:
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        unitType:
          oneOf:
          - $ref: '#/components/schemas/UnitTypeRef'
          - type: 'null'
      type: object
    LibraryParameterDefinitionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/LibraryParameterDefinition'
          type: array
        nextToken:
          type: string
      type: object
    LinkSpan:
      description: LinkSpan is used when we want to apply a URL to a particular span
        of the text.
      properties:
        __typename:
          type: string
        end:
          description: The index where the link ends (exclusive).
          type: integer
        start:
          description: The index where the link starts (inclusive).
          type: integer
        url:
          type: string
      type: object
    LinkSpanInput:
      additionalProperties: false
      properties:
        end:
          type: integer
        start:
          type: integer
        url:
          type: string
      type: object
    ListItemContentInput:
      additionalProperties: false
      properties:
        contentType:
          enum:
          - list_item
          type: string
        formats:
          items:
            $ref: '#/components/schemas/TextFormatInput'
          type: array
        indentation:
          type: integer
        links:
          items:
            $ref: '#/components/schemas/LinkSpanInput'
          type: array
        listType:
          enum:
          - BULLET
          - NUMBER
          - CHECKBOX_CHECKED
          - CHECKBOX_UNCHECKED
          type: string
        mentions:
          items:
            $ref: '#/components/schemas/MentionInput'
          type: array
        text:
          type: string
      required:
      - contentType
      - listType
      - text
      type: object
    ListItemDocumentContent:
      description: 'Represents a single list item within notebook or document content.

        List items store their marker style, rich text, and indentation for ordered,
        unordered, and checklist blocks.'
      properties:
        __typename:
          type: string
        formats:
          items:
            $ref: '#/components/schemas/TextFormat'
          type: array
        indentation:
          type: integer
        links:
          items:
            $ref: '#/components/schemas/LinkSpan'
          type: array
        listType:
          enum:
          - BULLET
          - NUMBER
          - CHECKBOX_CHECKED
          - CHECKBOX_UNCHECKED
          type: string
        mentions:
          items:
            $ref: '#/components/schemas/Mention'
          type: array
        text:
          type: string
      type: object
    Location:
      allOf:
      - $ref: '#/components/schemas/ILocation'
      - description: 'A Location represents a physical storage area in Benchling''s
          inventory system, such as

          a freezer, refrigerator, shelf, room, or building. Locations form a hierarchy
          where

          each location can contain child locations (e.g., a freezer contains shelves)
          as well

          as inventory items like Boxes, Plates, and Containers when allowNonLocationChildren
          is

          true. Each location tracks its capacity (totalCapacity, availableCapacity,
          occupiedCapacity)

          and can restrict what types of items it accepts via allowedInventorySchemas.
          Locations

          conform to a LocationSchema that defines custom fields for the location
          type. Locations

          are identified by barcode for physical tracking and can be archived when
          no longer in use.'
        properties:
          __typename:
            type: string
          creator:
            oneOf:
            - $ref: '#/components/schemas/PrincipalRef'
            - type: 'null'
          schemaFields:
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    LocationInput:
      allOf:
      - properties:
          locationType:
            enum:
            - bind_and_overhang
            - start_and_end
            type: string
        required:
        - locationType
      - oneOf:
        - $ref: '#/components/schemas/PrimerBindPositionInput'
        - $ref: '#/components/schemas/PrimerStartEndInput'
      discriminator:
        propertyName: locationType
      type: object
    LocationPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Location'
          type: array
        nextToken:
          type: string
      type: object
    LocationRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    LocationSchema:
      description: 'Defines the structure and metadata for a category of Locations
        in Benchling''s inventory

        system. A LocationSchema specifies schema field definitions for capturing
        location-specific

        data (e.g., temperature range, access restrictions) and an optional Registry
        association

        with display ID prefix. LocationSchemas categorize different types of storage
        areas such

        as "Freezer", "Refrigerator", "Shelf", or "Room". Locations conforming to
        a schema inherit

        its field definitions, allowing consistent metadata capture across similar
        storage types.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          description: A description of the schema.
          type: string
        fieldDefinitions:
          format: uri
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        prefix:
          type:
          - 'null'
          - string
        registry:
          oneOf:
          - $ref: '#/components/schemas/RegistryRef'
          - type: 'null'
        systemName:
          description: A unique, stable identifier for this schema used for programmatic
            access and integrations.
          type: string
        type:
          type:
          - 'null'
          - string
      type: object
    LocationSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/LocationSchema'
          type: array
        nextToken:
          type: string
      type: object
    LocationSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    LongTextFieldDefinition:
      description: A long text field definition for multi-line text values with no
        length restrictions.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    MafftOptionsInput:
      additionalProperties: false
      properties:
        adjustDirection:
          description: Adjust direction.
          enum:
          - FAST
          - ACCURATE
          - DISABLED
          type: string
        gapExtensionPenalty:
          description: Gap extension penalty.
          type: number
        gapOpenPenalty:
          description: Gap open penalty.
          type: number
        maxIterations:
          description: Max refinement iterations. Can be in the range 0 to 100. Not
            applicable for auto strategy, as it will be selected automatically.
          type: integer
        retree:
          description: Tree rebuilding. Only used for 6-mer strategy.
          type: integer
        strategy:
          description: MAFFT strategy preset.
          enum:
          - AUTO
          - SIXMER
          - LOCALPAIR
          - GLOBALPAIR
          type: string
      type: object
    MarkdownUiBlock:
      description: A block that renders Markdown content.
      properties:
        __typename:
          type: string
        id:
          type: string
        value:
          type: string
      type: object
    MarkdownUiBlockInput:
      additionalProperties: false
      properties:
        id:
          type: string
        type:
          enum:
          - MARKDOWN
          type: string
        value:
          type: string
      required:
      - type
      - id
      - value
      type: object
    MaterialInputValuePlan:
      description: 'A pre-filled value for a material input within a `MethodParametersPlan`.
        The `materialInputId`

        references the `ProcedureParameterVersion` for the material input this value
        applies to. The

        `value` field contains the planned material specification in JSON format,
        typically including

        sample references and quantities. Used during experiment planning to pre-assign
        samples,

        reagents, or other materials that will be used when the procedure run is executed.'
      properties:
        __typename:
          type: string
        materialInputId:
          type: string
        value:
          type: object
      type: object
    MaterialInputValuePlanInput:
      additionalProperties: false
      properties:
        materialInputId:
          description: 'The ID of the material input parameter version. Format: `schver_XXXXXXXX`.'
          type: string
        value:
          description: 'A dict with the shape {"value": {"material": <TypedValue |
            null>, "amount": <TypedValue | null>}}. The material TypedValue must match
            the referenced material input''s configured type: {"type": "ft_string",
            "value": "..."} for text inputs, or {"type": "ft_file_link", "targetFiles":
            [...]} for entity link inputs. The amount TypedValue is always ft_float
            (e.g., {"type": "ft_float", "floatValue": 1.0, "value": "1.0"}). Either
            sub-field may be null independently.'
          type: object
      required:
      - materialInputId
      - value
      type: object
    MatrixPlate:
      allOf:
      - $ref: '#/components/schemas/IMatrixPlate'
      - description: 'A MatrixPlate is a rack-style storage plate where Containers
          (tubes, vials) can be

          inserted into and removed from grid positions. Unlike FixedPlate or WellPlate
          where

          wells are permanently attached, MatrixPlate positions (see MatrixPlatePosition)
          can

          be empty or hold movable containers. This makes MatrixPlates ideal for tube
          racks,

          sample storage boxes with removable tubes, and other flexible storage formats.
          Each

          plate tracks its capacity (totalCapacity, availableCapacity, occupiedCapacity)
          and

          conforms to a MatrixPlateSchema that defines the grid dimensions and optionally

          restricts which ContainerSchema types can be stored. MatrixPlates can be
          stored in

          Locations, associated with Studies, and identified by barcode.'
        properties:
          __typename:
            type: string
          creator:
            $ref: '#/components/schemas/PrincipalRef'
            description: The user who created the plate
          schemaFields:
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    MatrixPlatePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/MatrixPlate'
          type: array
        nextToken:
          type: string
      type: object
    MatrixPlatePosition:
      description: A well position within a MatrixPlate.
      properties:
        __typename:
          type: string
        container:
          description: Container at the current position within the matrix plate.
          oneOf:
          - $ref: '#/components/schemas/ContainerRef'
          - type: 'null'
        coordinates:
          $ref: '#/components/schemas/GridCoordinates'
          description: Coordinates of the current position within the matrix plate.
      type: object
    MatrixPlatePositionInput:
      additionalProperties: false
      properties:
        barcode:
          type: string
        position:
          type: string
      required:
      - position
      type: object
    MatrixPlateSchema:
      description: 'Defines the structure and constraints for a category of MatrixPlates
        in Benchling''s

        inventory system. A MatrixPlateSchema specifies the grid dimensions (height
        and width),

        an optional ContainerSchema for tubes that can be inserted, and custom field
        definitions.

        Unlike WellPlateSchema where wells are permanently fixed, MatrixPlateSchema
        defines

        plates where containers can be inserted into and removed from positions. Examples
        include

        tube racks and sample storage matrices. Each schema is associated with a Registry

        and given a prefix for generating display IDs.'
      properties:
        __typename:
          type: string
        archiveReason:
          description: Why the schema was archived.
          type:
          - 'null'
          - string
        archived:
          description: Whether the schema is archived.
          type: boolean
        containerSchema:
          description: The container schema used for positions in plates of this schema.
          oneOf:
          - $ref: '#/components/schemas/ContainerSchemaRef'
          - type: 'null'
        createdAt:
          description: When the schema was created.
          format: datetime
          type: string
        description:
          description: A description of the schema.
          type: string
        fieldDefinitions:
          description: The fields inherited by plates of this schema.
          format: uri
          type: string
        height:
          description: The number of rows in plates of this schema.
          type: integer
        id:
          description: The ID of the schema.
          type: string
        modifiedAt:
          description: When the schema was last modified.
          format: datetime
          type: string
        name:
          description: The name of the schema.
          type: string
        prefix:
          description: The prefix of barcodes autogenerated for plates of this schema.
          type: string
        registry:
          $ref: '#/components/schemas/RegistryRef'
          description: The schema's registry.
        systemName:
          description: A unique, stable identifier for this schema used for programmatic
            access and integrations.
          type: string
        width:
          description: The number of columns in plates of this schema.
          type: integer
      type: object
    MatrixPlateSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/MatrixPlateSchema'
          type: array
        nextToken:
          type: string
      type: object
    MatrixPlateSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    McpServerChatSourceInput:
      additionalProperties: false
      properties:
        serverId:
          description: API ID of the MCP server to enable (e.g. mcpconf_abc123).
          type: string
        type:
          enum:
          - mcp_server
          type: string
      required:
      - type
      - serverId
      type: object
    Measurement:
      description: 'Represents a quantity with an associated unit of measurement within
        Benchling''s inventory

        system. Measurements are used throughout inventory to track container volumes,
        sample

        masses, concentrations, and other quantitative values. Each Measurement pairs
        a numeric

        value with a Unit (see Unit) to provide context-aware quantity handling. For
        example,

        a container might have a Measurement of 500 uL for its volume. Unlike ContainerQuantity

        which provides a simpler representation, Measurement supports the full Unit
        system with

        dimensional conversions.'
      properties:
        __typename:
          type: string
        unit:
          oneOf:
          - $ref: '#/components/schemas/UnitRef'
          - type: 'null'
        value:
          type:
          - 'null'
          - number
      type: object
    MeasurementInput:
      additionalProperties: false
      properties:
        unitId:
          type:
          - 'null'
          - string
        value:
          type:
          - 'null'
          - number
      required:
      - unitId
      - value
      type: object
    MeltTransform:
      description: 'A data transform that unpivots wide-format data into long format
        by converting

        selected value columns into rows, each identified by a variable name.'
      properties:
        __typename:
          type: string
        transformationProperties:
          description: Additional parameters for this transform
          oneOf:
          - $ref: '#/components/schemas/MeltTransformationProperties'
          - type: 'null'
        type:
          description: The type of this transform (MELT)
          enum:
          - ADD_COLUMN
          - ARITHMETIC
          - CUSTOM
          - DUPLICATE
          - EXTRA_HEADERS
          - EXTRA_FOOTERS
          - FILTER
          - FIND_REPLACE
          - MERGE
          - MELT
          - PLATE_SHAPE
          - PIVOT
          - REMOVE_QUOTES
          - SPLIT
          - null
          type:
          - 'null'
          - string
      type: object
    MeltTransformationProperties:
      description: 'Properties for a MELT transform, specifying identifier columns
        to keep fixed, value

        columns to unpivot, and optional names for the new variable and value columns.'
      properties:
        __typename:
          type: string
        identifierColumns:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        newValueColumn:
          type:
          - 'null'
          - string
        newVariableColumn:
          type:
          - 'null'
          - string
        valueColumns:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
      type: object
    Mention:
      description: 'Represents an inline mention of another Benchling item within
        text content.

        Mentions allow users to reference entities (sequences, samples, entries, etc.)
        directly

        in their notebook text. The mention appears as a clickable chip displaying
        the item''s name.'
      properties:
        __typename:
          type: string
        itemId:
          description: The API identifier of the referenced Benchling item (e.g.,
            seq_XXXXX, etr_XXXXX).
          type: string
        position:
          description: The position in the raw text where this mention is inserted.
            This is an index into the parent's `text` field.
          type: integer
      type: object
    MentionInput:
      additionalProperties: false
      properties:
        itemId:
          type: string
        position:
          type: integer
      type: object
    MergeTransform:
      description: 'A data transform that concatenates values from multiple columns
        into a single output

        column, separated by a configurable delimiter.'
      properties:
        __typename:
          type: string
        transformationProperties:
          description: Additional parameters for this transform
          oneOf:
          - $ref: '#/components/schemas/MergeTransformationProperties'
          - type: 'null'
        type:
          description: The type of this transform (MERGE)
          enum:
          - ADD_COLUMN
          - ARITHMETIC
          - CUSTOM
          - DUPLICATE
          - EXTRA_HEADERS
          - EXTRA_FOOTERS
          - FILTER
          - FIND_REPLACE
          - MERGE
          - MELT
          - PLATE_SHAPE
          - PIVOT
          - REMOVE_QUOTES
          - SPLIT
          - null
          type:
          - 'null'
          - string
      type: object
    MergeTransformationProperties:
      description: 'Properties for a MERGE transform, specifying the columns to combine,
        the output

        column name, and the delimiter placed between merged values.'
      properties:
        __typename:
          type: string
        columnNames:
          description: Names of columns to be merged
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        delimiter:
          description: Delimiter to put between merged values
          type:
          - 'null'
          - string
        outputColumnName:
          description: Name of column to contain merged values
          type:
          - 'null'
          - string
      type: object
    MergedCellAnchor:
      description: 'Coordinates of a merge anchor cell, used on child cells to point
        back to the anchor

        that owns the merged region.'
      properties:
        __typename:
          type: string
        col:
          description: Column index of the anchor cell (0-based).
          type: integer
        row:
          description: Row index of the anchor cell (0-based).
          type: integer
      type: object
    MetadataColumnInput:
      additionalProperties: false
      properties:
        name:
          type: string
        plateValue:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: boolean
          - type: 'null'
        systemName:
          type: string
        type:
          enum:
          - text
          - integer
          - float
          - boolean
          - date
          - datetime
          type: string
        wells:
          items:
            $ref: '#/components/schemas/MetadataWellInput'
          type: array
      required:
      - name
      - type
      type: object
    MetadataWellInput:
      additionalProperties: false
      properties:
        value:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: boolean
          - type: 'null'
        wellPosition:
          type: string
      required:
      - wellPosition
      - value
      type: object
    MethodParametersPlan:
      description: 'Contains the planned parameter values for a single unit operation
        (method) within a

        `ProcedureRunPlanCondition`. Links to a `ProcedureMethodDefinitionVersion`
        via

        `templateMethodVersion` to identify which method these values apply to. Parameter
        values are

        organized by category: `dataParameterValues` for data fields like numbers
        or text,

        `materialInputValues` for sample or reagent inputs, and `equipmentValues`
        for equipment

        assignments. When the parent `ProcedureRunPlan` is promoted to a `ProcedureRun`,
        these planned

        values become the starting values in the resulting `ProcedureMethodExecutionInstance`.'
      properties:
        __typename:
          type: string
        dataParameterValues:
          description: Planned values for data parameters keyed by parameter identifiers.
          items:
            $ref: '#/components/schemas/DataParameterValuePlan'
          type: array
        equipmentValues:
          description: Planned values for equipment keyed by equipment identifiers.
          items:
            $ref: '#/components/schemas/EquipmentValuePlan'
          type: array
        materialInputValues:
          description: Planned values for material inputs keyed by input identifiers.
          items:
            $ref: '#/components/schemas/MaterialInputValuePlan'
          type: array
      type: object
    MethodParametersPlanInput:
      additionalProperties: false
      properties:
        dataParameterValues:
          description: Planned values for data parameters in this method.
          items:
            $ref: '#/components/schemas/DataParameterValuePlanInput'
          type: array
        equipmentValues:
          description: Planned values for equipment parameters in this method.
          items:
            $ref: '#/components/schemas/EquipmentValuePlanInput'
          type: array
        materialInputValues:
          description: Planned values for material inputs in this method.
          items:
            $ref: '#/components/schemas/MaterialInputValuePlanInput'
          type: array
      required:
      - dataParameterValues
      - materialInputValues
      - equipmentValues
      type: object
    Mixture:
      allOf:
      - $ref: '#/components/schemas/IMixture'
      - description: 'A Mixture is a formulation entity in Benchling that represents
          a combination of

          ingredients with specified amounts. Mixtures are commonly used for buffers,
          media,

          reagent preparations, and other multi-component solutions. Each mixture
          has a total

          amount with units (see MixtureMeasurementUnits) and contains a list of Ingredients

          specifying what goes into the mixture. Mixtures can be registered in the
          Registry,

          organized in folders and projects, and may have preparation instructions
          attached

          (see MixtureInstructions). The `allowMeasuredIngredients` setting (from
          the schema)

          determines whether the mixture is a thoeretical "recipe", which has target
          amonunts, or a physical "prep",

          with measured amounts.'
        properties:
          __typename:
            type: string
          authors:
            oneOf:
            - format: uri
              type: string
            - type: 'null'
          creator:
            oneOf:
            - $ref: '#/components/schemas/PrincipalRef'
            - type: 'null'
        type: object
    MixtureLinkFieldDefinition:
      description: A schema field definition for linking to mixtures.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent mixture. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinition:
          oneOf:
          - $ref: '#/components/schemas/MixtureSchemaRef'
          - type: 'null'
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    MixturePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Mixture'
          type: array
        nextToken:
          type: string
      type: object
    MixtureSchema:
      description: Defines the structure, field definitions, and configuration options
        for Mixtures.
      properties:
        __typename:
          type: string
        allowMeasuredIngredients:
          description: 'Whether this mixture schema allows recording measured values
            for ingredients.

            When enabled, users can track actual measured amounts in addition to target
            amounts.'
          type: boolean
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        componentLotStorageEnabled:
          description: 'Whether mixture ingredients can specify their component lot
            as a container and/or entity from inventory.

            Only applicable when allowMeasuredIngredients is true.

            Will be null when allowMeasuredIngredients is false.'
          type:
          - 'null'
          - boolean
        componentLotTextEnabled:
          description: 'Whether mixture ingredients can specify their component lot
            as a text value.

            Only applicable when allowMeasuredIngredients is true.

            Will be null when allowMeasuredIngredients is false.'
          type:
          - 'null'
          - boolean
        constraint:
          oneOf:
          - $ref: '#/components/schemas/Constraint'
          - type: 'null'
        containableType:
          enum:
          - NONE
          - ENTITY
          - BATCH
          type: string
        containerNameTemplate:
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplate'
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          type: string
        fieldDefinitions:
          format: uri
          type: string
        fieldsets:
          format: uri
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - MIXTURE
          - MORTAR_PESTLE
          - POWDER
          - POWDER_BEAKER
          - RECIPE
          - SOLUTION
          type: string
        id:
          type: string
        includeRegistryIdInChips:
          type: boolean
        itemIdPrefix:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        nameTemplate:
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplate'
          - type: 'null'
        organization:
          $ref: '#/components/schemas/OrganizationRef'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfiguration'
          type: array
        systemName:
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    MixtureSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/MixtureSchema'
          type: array
        nextToken:
          type: string
      type: object
    MixtureSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    MixtureSchemaSetFieldDefinitionsInput:
      additionalProperties: false
      properties:
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateSystemCategoryLinkFieldDefinitionInput'
          type: array
      required:
      - fieldDefinitions
      type: object
    ModifiedNucleotide:
      description: 'Represents a chemically modified nucleotide at a specific position
        in an oligonucleotide

        sequence. Each modification specifies the sugar, base, and phosphate monomers
        (see NucleotideMonomer)

        that replace or modify the natural nucleotide at that position. Common modifications
        include

        2''-O-methyl sugars for stability, phosphorothioate backbones for nuclease
        resistance, or

        modified bases for binding affinity. Used in NucleotideSimplePolymer to capture
        the

        modification pattern of therapeutic oligonucleotides.'
      properties:
        __typename:
          type: string
        baseMonomer:
          $ref: '#/components/schemas/NucleotideMonomerRef'
          description: The base monomer for the modification.
        createdAt:
          description: DateTime the modification was created.
          format: datetime
          type: string
        id:
          description: The ID of the modified nucleotide.
          type: string
        nucleotideSequence:
          $ref: '#/components/schemas/NucleotideSequenceRef'
          description: The nucleotide sequence that this modification belongs to.
        phosphateMonomer:
          description: The phosphate monomer for the modification. If empty, it represents
            a null phosphate at the 5' end of the sequence.
          oneOf:
          - $ref: '#/components/schemas/NucleotideMonomerRef'
          - type: 'null'
        position:
          description: 0-based index of the modification.
          type: integer
        sugarMonomer:
          $ref: '#/components/schemas/NucleotideMonomerRef'
          description: The sugar monomer for the modification.
      type: object
    ModifiedNucleotidePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ModifiedNucleotide'
          type: array
        nextToken:
          type: string
      type: object
    Molecule:
      allOf:
      - $ref: '#/components/schemas/IMolecule'
      - description: 'A Molecule represents a small molecule chemical compound in
          Benchling that is imported either as a MolFile or

          using SMILES (Simplified Molecular Input Line Entry System) notation. Molecules
          are registry entities that can

          be registered, searched, and linked to other items. When present, the `canonicalSmiles`
          field provides a

          standardized SMILES representation for comparison, while originalSmiles
          preserves the user-provided SMILES and

          may be null if SMILES was not provided at creation. Molecules support custom
          fields via schemas and can be

          organized in folders and projects.'
        properties:
          __typename:
            type: string
          authors:
            oneOf:
            - format: uri
              type: string
            - type: 'null'
          creator:
            oneOf:
            - $ref: '#/components/schemas/PrincipalRef'
            - type: 'null'
          schemaFields:
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    MoleculeLinkFieldDefinition:
      description: A schema field definition for linking to molecules.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent molecule. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinition:
          oneOf:
          - $ref: '#/components/schemas/MoleculeSchemaRef'
          - type: 'null'
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    MoleculePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Molecule'
          type: array
        nextToken:
          type: string
      type: object
    MoleculeRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    MoleculeSchema:
      description: Defines the structure, field definitions, and configuration options
        for Molecule schemas.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/Constraint'
          - type: 'null'
        containableType:
          enum:
          - NONE
          - ENTITY
          - BATCH
          type: string
        containerNameTemplate:
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplate'
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          type: string
        fieldDefinitions:
          format: uri
          type: string
        fieldsets:
          format: uri
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - SMALL_MOLECULE
          - SMALL_MOLECULE_BEAKER
          type: string
        id:
          type: string
        includeRegistryIdInChips:
          type: boolean
        itemIdPrefix:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        nameTemplate:
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplate'
          - type: 'null'
        organization:
          $ref: '#/components/schemas/OrganizationRef'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfiguration'
          type: array
        systemName:
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    MoleculeSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/MoleculeSchema'
          type: array
        nextToken:
          type: string
      type: object
    MoleculeSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    MoleculeSchemaSetFieldDefinitionsInput:
      additionalProperties: false
      properties:
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateSystemCategoryLinkFieldDefinitionInput'
          type: array
      required:
      - fieldDefinitions
      type: object
    MoveDocumentPartsInput:
      additionalProperties: false
      properties:
        destinationCoordinates:
          $ref: '#/components/schemas/InsertCoordinates'
        operationType:
          enum:
          - move
          type: string
        sourceCoordinates:
          $ref: '#/components/schemas/RangeCoordinates'
        version:
          type: string
      required:
      - operationType
      - version
      - sourceCoordinates
      - destinationCoordinates
      type: object
    MoveFolderInput:
      additionalProperties: false
      properties:
        parentId:
          type: string
      required:
      - parentId
      type: object
    MultipleValuesFilterTransformationProperties:
      description: 'Properties for a FILTER transform that filters rows by checking
        whether a column''s

        value is in (ISIN) or not in (NOTIN) a set of allowed values.'
      properties:
        __typename:
          type: string
        column:
          description: Name of column to be filtered
          type:
          - 'null'
          - string
        type:
          description: Type of filtering to perform (ISIN or NOTIN)
          enum:
          - LT
          - LE
          - GE
          - GT
          - EQ
          - NE
          - ISIN
          - NOTIN
          - ISNULL
          - NOTNULL
          - null
          type:
          - 'null'
          - string
        values:
          description: Values to filter on
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
      type: object
    NewSequenceInput:
      additionalProperties: false
      properties:
        folderId:
          type: string
      required:
      - folderId
      type: object
    NucleotideAlignment:
      description: 'Represents a multiple sequence alignment of nucleotide sequences
        (DNA or RNA). Nucleotide

        alignments are used to compare sequence reads against a reference template
        for verification

        (see AlignmentType TEMPLATE) or to align multiple sequences for consensus
        building (see

        AlignmentType CONSENSUS). Each alignment contains a referenceSequence (the
        template or

        consensus) and a collection of AlignedNucleotideSequence entries representing
        the individual sequences

        being compared. Alignments are commonly used in Sanger sequencing verification
        workflows

        to confirm that a cloned construct matches the expected design.'
      properties:
        __typename:
          type: string
        alignedNucleotideSequences:
          description: The Aligned Nucleotide Sequences of the Alignment.
          format: uri
          type: string
        alignmentType:
          description: The type of the Alignment, whether it is a consensus or template
            alignment.
          enum:
          - TEMPLATE
          - CONSENSUS
          type: string
        createdAt:
          description: DateTime the Alignment was created.
          format: datetime
          type: string
        id:
          description: The ID of the Alignment.
          type: string
        modifiedAt:
          description: DateTime the Alignment was last modified.
          format: datetime
          type: string
        name:
          description: The name of the Alignment.
          type: string
        referenceSequence:
          $ref: '#/components/schemas/NucleotideSequenceRef'
          description: The template or consensus Nucleotide Sequence associated with
            the Alignment.
      type: object
    NucleotideAlignmentPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/NucleotideAlignment'
          type: array
        nextToken:
          type: string
      type: object
    NucleotideAlignmentRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    NucleotideAnnotation:
      description: 'Represents a biological feature annotation on a nucleotide sequence
        (DNA or RNA). Annotations

        mark regions of interest such as genes, promoters, terminators, regulatory
        elements, or other

        functionally significant sequences. Each annotation specifies a position range
        (start/end),

        strand orientation, feature type classification, display color, and descriptive
        notes.

        Annotations appear as visual overlays on the sequence viewer and can be created
        manually,

        imported from standard formats like GenBank, or generated automatically using
        FeatureLibraries.'
      properties:
        __typename:
          type: string
        color:
          description: Hex color when displaying the annotation.
          type: string
        end:
          description: '0-based exclusive end index. For ranges ending at the end
            of a circular sequence, this value is

            always the length of the sequence, never 0.'
          type: integer
        name:
          description: Name of the annotation.
          type: string
        notes:
          description: Text notes on the annotation.
          type: string
        start:
          description: 0-based inclusive start index.
          type: integer
        strand:
          description: Strand for this annotation; 1 for forward strand, -1 for reverse
            strand, and 0 for no strand.
          type: integer
        type:
          description: Feature type of the annotation.
          type:
          - 'null'
          - string
      type: object
    NucleotideAnnotationInput:
      additionalProperties: false
      properties:
        color:
          type: string
        customFields:
          items:
            $ref: '#/components/schemas/CustomFieldInput'
          type: array
        end:
          type: integer
        name:
          type: string
        notes:
          description: Field will be set to an empty string if not specified.
          type: string
        start:
          type: integer
        strand:
          enum:
          - FORWARD
          - REVERSE
          - null
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - name
      - end
      - start
      type: object
    NucleotideMonomer:
      description: 'A building block component of modified oligonucleotides, representing
        a sugar, phosphate,

        or base subunit. Monomers are the chemical units that assemble to form nucleotides
        in

        therapeutic oligonucleotide design. Each monomer has a symbol identifier,
        chemical structure

        (SMILES), molecular weight, and attachment points defining where it bonds
        to other monomers.

        The naturalAnalog field links modified monomers to their natural counterparts
        (e.g., a

        2''-O-methyl ribose analog links to natural ribose ''r''). Monomers are referenced
        in

        ModifiedNucleotide and CustomNotationAlias to specify the exact chemistry
        of modified

        sequences. Also known as building blocks in oligonucleotide synthesis contexts.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        attachmentPoints:
          description: A list of the capping group present at each location where
            the monomer can form a bond with other monomers.
          items:
            type: string
          type: array
        calculatedMolecularWeight:
          description: The molecular weight of the monomer as calculated by RDKit
            based on the monomer chemical structure.
          type:
          - 'null'
          - number
        canonicalSmiles:
          description: The SMILES representation of the monomer chemical structure
            after being standardized.
          type: string
        createdAt:
          format: datetime
          type: string
        customMolecularWeight:
          description: Optional molecular weight value that the user can provide to
            override the calculated molecular weight.
          type:
          - 'null'
          - number
        exactMolecularWeight:
          description: The exact molecular weight of the monomer as calculated by
            RDKit based on the monomer chemical structure.
          type: number
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        monomerType:
          description: The part of the nucleotide structure that the monomer fits
            into, i.e. backbone or branch.
          enum:
          - BACKBONE
          - BRANCH
          type: string
        name:
          type: string
        naturalAnalog:
          description: 'Natural equivalent of the monomer. For example, a modified
            ribose would have `r` as the natural analog,

            which is the symbol for natural ribose.'
          enum:
          - A
          - C
          - G
          - T
          - U
          - N
          - r
          - d
          - p
          - R
          - Y
          - M
          - K
          - W
          - S
          - B
          - D
          - H
          - V
          type: string
        originalSmiles:
          description: The SMILES string that was originally provided upon creation
            of the monomer.
          type:
          - 'null'
          - string
        polymerType:
          description: 'The polymer type of the monomer, per the HELM definition of
            polymer type. Because nucleotide monomers are only used in

            modified nucleotide sequences, the polymer type of a NucleotideMonomer
            is always `RNA`.'
          enum:
          - RNA
          type: string
        symbol:
          description: User-defined identifier of the monomer, unique on the monomer
            type.
          type: string
        visualColor:
          description: The color code of the monomer visual symbol.
          type:
          - 'null'
          - string
        visualSymbol:
          description: The shape of the monomer visual symbol.
          enum:
          - DIAMOND_FILLED
          - DIAMOND_HOLLOW
          - DIAMOND_DASHED
          - STAR_FILLED
          - STAR_HOLLOW
          - TRIANGLE_FILLED
          - TRIANGLE_HOLLOW
          - DYAD_FILLED
          - DYAD_HOLLOW
          - CLOVER_FILLED
          - CLOVER_HOLLOW
          - TRIAD_FILLED
          - TRIAD_HOLLOW
          - RECTANGLE_FILLED
          - RECTANGLE_HOLLOW
          - LETTERS_C
          - LETTERS_CO
          - LETTERS_M
          - LETTERS_MP
          - LETTERS_P
          - LETTERS_PS
          - LETTERS_R
          - LETTERS_RS
          - LETTERS_S
          - LETTERS_SP
          - null
          type:
          - 'null'
          - string
      type: object
    NucleotideMonomerPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/NucleotideMonomer'
          type: array
        nextToken:
          type: string
      type: object
    NucleotideMonomerRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    NucleotidePartInput:
      additionalProperties: false
      properties:
        end:
          type: integer
        reverseComplement:
          description: Field will be set to false if not specified.
          type: boolean
        sequenceId:
          type: string
        start:
          type: integer
      required:
      - end
      - sequenceId
      - start
      type: object
    NucleotideSequenceRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    NucleotideSimplePolymer:
      description: 'Represents a nucleic acid strand (DNA or RNA) within a complex
        polymer structure. Contains the sequence

        residues, any chemical modifications (see ModifiedNucleotide), and connections
        to other polymers. The entity

        field links to a corresponding DnaSequence, RnaSequence, DnaOligo, or RnaOligo.
        Used as the backbone component

        in OligoConjugate and as forward/reverse strands in OligoDuplex.'
      properties:
        __typename:
          type: string
        connections:
          items:
            $ref: '#/components/schemas/ComplexPolymerConnection'
          type: array
        entity:
          $ref: '#/components/schemas/NucleotideSequenceRef'
        helmReference:
          type: string
        modifications:
          description: Chemical modifications applied at specific positions on this
            strand.
          items:
            $ref: '#/components/schemas/ModifiedNucleotide'
          type: array
        nucleotideType:
          description: Whether this strand is DNA or RNA.
          enum:
          - DNA
          - RNA
          type: string
        polymerType:
          type: string
        residues:
          description: The nucleotide base sequence of this strand.
          type: string
      type: object
    NullFilterTransformationProperties:
      description: 'Properties for a FILTER transform that filters rows based on null
        or non-null values

        in a specified column.'
      properties:
        __typename:
          type: string
        column:
          description: Name of column to be filtered
          type:
          - 'null'
          - string
        type:
          description: Type of filtering to perform
          enum:
          - LT
          - LE
          - GE
          - GT
          - EQ
          - NE
          - ISIN
          - NOTIN
          - ISNULL
          - NOTNULL
          - null
          type:
          - 'null'
          - string
      type: object
    NumberCellEvaluationValue:
      description: A numeric evaluation value with optional display formatting.
      properties:
        __typename:
          type: string
        precision:
          type:
          - 'null'
          - integer
        scientificNotation:
          type:
          - 'null'
          - boolean
        value:
          type: number
      type: object
    NumberValueFilterTransformationProperties:
      description: 'Properties for a FILTER transform that filters rows by comparing
        a column''s numeric

        value using relational operators (EQ, NE, LE, LT, GE, GT).'
      properties:
        __typename:
          type: string
        column:
          description: Name of column to be filtered
          type:
          - 'null'
          - string
        type:
          description: Type of filtering to perform (EQ, NE, LE, LT, GE, or GT)
          enum:
          - LT
          - LE
          - GE
          - GT
          - EQ
          - NE
          - ISIN
          - NOTIN
          - ISNULL
          - NOTNULL
          - null
          type:
          - 'null'
          - string
        value:
          description: Value to filter on
          type:
          - 'null'
          - number
      type: object
    ObjectLinkListValue:
      description: A type that represents a list of links to other objects.
      properties:
        __typename:
          type: string
        value:
          description: The list of objects that this value links to. Inaccessible
            objects may be returned instead if the object is not found with the current
            permission set.
          items:
            $ref: '#/components/schemas/ObjectRef'
            description: Union of AaSequence, Box, Container, CustomEntity, DnaSequence,
              DropdownOption, Entry, Location, Mixture, Molecule, Plate, Result, RnaSequence,
              Run, DnaOligo, RnaOligo
          type: array
      type: object
    ObjectLinkValue:
      description: A type that represents links to other objects.
      properties:
        __typename:
          type: string
        value:
          $ref: '#/components/schemas/ObjectRef'
          description: The object that this value links to, or an Inaccessible object
            if not found with the current permission set.
      type: object
    ObjectRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    OligoAnnotationInput:
      additionalProperties: false
      properties:
        color:
          description: Color will be set at random if not specified.
          type: string
        customFields:
          items:
            $ref: '#/components/schemas/CustomFieldInput'
          type: array
        end:
          type: integer
        name:
          type: string
        notes:
          description: Field will be set to an empty string if not specified.
          type: string
        start:
          type: integer
        strand:
          description: Strand direction. Only forward strand is supported. Leaving
            the field empty or skipping it will mark the Oligo as Strandless.
          enum:
          - FORWARD
          - null
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - name
      - start
      - end
      - type
      type: object
    OligoConjugate:
      allOf:
      - $ref: '#/components/schemas/IOligoConjugate'
      - description: 'An oligo conjugate is a therapeutic modality consisting of a
          single-stranded

          oligonucleotide backbone with one or more attached conjugate molecules.
          Common

          examples include antisense oligonucleotides (ASOs) with GalNAc ligands for
          liver

          targeting, or siRNA strands with lipid or cholesterol conjugates. The backbone

          references the underlying oligo entity, while conjugates lists the attached
          molecules.

          Structure is defined using HELM notation and can be edited via the visual
          structure

          editor. Supports versioning (see OligoConjugateVersion) to track changes
          over time.'
        properties:
          __typename:
            type: string
          authors:
            oneOf:
            - format: uri
              type: string
            - type: 'null'
          creator:
            $ref: '#/components/schemas/PrincipalRef'
          schemaFields:
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    OligoConjugateCreate:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        authorIds:
          items:
            type: string
          type: array
        componentMapping:
          additionalProperties:
            type: string
          type: object
        connections:
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        entityRegistryId:
          type: string
        folderId:
          type: string
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - folderId
      - name
      - schemaId
      - componentMapping
      - connections
      type: object
    OligoConjugateLinkFieldDefinition:
      description: A schema field definition for linking to Oligo Conjugates.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent Oligo Conjugate.
            Important for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinition:
          oneOf:
          - $ref: '#/components/schemas/OligoConjugateSchemaRef'
          - type: 'null'
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    OligoConjugatePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/OligoConjugate'
          type: array
        nextToken:
          type: string
      type: object
    OligoConjugateSchema:
      description: Defines the structure, field definitions, and configuration options
        for Oligo Conjugates.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/Constraint'
          - type: 'null'
        containableType:
          enum:
          - NONE
          - ENTITY
          - BATCH
          type: string
        containerNameTemplate:
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplate'
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          type: string
        fieldDefinitions:
          format: uri
          type: string
        fieldsets:
          format: uri
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - NETWORK_WIRED
          - OLIGO
          - OLIGO_V2
          - PRIMER_PAIR
          - PROTEIN
          - RNA_SEQUENCE
          - SEQUENCE
          - SMALL_MOLECULE
          type: string
        id:
          type: string
        includeRegistryIdInChips:
          type: boolean
        itemIdPrefix:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        nameTemplate:
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplate'
          - type: 'null'
        organization:
          $ref: '#/components/schemas/OrganizationRef'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfiguration'
          type: array
        systemName:
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    OligoConjugateSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/OligoConjugateSchema'
          type: array
        nextToken:
          type: string
      type: object
    OligoConjugateSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    OligoConjugateSchemaSetFieldDefinitionsInput:
      additionalProperties: false
      properties:
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateSystemCategoryLinkFieldDefinitionInput'
          type: array
      required:
      - fieldDefinitions
      type: object
    OligoConjugateUpdate:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        authorIds:
          items:
            type: string
          type: array
        componentMapping:
          additionalProperties:
            type: string
          type: object
        connections:
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        entityRegistryId:
          type: string
        folderId:
          type: string
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      type: object
    OligoConjugateUpdateWithPathParams:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        authorIds:
          items:
            type: string
          type: array
        componentMapping:
          additionalProperties:
            type: string
          type: object
        connections:
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        entityRegistryId:
          type: string
        folderId:
          type: string
        id:
          type: string
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - id
      type: object
    OligoDuplex:
      allOf:
      - $ref: '#/components/schemas/IOligoDuplex'
      - description: 'An oligo duplex is a therapeutic modality consisting of two
          complementary

          oligonucleotide strands (forward and reverse) with optional conjugate molecules

          attached to either strand. The classic example is siRNA (small interfering
          RNA),

          which uses double-stranded RNA for gene silencing. The forwardStrand and
          reverseStrand

          reference the underlying oligo entities, with hydrogen bonds automatically
          computed

          for base pairing. Structure is defined using HELM notation and can be edited
          via

          the visual structure editor. Supports versioning (see OligoDuplexVersion)
          to track

          changes over time.'
        properties:
          __typename:
            type: string
          authors:
            oneOf:
            - format: uri
              type: string
            - type: 'null'
          creator:
            $ref: '#/components/schemas/PrincipalRef'
          schemaFields:
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    OligoDuplexCreate:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        authorIds:
          items:
            type: string
          type: array
        componentMapping:
          additionalProperties:
            type: string
          type: object
        connections:
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        entityRegistryId:
          type: string
        folderId:
          type: string
        forwardOffset:
          description: 'Offset of the forward strand relative to the reverse strand,
            in residues. For example, -2 means

            the forward strand begins 2 positions before the reverse strand.'
          type: integer
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - folderId
      - name
      - schemaId
      - componentMapping
      - connections
      - forwardOffset
      type: object
    OligoDuplexLinkFieldDefinition:
      description: A schema field definition for linking to Oligo Duplexes.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent Oligo Duplex. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinition:
          oneOf:
          - $ref: '#/components/schemas/OligoDuplexSchemaRef'
          - type: 'null'
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    OligoDuplexPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/OligoDuplex'
          type: array
        nextToken:
          type: string
      type: object
    OligoDuplexSchema:
      description: Defines the structure, field definitions, and configuration options
        for Oligo Duplexes.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/Constraint'
          - type: 'null'
        containableType:
          enum:
          - NONE
          - ENTITY
          - BATCH
          type: string
        containerNameTemplate:
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplate'
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          type: string
        fieldDefinitions:
          format: uri
          type: string
        fieldsets:
          format: uri
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - NETWORK_WIRED
          - PRIMER_PAIR
          - SEQUENCE
          type: string
        id:
          type: string
        includeRegistryIdInChips:
          type: boolean
        itemIdPrefix:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        nameTemplate:
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplate'
          - type: 'null'
        organization:
          $ref: '#/components/schemas/OrganizationRef'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfiguration'
          type: array
        systemName:
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    OligoDuplexSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/OligoDuplexSchema'
          type: array
        nextToken:
          type: string
      type: object
    OligoDuplexSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    OligoDuplexSchemaSetFieldDefinitionsInput:
      additionalProperties: false
      properties:
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateSystemCategoryLinkFieldDefinitionInput'
          type: array
      required:
      - fieldDefinitions
      type: object
    OligoDuplexUpdate:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        authorIds:
          items:
            type: string
          type: array
        componentMapping:
          additionalProperties:
            type: string
          description: Mapping from schema component names to entity names. To update
            the duplex structure, provide componentMapping, connections, and forwardOffset
            together.
          type: object
        connections:
          description: Connection definitions for the duplex structure. To update
            the duplex structure, provide componentMapping, connections, and forwardOffset
            together.
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        entityRegistryId:
          type: string
        folderId:
          type: string
        forwardOffset:
          description: Offset of the forward strand relative to the reverse strand,
            in residues. For example, -2 means the forward strand begins 2 positions
            before the reverse strand. To update the duplex structure, provide componentMapping,
            connections, and forwardOffset together.
          type: integer
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      type: object
    OligoDuplexUpdateWithPathParams:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        authorIds:
          items:
            type: string
          type: array
        componentMapping:
          additionalProperties:
            type: string
          description: Mapping from schema component names to entity names. To update
            the duplex structure, provide componentMapping, connections, and forwardOffset
            together.
          type: object
        connections:
          description: Connection definitions for the duplex structure. To update
            the duplex structure, provide componentMapping, connections, and forwardOffset
            together.
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        entityRegistryId:
          type: string
        folderId:
          type: string
        forwardOffset:
          description: Offset of the forward strand relative to the reverse strand,
            in residues. For example, -2 means the forward strand begins 2 positions
            before the reverse strand. To update the duplex structure, provide componentMapping,
            connections, and forwardOffset together.
          type: integer
        id:
          type: string
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - id
      type: object
    OligoRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    Organization:
      description: 'Represents a group of users within Benchling, typically corresponding
        to a company,

        department, or research group. Organizations provide a many-to-many relationship
        between

        users—each user can belong to multiple organizations, and each organization
        can have

        multiple users. Users are designated as either ADMIN (with management privileges)
        or

        MEMBER within the organization via `GroupMembership`. Organizations can own
        resources

        like Projects and Folders, and can contain Teams for finer-grained user grouping.

        Organizations also control access settings such as whether members can create
        personal

        ownables and what default policies apply to new resources. In the UI, organizations

        appear in user profiles and are used for sharing and access control throughout
        Benchling.'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type: string
        handle:
          type: string
        id:
          type: string
        memberships:
          format: uri
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type:
          - 'null'
          - string
      type: object
    OrganizationPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Organization'
          type: array
        nextToken:
          type: string
      type: object
    OrganizationRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    OwnerRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ParameterLayerInput:
      additionalProperties: false
      properties:
        fieldType:
          enum:
          - TEXT
          - FLOAT
          - DATETIME
          type: string
        name:
          type: string
        parameterVersionId:
          type: string
        wells:
          items:
            $ref: '#/components/schemas/ParameterWellInput'
          type: array
      required:
      - parameterVersionId
      - name
      - fieldType
      type: object
    ParameterWellInput:
      additionalProperties: false
      properties:
        value:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: 'null'
        wellPosition:
          type: string
      required:
      - wellPosition
      - value
      type: object
    PeptideSimplePolymer:
      description: 'Represents a peptide or protein chain within a complex polymer
        structure. Contains the amino acid residue

        sequence and connections to other polymers. The entity field links to a corresponding
        `AaSequence`. Used when

        protein/aa-sequence components are part of larger bioconjugate structures.'
      properties:
        __typename:
          type: string
        connections:
          items:
            $ref: '#/components/schemas/ComplexPolymerConnection'
          type: array
        entity:
          $ref: '#/components/schemas/AaSequenceRef'
        helmReference:
          type: string
        polymerType:
          type: string
        residues:
          type: string
      type: object
    PipelineRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    PipelineStep:
      description: 'Represents a single operation node within a Pipeline''s directed
        acyclic graph (DAG). Each

        step performs a specific transformation determined by its stepType (see `PipelineStepType`),

        with configuration options stored in the config field. Steps receive data
        through

        inputStepDatas and produce results via outputStepDatas (see `PipelineStepData`).
        The

        incomingEdges and outgoingEdges (see `PipelineStepEdge`) define the data flow
        connections

        to other steps. Execution state is tracked through statusCode and statusMessage.
        Steps

        support provenance tracking through the provenanceUri field for tracing data
        lineage.'
      properties:
        __typename:
          type: string
        config:
          type:
          - 'null'
          - object
        createdAt:
          format: datetime
          type: string
        id:
          type: string
        inputStepDatas:
          format: uri
          type: string
        modifiedAt:
          format: datetime
          type: string
        outputStepDatas:
          format: uri
          type: string
        pipeline:
          $ref: '#/components/schemas/PipelineRef'
        statusCode:
          enum:
          - AI_PROPOSED
          - BLOCKED
          - FAILED
          - HALTED
          - RUNNING
          - SUCCEEDED
          - WAITING
          type: string
        statusMessage:
          type:
          - 'null'
          - string
        stepType:
          enum:
          - AGGREGATE_DATASET
          - AUTOFILL_ANTIBODY_ELEMENT_SUBELEMENTS
          - ANNOTATE_ANTIBODY_INPUTS
          - ANOVA
          - APPLY_COLUMN_MAPPING
          - BIN_DATA
          - BOLTZ2
          - BOLTZGEN
          - BOLTZGEN_SUCCESS
          - BULK_IMPORT
          - CHAI1
          - CHART_VIEW
          - COMPUTED_COLUMN
          - CONCATENATE_ANTIBODY_COMPONENT_DOMAINS_TO_CHAINS
          - CONNECTION_DATA_DATASET
          - CONVERT_ASM_TO_CSV
          - CONVERT_FILE_TO_DATASET_WITH_DATA_ENTRY_ASSISTANT
          - CONVERT_JSON_TO_DATASET
          - CONVERT_OPENFOLD2_OUTPUT
          - CONVERT_OPENFOLD3_OUTPUT
          - CONVERT_TO_ASM
          - CREATE_DATASET_FROM_FILE
          - CREATE_ENTITIES
          - CREATE_METERING_USAGE_CHART
          - CREATE_PROCEDURE_DATASET
          - DATASET_VIEW
          - DATA_CATALOG_DATASET
          - DATA_CATALOG_FILE
          - DATA_CATALOG_FILES
          - DEFINE_TEMPLATE_VARIABLES
          - EXPERIMENT_OPTIMIZATION_BOOTSTRAP
          - EXPERIMENT_OPTIMIZATION_CLEAN_DATA
          - EXPERIMENT_OPTIMIZATION_EXPLANATION
          - EXPERIMENT_OPTIMIZATION_GENERATE_SEARCH_SPACE
          - EXPERIMENT_OPTIMIZATION_POSTERIOR_SUMMARY
          - EXPERIMENT_OPTIMIZATION_RECOMMENDATION
          - EXPERIMENT_OPTIMIZATION_TRAINING
          - EXPLORATORY_DATA_ANALYSIS
          - EXPORT_DATA_CATALOG_DATASET
          - EXPORT_DATA_CATALOG_FILE
          - EXTRACT_DATA_FRAME_VALUE
          - EXTRACT_OR_REMOVE_LINES
          - FILL_PLATE
          - FILTER_DATASET
          - FIND_AND_REPLACE
          - FLAG_ROWS
          - FORMAT_COLUMNS
          - GENERATE_ANALYSIS_VIEW_URL
          - GENERATE_BOLTZGEN_YAML
          - GENERATE_BOLTZ_YAML
          - GENERATE_FASTA
          - GENERATE_MODEL_RUN_INPUT
          - GENERATE_OPENFOLD2_JSON
          - GENERATE_OPENFOLD3_JSON
          - HIDE_COLUMNS
          - IMPORT_PLATES
          - IMPORT_SCRATCH_FILE
          - INITIALIZE_DATASET
          - INSERT_RESULT_URL_IN_DOCUMENT
          - INTERPOLATE_MARKDOWN
          - JOIN
          - LAYOUT
          - LEGACY_DATA_IMPORT_ENTRY_CREATION
          - LEGACY_DATA_IMPORT_INITIATION
          - LEGACY_DATA_IMPORT_TRANSCRIPTION
          - LOOK_UP
          - MAP_COLUMNS
          - MAP_JSON_TO_DATASETS_AND_FILES
          - MODEL_RUN_INFERENCE
          - MOVE_INVENTORY_PLATES
          - COMPUTE_NDC_ENTITY_MERGED_COLUMNS
          - NDC_COMBINE_DOMAINS_TO_VARIABLE_PAIRS
          - NDC_EXPAND_VARIABLE_PAIRS_TO_DOMAINS
          - NDC_REFERENCE_EXISTING_COMPONENTS
          - NOTEBOOK_TABLE_DATASET
          - OPENFOLD2
          - OPENFOLD3
          - PARAMETER_OPTIMIZATION_CONFIGURATION
          - PARAMETER_OPTIMIZATION_DATASET_CONFIGURATION
          - PARAMETER_OPTIMIZATION_MODELING
          - PARAMETER_OPTIMIZATION_PREDICTION
          - PIVOT_DATASET
          - PLATE_SCHEMA_DATASET
          - PLATES_TO_DATASETS
          - POSTPROCESS_MODEL_RUN
          - PROCEDURE_RUN_DATA_FRAMES
          - PROMOTE_DATASET
          - REGISTRY_SCHEMA_DATASET
          - REGISTER_PLATES_IN_INVENTORY
          - REGRESSION
          - REGRESSION_INTERPOLATION
          - RENAME_COLUMNS
          - REORDER_COLUMNS
          - RETYPE_COLUMNS
          - RUN_HAMILTON_METHOD
          - RUN_HIGHRES_PROTOCOL
          - RUN_OPENTRONS_PROTOCOL
          - SAVE_STRUCTURE_PREDICTION
          - SAVE_TO_RESULTS
          - SEND_TO_CONNECTION
          - SEND_TO_DOCUMENT
          - SEND_USER_NOTIFICATION
          - SORT_COLUMNS
          - STATIC_TEMPLATE_INPUT_TABLE
          - TABLE_VIEW
          - TEMPLATE_INPUT
          - TEST_ALL_CONFIGS
          - THIRD_PARTY
          - TRANSFER_PLATES
          - TRANSFORM_PROTEIN_BULK_INGEST_OUTPUT_TO_DATASET
          - TRANSLATE_ANTIBODY_COMPONENT_DNA_TO_AA
          - T_TEST
          - UNION_DATASETS
          - UNPIVOT_DATASET
          - UPDATE_ENTITIES
          - UPLOAD_CSV_DATASET
          - USER_DEFINED_FUNCTION
          - GENERATE_NDC_ERROR_CSV
          - VALIDATE_AND_TRANSFORM_ANTIBODY_INPUTS
          - VARIABLE_TEMPLATE_INPUT_TABLE
          - WAREHOUSE_SQL_DATASET
          - WINDOW_FUNCTIONS
          type: string
        stepVersion:
          type: integer
      type: object
    PipelineStepData:
      description: 'Represents actual data attached to an input or output slot of
        a PipelineStep during execution.

        Each PipelineStepData corresponds to a defined data shape (input or output)
        on the step''s

        configuration and holds references to the raw data (see `RawStepData`) that
        fills that slot.

        The name field identifies which data shape this instance fills. Multiple raw
        data items can

        be attached when the data shape allows multiple values (isMulti). PipelineStepData
        enables

        data flow between pipeline steps by tracking data lineage and provenance through
        the

        provenanceUri field.'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        parentStep:
          $ref: '#/components/schemas/PipelineStepRef'
        rawDatas:
          items:
            $ref: '#/components/schemas/ObjectRef'
            description: Union of Chart, DataFrame, ScratchFile, ScratchPlate
          type: array
      type: object
    PipelineStepDataPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/PipelineStepData'
          type: array
        nextToken:
          type: string
      type: object
    PipelineStepDataRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    PipelineStepDataUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/PipelineStepData'
          type: array
      type: object
    PipelineStepPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/PipelineStep'
          type: array
        nextToken:
          type: string
      type: object
    PipelineStepRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    PipelineStepUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/PipelineStep'
          type: array
      type: object
    PivotTransform:
      description: 'A data transform that reshapes long-format data into wide format
        by pivoting unique

        values from a keys column into separate columns.'
      properties:
        __typename:
          type: string
        transformationProperties:
          description: Additional parameters for this transform
          oneOf:
          - $ref: '#/components/schemas/PivotTransformationProperties'
          - type: 'null'
        type:
          description: The type of this transform (PIVOT)
          enum:
          - ADD_COLUMN
          - ARITHMETIC
          - CUSTOM
          - DUPLICATE
          - EXTRA_HEADERS
          - EXTRA_FOOTERS
          - FILTER
          - FIND_REPLACE
          - MERGE
          - MELT
          - PLATE_SHAPE
          - PIVOT
          - REMOVE_QUOTES
          - SPLIT
          - null
          type:
          - 'null'
          - string
      type: object
    PivotTransformationProperties:
      description: 'Properties for a PIVOT transform, specifying the index columns
        to group by, the

        keys column whose values become new column headers, and the values column
        to spread.'
      properties:
        __typename:
          type: string
        indexColumns:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        keysColumn:
          type:
          - 'null'
          - string
        valuesColumn:
          type:
          - 'null'
          - string
      type: object
    Plate:
      allOf:
      - $ref: '#/components/schemas/IPlate'
      - description: 'A Plate is a legacy unified type representing both well plates
          and tube racks in

          Benchling''s inventory system. The type field (see PlateType) indicates
          whether this

          is a FIXED_PLATE (wells permanently attached, like 96-well or 384-well plates)
          or a

          MATRIX_PLATE (removable containers in a grid, like tube racks). For new
          integrations,

          prefer using the specific FixedPlate and MatrixPlate types which provide
          clearer

          semantics and type-specific fields. Plates can be stored in Locations (via
          parentStorage),

          associated with Studies, and identified by barcode. The wells field returns
          Container

          objects representing the plate positions.'
        properties:
          __typename:
            type: string
          creator:
            oneOf:
            - $ref: '#/components/schemas/PrincipalRef'
            - type: 'null'
        type: object
    PlateDesignTemplate:
      description: 'A named plate design template backed by a scratch plate that lives
        in a template collection.

        Plate design templates allow scratch plates to be organized and reused as
        templates.'
      properties:
        __typename:
          type: string
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        scratchPlate:
          $ref: '#/components/schemas/ScratchPlateRef'
        templateCollection:
          $ref: '#/components/schemas/TemplateCollectionRef'
        webUrl:
          type:
          - 'null'
          - string
      type: object
    PlateDesignTemplatePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/PlateDesignTemplate'
          type: array
        nextToken:
          type: string
      type: object
    PlateLayout:
      description: 'Specifies the well-mapping layout used when generating input file
        rows for plate-based

        transfers. The layout type controls how sample positions on a source plate
        map to

        positions on a destination plate.'
      properties:
        __typename:
          type: string
        layoutType:
          description: The type of the PlateLayout
          enum:
          - COLUMN_INTERLEAVE
          - INTERLEAVE
          - REVERSE_COLUMN_INTERLEAVE
          - REVERSE_INTERLEAVE
          - REVERSE_STAMP_TO_QUADRANTS
          - STAMP
          - STAMP_TO_QUADRANTS
          - null
          type:
          - 'null'
          - string
      type: object
    PlatePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Plate'
          type: array
        nextToken:
          type: string
      type: object
    PlateSchema:
      description: 'Defines the structure and constraints for a category of Plates
        in Benchling''s inventory

        system. A PlateSchema specifies the grid dimensions (height and width), the
        plate type

        (see PlateType), and optionally links to a ContainerSchema that constrains
        what container

        types can occupy positions. Schema field definitions allow capturing plate-specific

        metadata. PlateSchema is the legacy unified schema type; for new configurations,
        prefer

        using the specific WellPlateSchema (for fixed plates) or MatrixPlateSchema
        (for tube

        racks). Each schema is associated with a Registry and given a prefix for generating

        display IDs and barcodes.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        containerSchema:
          oneOf:
          - $ref: '#/components/schemas/ContainerSchemaRef'
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        fieldDefinitions:
          format: uri
          type: string
        height:
          type:
          - 'null'
          - integer
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        plateType:
          enum:
          - MATRIX_PLATE
          - FIXED_PLATE
          - null
          type:
          - 'null'
          - string
        prefix:
          type:
          - 'null'
          - string
        registryId:
          type:
          - 'null'
          - string
        type:
          type:
          - 'null'
          - string
        width:
          type:
          - 'null'
          - integer
      type: object
    PlateSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/PlateSchema'
          type: array
        nextToken:
          type: string
      type: object
    PlateSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    PlateShapeTransform:
      description: 'A data transform that extracts plate-shaped data from a file by
        locating the well

        grid at specified coordinates and optionally removing all surrounding cells.'
      properties:
        __typename:
          type: string
        transformationProperties:
          description: Additional parameters for this transform
          oneOf:
          - $ref: '#/components/schemas/PlateShapeTransformationProperties'
          - type: 'null'
        type:
          description: The type of this transform (PLATE_SHAPE)
          enum:
          - ADD_COLUMN
          - ARITHMETIC
          - CUSTOM
          - DUPLICATE
          - EXTRA_HEADERS
          - EXTRA_FOOTERS
          - FILTER
          - FIND_REPLACE
          - MERGE
          - MELT
          - PLATE_SHAPE
          - PIVOT
          - REMOVE_QUOTES
          - SPLIT
          - null
          type:
          - 'null'
          - string
      type: object
    PlateShapeTransformationProperties:
      description: 'Properties for a PLATE_SHAPE transform, specifying the plate schema
        for expected

        dimensions, the cell coordinates of well A1, and whether to discard data outside

        the plate region.'
      properties:
        __typename:
          type: string
        deleteOtherCells:
          description: Whether to delete all cells outside of the plate shape data
          type:
          - 'null'
          - boolean
        firstWellColumnIndex:
          description: Column index in the file of well A1
          type:
          - 'null'
          - integer
        firstWellRowIndex:
          description: Row index in the file of well A1
          type:
          - 'null'
          - integer
        plateSchema:
          description: API ID of a PlateSchema that defines expected plate dimensions
          type:
          - 'null'
          - string
      type: object
    Policy:
      description: 'Defines a named set of permissions that can be assigned to users
        or groups through

        collaborations. Policies contain PolicyStatements that specify allowed actions
        on

        different item types. When a user is granted a collaboration with a specific
        policy,

        they receive all permissions defined in that policy''s statements. Common
        policies

        include viewer (read-only access), editor (read and write), and admin (full
        control).

        Policies are reusable and can be applied across many collaborations.'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        policyStatements:
          items:
            $ref: '#/components/schemas/PolicyStatement'
          type: array
        policyType:
          enum:
          - DATA_POLICY
          - SCHEMA_POLICY
          - POLICY
          type: string
      type: object
    PolicyPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Policy'
          type: array
        nextToken:
          type: string
      type: object
    PolicyRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    PolicyStatement:
      description: 'A single permission rule within a Policy. Combines an ItemType
        (what kind of object),

        an Action (what operation), and a Condition (when it applies) to define a
        specific

        permission grant. Multiple PolicyStatements together form a complete Policy
        that

        determines what actions a user can perform.'
      properties:
        __typename:
          type: string
        action:
          enum:
          - READ
          - APPEND
          - WRITE
          - ADMIN
          - ARCHIVE
          - CHANGE_ASSIGNMENT_OF_OBJECTS
          - CHANGE_REGISTRY_IDENTIFIER
          - CREATE
          - CREATE_LOCATION
          - CREATE_REQUEST
          - CREATE_RESULT
          - CREATE_SUBFOLDER
          - CREATE_TEST_ORDERS
          - EDIT_BARCODES
          - EDIT_CHEMICAL_STRUCTURE
          - EDIT_CONTAINER
          - EDIT_FIELDS_IF_PENDING_INVALID
          - EDIT_FIELDS_IF_IN_PROGRESS
          - EDIT_FIELDS_IF_TERMINAL
          - EDIT_NAMES_AND_ALIASES
          - EDIT_NAMES_AND_BARCODES
          - EDIT_POLYMER_FEATURES
          - EDIT_RESIDUES
          - EDIT_RESTRICTED_SAMPLE_USERS
          - EDIT_RESULT
          - EDIT_SCHEMA_AND_FIELDS
          - EDIT_STATUS
          - EDIT_USER_EMAIL
          - EXECUTE_REQUEST
          - LIST_DEFINITION
          - MANAGE_COLLABORATORS
          - MANAGE_CAPABILITIES
          - READ_APP_CONFIG
          - READ_APP_SESSION
          - REGISTER
          - RETRACT_REVIEW
          - RESTRICT_SAMPLES
          - REVOKE_USER_CREDENTIALS
          - SUSPEND_USER
          - UNREGISTER
          - UNRESTRICT_SAMPLES
          - WRITE_APP_CONFIG
          - WRITE_APP_SESSION
          - UNKNOWN
          type: string
        condition:
          enum:
          - ALWAYS
          - IS_AUTHOR
          - IS_ASSIGNEE
          - UNKNOWN
          type: string
        itemType:
          enum:
          - AA_MONOMER
          - AGENT_SKILL
          - AI_MODEL
          - ANALYSIS
          - ANALYTICS_DASHBOARD
          - ANTIBODY_FORMAT
          - APP_DEFINITION
          - ASYNC_TASK
          - AV_SCAN_RECORD
          - BATCH
          - BENCHLING_APP
          - BENCHLING_APP_SESSION
          - BIOENTITY
          - BOX
          - BUSINESS_RULE
          - ASSEMBLY
          - CHAT_SESSION
          - CHEMICAL_COUNTERPART
          - CONFIG_MIGRATION_HISTORY
          - CONNECTION
          - CONTAINER
          - EVENT_SUBSCRIPTION
          - EXTENSION_DEFINITION
          - FOLDER_OR_PROJECT
          - FILE
          - INSTRUMENT
          - NON_LOCATION_STORABLE
          - LEGACY_DATA_IMPORT_RUN
          - LIBRARY_PARAMETER_DEFINITION
          - LOCATION
          - MCP_SERVER_INSTALLATION
          - MCP_SERVER_USER_CONFIG
          - MODEL_RUN
          - MONOMER
          - NOTEBOOK
          - ORGANIZATION
          - PLATE
          - PROCEDURE
          - PROCESS_TASK_GROUP
          - PROCESS_TASK
          - PROCESS_OUTPUT
          - PROTOCOL
          - REGISTRY
          - REVIEW_PROCESS
          - REQUEST
          - REQUEST_V2_DEFINITION
          - REQUEST_V2_SUBMISSION
          - RESULT
          - ROUTINE
          - SAMPLE_TYPE
          - SCHEMA
          - STUDY
          - TEAM
          - TEMPLATE_COLLECTION
          - TENANT
          - TEST_ORDER
          - USER
          - WAREHOUSE_LOGIN
          - WAREHOUSE_USER_DEFINED_VIEW
          - WORKFLOW
          - WORKLIST
          - WORKSHEET
          - OTHER
          - UNIT_TYPE
          - UNKNOWN
          type: string
      type: object
    PredictionBatch:
      description: 'Represents an execution of a Model Hub model against multiple
        data inputs (resulting in multiple Predictions).

        A PredictionBatch tracks the input configuration, execution status, and results.

        Each batch is associated with a specific model and version, enabling version
        tracking.

        Common use cases include protein structure prediction, property prediction,
        and sequence generation.'
      properties:
        __typename:
          type: string
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        folder:
          $ref: '#/components/schemas/FolderRef'
        id:
          type: string
        jobConfigs:
          items:
            type: object
          type: array
        model:
          type: string
        modelImplementationVersion:
          type: string
        modelVersion:
          type:
          - 'null'
          - string
        modifiedAt:
          format: datetime
          type: string
        predictionJobs:
          format: uri
          type: string
        status:
          enum:
          - AI_PROPOSED
          - BLOCKED
          - FAILED
          - HALTED
          - RUNNING
          - SUCCEEDED
          - WAITING
          type: string
      type: object
    PredictionBatchInput:
      additionalProperties: false
      properties:
        configSchemaVersion:
          type:
          - 'null'
          - integer
        folderId:
          type: string
        jobConfigs:
          items:
            $ref: '#/components/schemas/PredictionBatchJobConfigInput'
          type: array
        model:
          type: string
        modelImplementationVersion:
          type:
          - 'null'
          - string
        name:
          type: string
      required:
      - folderId
      - model
      - name
      - jobConfigs
      type: object
    PredictionBatchJobConfigInput:
      additionalProperties: false
      properties:
        config:
          type: object
        name:
          type:
          - 'null'
          - string
      required:
      - config
      type: object
    PredictionBatchPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/PredictionBatch'
          type: array
        nextToken:
          type: string
      type: object
    PredictionBatchRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    PredictionJob:
      description: 'Represents a single prediction within a PredictionBatch.

        Each PredictionJob captures the input configuration for one prediction

        and its association with input components (e.g., AA sequences, molecules).'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type: string
        id:
          type: string
        input:
          type: object
        modifiedAt:
          format: datetime
          type: string
        predictedStructureUrl:
          type:
          - 'null'
          - string
        predictionBatch:
          $ref: '#/components/schemas/PredictionBatchRef'
        properties:
          type:
          - 'null'
          - object
        resultsDownloadUrl:
          type:
          - 'null'
          - string
        status:
          enum:
          - AI_PROPOSED
          - BLOCKED
          - FAILED
          - HALTED
          - RUNNING
          - SUCCEEDED
          - WAITING
          type: string
      type: object
    PredictionJobPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/PredictionJob'
          type: array
        nextToken:
          type: string
      type: object
    Primer:
      description: 'Represents a primer binding site on a nucleotide sequence, indicating
        where an oligonucleotide primer anneals

        for PCR amplification or sequencing. The Primer links to an Oligo entity containing
        the actual primer sequence

        and name. Position fields define the binding region on the template (start/end),
        while bindPosition specifies

        the 3'' end of the binding region (critical for extension). The overhangLength
        indicates how many 5'' bases

        extend beyond the binding region (used for adding restriction sites or tags).
        Strand indicates whether the

        primer binds to the forward (1) or reverse (-1) strand.'
      properties:
        __typename:
          type: string
        bindPosition:
          description: 0-based index of the base at the 3' end of the binding region.
          type: integer
        end:
          description: '0-based exclusive end of the binding region. For ranges ending
            at the end of a circular sequence,

            this value is always the length of the sequence, never 0.'
          type: integer
        oligo:
          $ref: '#/components/schemas/OligoRef'
          description: Linked primer entity, which holds the name, bases, and color
            for this primer bind site.
        overhangLength:
          description: Number of 5' primer bases that are not part of the binding
            region.
          type: integer
        start:
          description: 0-based inclusive start of the binding region.
          type: integer
        strand:
          description: Strand for this primer; 1 for forward strand, -1 for reverse
            strand.
          type: integer
      type: object
    PrimerBindPositionInput:
      additionalProperties: false
      properties:
        bindPosition:
          type: integer
        locationType:
          enum:
          - bind_and_overhang
          type: string
        overhangLength:
          type: integer
      required:
      - locationType
      - bindPosition
      - overhangLength
      type: object
    PrimerInput:
      additionalProperties: false
      properties:
        location:
          $ref: '#/components/schemas/LocationInput'
        oligoId:
          type: string
        strand:
          enum:
          - FORWARD
          - REVERSE
          type: string
      required:
      - oligoId
      - strand
      - location
      type: object
    PrimerStartEndInput:
      additionalProperties: false
      properties:
        end:
          type: integer
        locationType:
          enum:
          - start_and_end
          type: string
        start:
          type: integer
      required:
      - locationType
      - end
      - start
      type: object
    Principal:
      anyOf:
      - $ref: '#/components/schemas/AppInstallation'
      - $ref: '#/components/schemas/LegacyAppInstallation'
      - $ref: '#/components/schemas/ServicePrincipal'
      - $ref: '#/components/schemas/User'
      discriminator:
        propertyName: __typename
      type: object
    PrincipalCollaboratorInfo:
      description: Represents a Principal that is the subject for a Collaboration.
      properties:
        __typename:
          type: string
        collaborator:
          $ref: '#/components/schemas/PrincipalRef'
      type: object
    PrincipalRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    PrincipalUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Principal'
          type: array
      type: object
    Printer:
      description: 'A Printer represents a network-connected label printer configured
        in Benchling for printing

        barcode labels on inventory items. Printers are associated with a Registry
        and work with

        LabelTemplates to generate properly formatted labels. Each printer is identified
        by a

        network address and optional port number.'
      properties:
        __typename:
          type: string
        address:
          description: Network address of the printer.
          type: string
        createdAt:
          description: Datetime when the printer was created.
          format: datetime
          type:
          - 'null'
          - string
        description:
          description: Short description of the printer.
          type:
          - 'null'
          - string
        id:
          description: ID of the printer.
          type: string
        modifiedAt:
          description: Datetime when the printer was last modified.
          format: datetime
          type:
          - 'null'
          - string
        name:
          description: Name of the printer.
          type: string
        port:
          description: Port to reach the printer at.
          type:
          - 'null'
          - integer
        registry:
          $ref: '#/components/schemas/RegistryRef'
          description: The registry associated with this printer.
      type: object
    PrinterPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Printer'
          type: array
        nextToken:
          type: string
      type: object
    Procedure:
      description: 'A reusable template that defines a structured experimental workflow.
        Procedures specify a

        sequence of method steps (see `ProcedureMethodDefinitionVersion`) connected
        in a flowchart

        (see `workflowFlowchartConfig` and `WorkflowFlowchartConfigVersion`) that
        scientists follow when running

        experiments. The `procedureType` determines whether this is a recipe (synthesis/production

        workflow) or an assay (analytical workflow). Procedures belong to a `TemplateCollection`
        for

        organization and access control, and support versioning through publishing
        (see `Publishable`

        and `publishingRecords`). When scientists execute a procedure, they create
        a `ProcedureRun`

        that tracks the actual experiment execution.'
      properties:
        __typename:
          type: string
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        id:
          type: string
        latestProcedureFlowchartConfigVersionProxy:
          description: 'A simplified view of the latest version of the flowchart config.
            This is the

            preferred way to access the latest flowchart config for procedures.'
          oneOf:
          - $ref: '#/components/schemas/ProcedureFlowchartConfigVersionProxyRef'
          - type: 'null'
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        procedureFlowchart:
          deprecated: true
          description: Use latestProcedureFlowchartConfigVersionProxy for the latest
            flowchart version and publishedProcedureFlowchartConfigVersionProxy for
            the published flowchart version.
          oneOf:
          - $ref: '#/components/schemas/ProcedureFlowchartRef'
          - type: 'null'
        procedureType:
          enum:
          - RECIPE
          - ASSAY
          type: string
        publishedProcedureFlowchartConfigVersionProxy:
          description: 'A simplified view of the published version of the flowchart
            config. This is

            the preferred way to access the published flowchart config for procedures.'
          oneOf:
          - $ref: '#/components/schemas/ProcedureFlowchartConfigVersionProxyRef'
          - type: 'null'
        templateCollection:
          $ref: '#/components/schemas/TemplateCollectionRef'
        webUrl:
          type:
          - 'null'
          - string
      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
    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
    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
    ProcedureExecutionStepGroup:
      description: 'Groups step execution instances by their execution phase during
        a procedure run. Analogous

        to `ProcedureStepGroup` but contains actual execution instances (`ProcedureStepExecutionInstance`)

        rather than step definitions. Each group''s steps are ordered by execution
        sequence.'
      properties:
        __typename:
          type: string
        group:
          enum:
          - PRE_RUN
          - RUN
          - POST_RUN
          type: string
        steps:
          items:
            $ref: '#/components/schemas/ProcedureStepExecutionInstanceRef'
          type: array
      type: object
    ProcedureFlowchart:
      description: 'Contains the flowchart configuration for a Procedure or TemplateCollection.
        A ProcedureFlowchart

        acts as a container for flowchart versions (see `ProcedureFlowchartVersion`),
        tracking both the

        latest working version (`latestFlowchartVersion`) and the published version

        (`publishedFlowchartVersion`) that is used when creating procedure runs. The
        parent relationship

        (see `parent`) connects this flowchart to either a `Procedure` or `TemplateCollection`.


        Note that this model will be deprecated soon, in favor of `WorkflowFlowchartConfig`.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        id:
          type: string
        latestFlowchartVersion:
          oneOf:
          - $ref: '#/components/schemas/ProcedureFlowchartVersionRef'
          - type: 'null'
        modifiedAt:
          format: datetime
          type: string
        parent:
          $ref: '#/components/schemas/ProcedureFlowchartParentRef'
        publishedFlowchartVersion:
          oneOf:
          - $ref: '#/components/schemas/ProcedureFlowchartVersionRef'
          - type: 'null'
      type: object
    ProcedureFlowchartConfigVersionProxy:
      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 `latestProcedureFlowchartConfigVersionProxy` and

        `publishedProcedureFlowchartConfigVersionProxy`), `ProcedureRun`, and `ProcedureRunPlan`
        (not yet in alpha) to

        provide a read-only view of the flowchart structure for execution and planning
        purposes.'
      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
    ProcedureFlowchartConfigVersionProxyPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureFlowchartConfigVersionProxy'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureFlowchartConfigVersionProxyRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureFlowchartPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureFlowchart'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureFlowchartParentRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureFlowchartRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureFlowchartVersion:
      description: 'An immutable snapshot of a procedure''s flowchart structure at
        a specific point in time. Each

        version contains the complete graph of method steps (see `nodes` and

        `ProcedureMethodDefinitionVersion`) and their connections (see `edges` and
        `ProcedureEdge`).

        New versions are created when a procedure''s flowchart is modified, preserving
        the history of

        changes. The `ProcedureFlowchart` parent tracks which version is latest and
        which is published

        for execution.


        Note that this model will be deprecated soon, in favor of `WorkflowFlowchartConfig`.'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        edges:
          items:
            $ref: '#/components/schemas/ProcedureEdge'
          type: array
        id:
          type: string
        nodes:
          format: uri
          type: string
        procedureFlowchart:
          $ref: '#/components/schemas/ProcedureFlowchartRef'
      type: object
    ProcedureFlowchartVersionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureFlowchartVersion'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureFlowchartVersionRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      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
    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
    ProcedureMethodDefinitionVersion:
      description: 'A versioned method within a procedure flowchart. Methods are the
        building blocks of

        procedures, representing discrete experimental operations that scientists
        perform. Each

        method contains step groups (see `stepGroups` and `ProcedureStepGroup`) organized
        by

        execution phase, along with parameter settings for data collection (`dataParameterSettings`),

        material inputs (`materialInputSettings`), material outputs (`materialOutputSettings`),
        and

        equipment (`equipmentSettings`). Methods appear as nodes in the procedure
        flowchart (see

        `ProcedureFlowchartVersion`) and are connected by edges that define execution

        order and material flow.'
      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
    ProcedureMethodDefinitionVersionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureMethodDefinitionVersion'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureMethodDefinitionVersionRef:
      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
    ProcedureMethodExecutionInstance:
      description: 'An instance of a method being executed within a procedure run.
        When a scientist runs a

        procedure, each method in the flowchart becomes a ProcedureMethodExecutionInstance
        that tracks

        the actual execution: the worksheet where data is entered (`worksheet`), the
        associated task

        (`methodTask`), step groups with execution instances (`stepGroups`), and all
        parameter values

        (planned, confirmed, and measured). Links to its `ProcedureRun`, the template
        method it''s based

        on (`templateMethodVersion`), and the specific condition/replicate it belongs
        to

        (`procedureRunConditionReplicate`). Material flow between methods is tracked
        via

        `sourceProcedureMethodExecutionInstanceAssociations` and

        `targetProcedureMethodExecutionInstanceAssociations`.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        dataParameterActualValues:
          format: uri
          type: string
        dataParameterConfirmationValues:
          format: uri
          type: string
        dataParameterPlannedValues:
          description: Source of truth for this specific PMEI's planned data parameter
            values, with any condition overrides.
          format: uri
          type: string
        equipmentConfirmationValues:
          format: uri
          type: string
        equipmentPlannedValues:
          description: Source of truth for this specific PMEI's planned equipment
            values, with any condition overrides.
          format: uri
          type: string
        id:
          type: string
        materialInputConfirmationValues:
          format: uri
          type: string
        materialInputPlannedValues:
          description: 'Source of truth for this specific PMEI''s planned material
            input values, with any condition overrides.


            Note: This will not include any process intermediate values when previous
            methods have not yet been

            completed.'
          format: uri
          type: string
        materialOutputConfirmationValues:
          format: uri
          type: string
        modifiedAt:
          format: datetime
          type: string
        procedureRun:
          $ref: '#/components/schemas/ProcedureRunRef'
        procedureRunConditionReplicate:
          $ref: '#/components/schemas/ProcedureRunConditionReplicateRef'
        stepGroups:
          items:
            $ref: '#/components/schemas/ProcedureExecutionStepGroup'
          type: array
        taskTransitionExtensions:
          items:
            $ref: '#/components/schemas/TaskTransitionExtension'
          type: array
        templateMethodVersion:
          $ref: '#/components/schemas/ProcedureMethodDefinitionVersionRef'
          description: 'The "template" method version represents the PMDV on the procedure
            template that this PMEI is based on.


            In most cases this is equivalent to the planMethodVersion. They only differ
            on older legacy

            ProcedureRuns, where "plan" PMDVs belong to a legacy "plan" ProcedureFlowchart
            model and we compiled a

            dedicated ProcedureFlowchart for this run (with its own PMDVs) based on
            the template''s legacy ProcedureFlowchart.


            Do not directly use the parameter planned values from this PMDV. dataParameterPlannedValues,
            materialInputPlannedValues,

            and equipmentPlannedValues on the PMEI itself are the source of truth
            instead, since they account for

            experiment planning condition overrides that are not reflected on the
            PMDV.


            Do not use the confirmation methods from the parameter versions in this
            PMDV. parameterConfirmationMethods

            on the PMEI itself is the source of truth instead, since it accounts for
            experiment planning condition

            overrides that are not reflected on the PMDV.'
      type: object
    ProcedureMethodExecutionInstanceAssociation:
      description: 'Links two method execution instances across procedure runs to
        represent an intended connection within a study.

        This allows scientists to coordinate their analyses across runs, even when
        the flowchart structure may differ.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        sourceProcedureMethodExecutionInstance:
          $ref: '#/components/schemas/ProcedureMethodExecutionInstanceRef'
        targetProcedureMethodExecutionInstance:
          $ref: '#/components/schemas/ProcedureMethodExecutionInstanceRef'
      type: object
    ProcedureMethodExecutionInstanceAssociationPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureMethodExecutionInstanceAssociation'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureMethodExecutionInstanceAssociationUpsert:
      additionalProperties: false
      properties:
        sourceProcedureMethodExecutionInstanceId:
          type: string
        targetProcedureMethodExecutionInstanceId:
          type: string
      required:
      - sourceProcedureMethodExecutionInstanceId
      - targetProcedureMethodExecutionInstanceId
      type: object
    ProcedureMethodExecutionInstancePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureMethodExecutionInstance'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureMethodExecutionInstanceRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureMethodExecutionInstanceUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureMethodExecutionInstance'
          type: array
      type: object
    ProcedurePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Procedure'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureParameter:
      description: 'Represents a parameter entity within a procedure template. Parameters
        define the data,

        materials, or equipment that scientists interact with during procedure execution.

        The `parameterType` field classifies the parameter as one of: data parameter,
        material

        input, material output, or equipment (see `ProcedureParameterType`). Each
        parameter has

        versioned definitions (`ProcedureParameterVersion`) that specify the name,
        data type,

        and validation rules. During execution, parameter values (`ProcedureParameterPlannedValue`,

        `ProcedureParameterConfirmationValue`, `ProcedureParameterMeasuredValue`)
        are recorded

        against the specific parameter version.'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        parameterType:
          enum:
          - DATA_PARAMETER
          - MATERIAL_INPUT
          - MATERIAL_OUTPUT
          - EQUIPMENT
          type: string
      type: object
    ProcedureParameterConfirmationValue:
      description: 'Records a scientist''s confirmation of a parameter value during
        procedure execution. When running

        a procedure, scientists confirm that inputs (such as materials, equipment,
        or data) match

        expectations before proceeding. This type captures that confirmation along
        with an optional

        comment and timestamp (`recordedAt`). Distinct from `ProcedureParameterPlannedValue`
        (the

        expected value set during procedure setup) and `ProcedureParameterMeasuredValue`
        (the actual

        result recorded after execution). For material input parameters, `amount`
        and `container`

        fields specify the confirmed quantities and storage locations. Links to the
        specific

        `ProcedureMethodExecutionInstance` where the confirmation occurred and the

        `ProcedureParameterVersion` defining the parameter being confirmed.'
      properties:
        __typename:
          type: string
        amount:
          type:
          - 'null'
          - object
        comment:
          type: string
        container:
          type:
          - 'null'
          - object
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        id:
          type: string
        methodExecutionInstance:
          $ref: '#/components/schemas/ProcedureMethodExecutionInstanceRef'
        modifiedAt:
          format: datetime
          type: string
        parameterVersion:
          $ref: '#/components/schemas/ProcedureParameterVersionRef'
        plateWellAssociations:
          items:
            $ref: '#/components/schemas/ProcedureParameterValueLinkedPlateWell'
          type: array
        recordedAt:
          format: datetime
          type:
          - 'null'
          - string
        value:
          type: object
      type: object
    ProcedureParameterConfirmationValuePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureParameterConfirmationValue'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureParameterConfirmationValueUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureParameterConfirmationValue'
          type: array
      type: object
    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
    ProcedureParameterMeasuredValue:
      description: 'Records the actual measured or observed value for a parameter
        during procedure execution.

        Scientists enter measured values after performing an experimental step—for
        example,

        recording a temperature reading, an absorbance measurement, or an observed
        result.

        Distinct from `ProcedureParameterPlannedValue` (expected values set during
        setup) and

        `ProcedureParameterConfirmationValue` (verification that inputs match expectations).

        Includes an optional `comment` and `recordedAt` timestamp. Links to the specific

        `ProcedureMethodExecutionInstance` and `ProcedureParameterVersion` for context.'
      properties:
        __typename:
          type: string
        amount:
          type:
          - 'null'
          - object
        comment:
          type: string
        container:
          type:
          - 'null'
          - object
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        id:
          type: string
        methodExecutionInstance:
          $ref: '#/components/schemas/ProcedureMethodExecutionInstanceRef'
        modifiedAt:
          format: datetime
          type: string
        parameterVersion:
          $ref: '#/components/schemas/ProcedureParameterVersionRef'
        recordedAt:
          format: datetime
          type:
          - 'null'
          - string
        value:
          type: object
      type: object
    ProcedureParameterMeasuredValuePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureParameterMeasuredValue'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureParameterMeasuredValueUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureParameterMeasuredValue'
          type: array
      type: object
    ProcedureParameterPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureParameter'
          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
    ProcedureParameterPlannedValuePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureParameterPlannedValue'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureParameterPlannedValueRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureParameterPlannedValueUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureParameterPlannedValue'
          type: array
      type: object
    ProcedureParameterRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      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
    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
    ProcedureParameterVersionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureParameterVersion'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureParameterVersionRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureRun:
      description: 'An active execution of a procedure template. Created when scientists
        start running an experiment

        based on a `Procedure`. Contains experimental conditions (`conditions` via
        `ProcedureRunCondition`)

        and their replicates, which in turn contain method execution instances (`methodExecutionInstances`

        via `ProcedureMethodExecutionInstance`) where actual data are recorded. Links
        to its template via

        `templateProcedureFlowchartVersion` or `procedureFlowchartConfigVersionProxy`
        and belongs to a `Study`. The

        `defaultDataEntryMode` (see `ProcedureRunDataEntryMode`) determines whether
        each condition-replicate has its

        own worksheet or all share one. Workflow orchestration is managed through
        `workflowRootTaskGroup`.

        Also known as an "experiment" in the Benchling UI.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        conditions:
          description: An ordered list of the conditions that are part of this ProcedureRun.
          format: uri
          type: string
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        description:
          type: string
        id:
          type: string
        methodExecutionInstances:
          format: uri
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        procedureFlowchartConfigVersionProxy:
          description: 'A simplified view of the flowchart config for this run. This
            is the preferred

            way to access the flowchart config.'
          oneOf:
          - $ref: '#/components/schemas/ProcedureFlowchartConfigVersionProxyRef'
          - type: 'null'
        procedureType:
          enum:
          - RECIPE
          - ASSAY
          type: string
        templateProcedureFlowchartVersion:
          $ref: '#/components/schemas/ProcedureFlowchartVersionRef'
      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"
      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
      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.

        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
    ProcedureRunConditionReplicatePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureRunConditionReplicate'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureRunConditionReplicateRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureRunConditionReplicateUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureRunConditionReplicate'
          type: array
      type: object
    ProcedureRunConditionUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureRunCondition'
          type: array
      type: object
    ProcedureRunPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureRun'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureRunPlan:
      description: 'A draft experiment plan that can be promoted to a `ProcedureRun`
        for execution. Scientists use

        run plans to configure experimental conditions, parameter values, and replicates
        before

        starting an actual experiment. Belongs to a `Study` and references a procedure
        template via

        either `templateProcedureFlowchartVersion` (for legacy flowcharts) or

        `procedureFlowchartConfigVersionProxy` (for new-style workflow flowcharts).
        Contains

        `ProcedureRunPlanCondition` objects that define the different experimental
        configurations to

        test. The `dataEntryMode` (see `ProcedureRunDataEntryMode`) specifies whether
        each

        condition-replicate will have its own data entry worksheet or share a single
        worksheet. The

        `confirmationMethodByParamVersionId` allows overriding default confirmation
        methods for

        specific parameters. Upon promotion, the run plan becomes a `ProcedureRun`
        with corresponding

        `ProcedureRunCondition` and `ProcedureRunConditionReplicate` objects. Also
        known as a "draft

        experiment" in the Benchling UI.'
      properties:
        __typename:
          type: string
        confirmationMethodByParamVersionId:
          items:
            $ref: '#/components/schemas/ConfirmationMethodByParamVersionId'
          type: array
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        dataEntryMode:
          enum:
          - INDIVIDUAL_CONDITION_REPLICATES
          - ALL_CONDITION_REPLICATES_TOGETHER
          type: string
        description:
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        procedureFlowchartConfigVersionProxy:
          oneOf:
          - $ref: '#/components/schemas/ProcedureFlowchartConfigVersionProxyRef'
          - type: 'null'
        procedureRun:
          oneOf:
          - $ref: '#/components/schemas/ProcedureRunRef'
          - type: 'null'
        procedureRunPlanConditions:
          format: uri
          type: string
        study:
          $ref: '#/components/schemas/StudyRef'
        templateProcedureFlowchartVersion:
          deprecated: true
          description: Use procedureFlowchartConfigVersionProxy instead.
          oneOf:
          - $ref: '#/components/schemas/ProcedureFlowchartVersionRef'
          - type: 'null'
      type: object
    ProcedureRunPlanCondition:
      description: 'A planned experimental condition within a `ProcedureRunPlan`,
        representing how a procedure''s

        methods will be configured when the plan is promoted to an actual `ProcedureRun`.
        Each

        condition contains pre-filled parameter values (via `MethodParametersPlan`)
        for the procedure''s

        unit operations, and specifies how many replicates will be run (via

        `ProcedureRunPlanConditionReplicate`). Scientists use conditions to plan different
        experimental

        configurations before execution—for example, testing multiple temperatures
        or reagent

        concentrations. The `position` field determines display order within the parent
        run plan. Upon

        promotion, each ProcedureRunPlanCondition becomes a `ProcedureRunCondition`
        in the resulting

        experiment. Also known as an "experiment condition" in the Benchling UI''s
        experiment planning

        workflow.'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type: string
        description:
          description: The user-defined description of the condition.
          type: string
        id:
          type: string
        methodParametersPlan:
          description: 'Method plan containing parameter values for this condition''s
            unit operation. If this value is null upon

            promotion to a procedure run, default values from the procedure will be
            used.'
          oneOf:
          - $ref: '#/components/schemas/MethodParametersPlan'
          - type: 'null'
        modifiedAt:
          format: datetime
          type: string
        name:
          description: The user-defined name of the condition.
          type: string
        position:
          description: The display order of the condition within the run.
          type: integer
        procedureRunPlan:
          $ref: '#/components/schemas/ProcedureRunPlanRef'
          description: The ProcedureRunPlan that this condition is a part of.
        replicates:
          description: Replicate information for this condition.
          items:
            $ref: '#/components/schemas/ProcedureRunPlanConditionReplicate'
          type: array
        templateMethodVersion:
          $ref: '#/components/schemas/ProcedureMethodDefinitionVersionRef'
          description: The procedure method definition version (PMDV) this condition
            belongs to.
      type: object
    ProcedureRunPlanConditionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureRunPlanCondition'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureRunPlanConditionReplicate:
      description: 'Represents a planned replicate within a `ProcedureRunPlanCondition`.
        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
        (e.g.,

        replicate 1, 2, 3). The `sourcePmeiIds` field supports unit operation linking
        by storing source

        `ProcedureMethodExecutionInstance` IDs from other procedure runs. Upon promotion
        of the parent

        `ProcedureRunPlan`, each ProcedureRunPlanConditionReplicate becomes a `ProcedureRunConditionReplicate`
        in the

        resulting procedure run.'
      properties:
        __typename:
          type: string
        replicateNumber:
          description: The replicate number.
          type: integer
        sourcePmeiIds:
          description: 'Source PMEI IDs for this replicate.

            Support unit operation linking to future-pmeis when executing the draft
            procedure run.'
          items:
            type: string
          type: array
      type: object
    ProcedureRunPlanConditionReplicateInput:
      additionalProperties: false
      properties:
        replicateNumber:
          description: The 1-indexed replicate number. Must be >= 1. Replicate numbers
            must be consecutive starting from 1 (e.g., 1, 2, 3).
          type: integer
        sourcePmeiIds:
          description: 'IDs of source procedure method execution instances (PMEIs)
            for unit operation linking. Format: `pcmei_XXXXXXXX`. Used to connect
            this replicate''s inputs to outputs from a previous run.'
          items:
            type: string
          type: array
      required:
      - replicateNumber
      type: object
    ProcedureRunPlanConditionUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureRunPlanCondition'
          type: array
      type: object
    ProcedureRunPlanPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureRunPlan'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureRunPlanRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureRunRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureStepDefinitionVersion:
      description: 'A versioned definition of a procedure step within a procedure
        flowchart. Steps represent

        documentation or instructions that guide scientists through a procedure but
        do not collect

        data—they differ from methods (`ProcedureMethodDefinitionVersion`) which have
        parameters for

        data entry. The `documentVersion` field links to a `DocumentVersion` containing
        the step''s

        text content, which may include formatted instructions, images, or other rich
        content. Steps

        are immutable; updating a step creates a new version. Belongs to a procedure
        flowchart via

        `procedureFlowchartId`. Also known as a "text step" or "instruction step"
        in the Benchling UI.'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type: string
        id:
          type: string
        name:
          type: string
      type: object
    ProcedureStepDefinitionVersionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureStepDefinitionVersion'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureStepDefinitionVersionRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProcedureStepExecutionInstance:
      description: 'An execution instance of a procedure step within a `ProcedureMethodExecutionInstance`.
        Created

        when a procedure run is started, representing a step where scientists can
        document their work.

        The `document` field links to a `Document` (entry) where scientists write
        notes, observations,

        and results during execution. References both `planStepVersion` (from the
        run plan flowchart)

        and `templateStepVersion` (from the original procedure template) to track
        provenance—these are

        null for ad-hoc steps added during execution or auto-generated confirmation
        steps. The

        `stepTask` provides workflow orchestration via `WorkflowTask`. Can be archived
        along with its

        parent method execution instance through the `ArchivableWithLineage` lineage.
        Also known as a

        "step entry" or "execution step" in the Benchling UI.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        id:
          type: string
        methodExecutionInstance:
          $ref: '#/components/schemas/ProcedureMethodExecutionInstanceRef'
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        templateStepVersion:
          oneOf:
          - $ref: '#/components/schemas/ProcedureStepDefinitionVersionRef'
          - type: 'null'
      type: object
    ProcedureStepExecutionInstancePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProcedureStepExecutionInstance'
          type: array
        nextToken:
          type: string
      type: object
    ProcedureStepExecutionInstanceRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      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
    ProductComponent:
      description: Reaction component sub-type for products
      properties:
        __typename:
          type: string
        amountActual:
          format: decimal
          type:
          - 'null'
          - string
        amountPlan:
          format: decimal
          type:
          - 'null'
          - string
        amountUnit:
          oneOf:
          - $ref: '#/components/schemas/UnitRef'
          - type: 'null'
        amountYield:
          format: decimal
          type:
          - 'null'
          - string
        calculationBase:
          enum:
          - MOL_EQUIVALENT
          - MOL_PLAN
          - AMOUNT_PLAN
          type: string
        concentration:
          format: decimal
          type:
          - 'null'
          - string
        concentrationUnit:
          oneOf:
          - $ref: '#/components/schemas/UnitRef'
          - type: 'null'
        linkedLot:
          oneOf:
          - $ref: '#/components/schemas/CustomEntityRef'
          - type: 'null'
        linkedMolecule:
          description: Union of InternalLinkedMolecule, ExternalLinkedMolecule
          oneOf:
          - anyOf:
            - $ref: '#/components/schemas/InternalLinkedMolecule'
            - $ref: '#/components/schemas/ExternalLinkedMolecule'
            discriminator:
              propertyName: __typename
          - type: 'null'
        molActual:
          format: decimal
          type:
          - 'null'
          - string
        molEquivalent:
          format: decimal
          type:
          - 'null'
          - string
        molPlan:
          format: decimal
          type:
          - 'null'
          - string
        molUnit:
          oneOf:
          - $ref: '#/components/schemas/UnitRef'
          - type: 'null'
        purity:
          format: decimal
          type:
          - 'null'
          - string
        role:
          enum:
          - REACTANT
          - PRODUCT
          - REAGENT
          - BYPRODUCT
          - SOLVENT
          - CATALYST
          type: string
      type: object
    Project:
      description: 'A top-level organizational container in Benchling that groups
        related work and controls

        access permissions. Projects contain Folders (see `Folder`) which in turn
        hold entities,

        notebook entries, and other items. Each project has an owner (see `Owner`—typically
        a

        User or Organization) and access is managed through collaborations (see `Collaboration`).

        Projects serve as the primary unit for sharing and permission management:
        users who are

        not collaborators on a project cannot access its contents. The isDataModsEnabled
        flag

        controls whether data modification tracking is active for items in this project.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        collaborations:
          description: List of access control information for this object.
          oneOf:
          - format: uri
            type: string
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          type:
          - 'null'
          - string
        hideParentFolderNamesForSharedItems:
          type: boolean
        id:
          type: string
        isDataModsEnabled:
          type:
          - 'null'
          - boolean
        lockSequences:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type:
          - 'null'
          - string
        owner:
          oneOf:
          - $ref: '#/components/schemas/OwnerRef'
          - type: 'null'
        public:
          type: boolean
        reviewProcesses:
          description: Review processes (a.k.a. review lifecycles) configured for
            this project.
          format: uri
          type: string
      type: object
    ProjectCreatedWebhookEnvelopeV3:
      allOf:
      - $ref: '#/components/schemas/WebhookEnvelopeBaseV0'
      - properties:
          message:
            $ref: '#/components/schemas/ProjectCreatedWebhookV3'
        required:
        - message
        type: object
      description: Request body Benchling sends for a `v3.project.created` event.
    ProjectCreatedWebhookV3:
      allOf:
      - $ref: '#/components/schemas/V3EventBase'
      - properties:
          type:
            description: The event type.
            enum:
            - v3.project.created
            type: string
        required:
        - type
        type: object
      description: Message body of a `v3.project.created` event.
    ProjectPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Project'
          type: array
        nextToken:
          type: string
      type: object
    ProjectRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProjectUpdatedWebhookEnvelopeV3:
      allOf:
      - $ref: '#/components/schemas/WebhookEnvelopeBaseV0'
      - properties:
          message:
            $ref: '#/components/schemas/ProjectUpdatedWebhookV3'
        required:
        - message
        type: object
      description: Request body Benchling sends for a `v3.project.updated` event.
    ProjectUpdatedWebhookV3:
      allOf:
      - $ref: '#/components/schemas/V3UpdateEventBase'
      - properties:
          type:
            description: The event type.
            enum:
            - v3.project.updated
            type: string
        required:
        - type
        type: object
      description: Message body of a `v3.project.updated` event.
    PromoteProcedureRunPlanInput:
      additionalProperties: false
      example:
        procedureRunPlanIds:
        - prp_Xk9mLpQr
        - prp_Yw3tRsLm
      properties:
        procedureRunPlanIds:
          description: 'IDs of the run plans to promote. Format: `prp_XXXXXXXX`.'
          items:
            type: string
          type: array
      required:
      - procedureRunPlanIds
      type: object
    PromoteProcedureRunPlanOutput:
      description: Output returned when promoting procedure run plans to active procedure
        runs.
      properties:
        creates:
          items:
            $ref: '#/components/schemas/PromotedProcedureRunItem'
          type: array
      type: object
    PromotedProcedureRunItem:
      description: A single procedure run created by promoting a procedure run plan.
      properties:
        __typename:
          type: string
        folderId:
          type: string
        id:
          type: string
      type: object
    Protein:
      allOf:
      - $ref: '#/components/schemas/IProtein'
      - description: 'A Protein is a complex biomolecule entity in Benchling representing
          immunoglobulins or

          related therapeutic proteins like T-cell receptors. Proteins are defined
          by an

          `ProteinFormat` that specifies their structural organization, with actual
          sequences

          provided in domains (see `ProteinDomain`) and chains (see `ProteinChain`).
          Proteins support versioning

          through history/fullHistory, allowing tracking of structural changes over
          time. As registry entities,

          proteins can have schemas with custom fields, belong to projects and folders,
          and be linked to studies.'
        properties:
          __typename:
            type: string
          authors:
            oneOf:
            - format: uri
              type: string
            - type: 'null'
          creator:
            $ref: '#/components/schemas/PrincipalRef'
          schemaFields:
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    ProteinChain:
      description: 'Represents a polypeptide chain within an `Protein`, containing
        the domain composition. Each chain has a

        computed label derived from the format.'
      properties:
        __typename:
          type: string
        chainPositions:
          description: 'Each chain position of this chain in the protein. If a chain
            has multiplicity > 1, each chain position

            will be listed here.'
          items:
            $ref: '#/components/schemas/ProteinFormatChainPosition'
          type: array
        domains:
          description: Each domain on the chain, ordered according to the format.
          items:
            $ref: '#/components/schemas/ProteinDomain'
          type: array
        entity:
          $ref: '#/components/schemas/AaSequenceRef'
          description: The amino acid sequence entity associated with the chain.
        label:
          description: Unique label for the chain, computed from the format.
          type: string
        type:
          description: The type of the chain.
          enum:
          - HEAVY
          - LIGHT
          - NONE
          - ALPHA
          - BETA
          - JOINING
          type: string
      type: object
    ProteinChainInput:
      additionalProperties: false
      properties:
        aaSequenceId:
          description: The ID of the AA sequence to use for the chain.
          type: string
        label:
          description: The label of the chain, uniquely identifying the chain within
            the format.
          type: string
      required:
      - label
      - aaSequenceId
      type: object
    ProteinChainNameTemplatePartConfiguration:
      description: Configuration for a protein chain name template part.
      properties:
        __typename:
          type: string
        proteinChain:
          $ref: '#/components/schemas/ProteinFormatChain'
      type: object
    ProteinChainNameTemplatePartConfigurationInput:
      additionalProperties: false
      properties:
        label:
          type: string
      required:
      - label
      type: object
    ProteinDomain:
      description: 'Represents a domain within an `Protein`, containing the actual
        amino acid sequence for a specific label.

        Unlike `ProteinFormatDomain` which is a template, `ProteinDomain` is a concrete
        instance of the domain and

        links to the underlying amino acid sequence entity.'
      properties:
        __typename:
          type: string
        domainPositions:
          description: 'Each domain position of this domain in the protein. If this
            domain appears multiple times in the physical

            structure of the protein, each domain position will be listed here.'
          items:
            $ref: '#/components/schemas/ProteinFormatDomainPosition'
          type: array
        entity:
          $ref: '#/components/schemas/AaSequenceRef'
          description: The amino acid sequence entity associated with the domain.
        label:
          description: A human-readable label for the domain.
          type: string
        type:
          description: The type of the domain.
          enum:
          - VL
          - CL
          - VH
          - VHH
          - CH1
          - CH2
          - CH3
          - CH4
          - J
          - H
          - L
          - VA
          - CA
          - VB
          - CB
          - VG
          - CG
          - VD
          - CD
          - F
          - ELEMENT
          type: string
      type: object
    ProteinDomainInput:
      additionalProperties: false
      properties:
        aaSequenceId:
          description: The ID of the AA sequence to use for the domain.
          type: string
        label:
          description: The label of the domain, uniquely identifying the domain within
            the format.
          type: string
      required:
      - label
      - aaSequenceId
      type: object
    ProteinDomainNameTemplatePartConfiguration:
      description: Configuration for a protein domain name template part.
      properties:
        __typename:
          type: string
        proteinDomain:
          $ref: '#/components/schemas/ProteinFormatDomain'
      type: object
    ProteinDomainNameTemplatePartConfigurationInput:
      additionalProperties: false
      properties:
        label:
          type: string
      required:
      - label
      type: object
    ProteinFormat:
      description: 'A ProteinFormat defines the structural template for a class of
        proteins, specifying the

        arrangement of chains and domains. Formats can be built-in (e.g., IgG1, Fab,
        scFv) or

        custom-defined by users.'
      properties:
        __typename:
          type: string
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        builtIn:
          description: 'Whether this is an out-of-the-box Benchling-provided format.
            These formats come pre-loaded and cannot be

            modified or deleted by users.'
          type: boolean
        chainPositions:
          description: Format chains positions include all physical instances of each
            chain in a protein of this format.
          items:
            $ref: '#/components/schemas/ProteinFormatChainPosition'
          type: array
        chains:
          description: 'The chains of protein entities of this format. Each chain
            can have multiple chain sites, representing

            multiple physical instances of the same chain.'
          items:
            $ref: '#/components/schemas/ProteinFormatChain'
          type: array
        domainPositions:
          description: 'Format domain positions include all physical instances of
            each domain in a protein of this

            format.'
          items:
            $ref: '#/components/schemas/ProteinFormatDomainPosition'
          type: array
        domains:
          description: 'The domains of protein entities of this format. Each domain
            can have multiple domain sites, representing

            multiple physical instances of the same domain.'
          items:
            $ref: '#/components/schemas/ProteinFormatDomain'
          type: array
        id:
          type: string
        name:
          description: The display name of the protein format.
          type: string
        originalVeritas:
          description: The VERITAS string used to create the format.
          type:
          - 'null'
          - string
      type: object
    ProteinFormatChain:
      description: 'A chain in a protein format, representing the slot where a polypeptide
        chain can be used in an entity of

        this format. Chains are uniquely identified by their label in the format.

        Chains can have multiplicity, meaning there are multiple physical instances
        of the same chain in a protein of

        this format.'
      properties:
        __typename:
          type: string
        chainPositions:
          description: A list of all the chain positions of this chain in the format.
          items:
            $ref: '#/components/schemas/ProteinFormatChainPosition'
          type: array
        domains:
          description: The domains that compose this chain.
          items:
            $ref: '#/components/schemas/ProteinFormatDomain'
          type: array
        label:
          description: 'A human-readable label for the chain, such as ''Heavy'' or
            ''Light 1''.

            Chains are labeled with an index only when multiple distinct chains of
            the same type exist.

            These labels are unique among distinct chains in a format.'
          type: string
        type:
          description: The type of the chain.
          enum:
          - HEAVY
          - LIGHT
          - NONE
          - ALPHA
          - BETA
          - JOINING
          type: string
      type: object
    ProteinFormatChainPosition:
      description: 'Defines each instance of a polypeptide chain within a `ProteinFormat`,
        specifying the chain type and

        its constituent domains. Each chain position has a unique ref identifier and
        lists the domain positions

        (see `ProteinFormatDomainPosition`) that compose it in order from N-terminus
        to C-terminus.

        For example, a heavy chain position might reference domain positions [VH,
        CH1, Hinge, CH2, CH3].'
      properties:
        __typename:
          type: string
        domainPositions:
          description: A list of all the domain positions that make up the chain position,
            in order
          items:
            $ref: '#/components/schemas/ProteinFormatDomainPosition'
          type: array
        ref:
          description: 'A unique identifier for a physical component (chain or domain)
            in a protein format.

            This is used to form a HELM reference that is used in the protein''s complex
            polymer structure.'
          type: integer
        type:
          description: Type of the chain.
          enum:
          - HEAVY
          - LIGHT
          - NONE
          - ALPHA
          - BETA
          - JOINING
          type: string
      type: object
    ProteinFormatDomain:
      description: 'A domain in a protein format, representing the slot where an amino
        acid sequence can be used in an entity

        of this format. Domains are uniquely identified by their label in the format.'
      properties:
        __typename:
          type: string
        domainPositions:
          description: A list of all the domain positions of this domain in the format.
          items:
            $ref: '#/components/schemas/ProteinFormatDomainPosition'
          type: array
        label:
          description: A human-readable label for the domain, uniquely identifying
            the domain within the format.
          type: string
        optional:
          description: Whether this domain is optional in the format. If true, entities
            of this format may not have this domain.
          type: boolean
        type:
          description: The type of the domain (e.g., VH, VL, CH1).
          enum:
          - VL
          - CL
          - VH
          - VHH
          - CH1
          - CH2
          - CH3
          - CH4
          - J
          - H
          - L
          - VA
          - CA
          - VB
          - CB
          - VG
          - CG
          - VD
          - CD
          - F
          - ELEMENT
          type: string
      type: object
    ProteinFormatDomainPosition:
      description: 'Defines a domain position within a1 `ProteinFormat`, specifying
        the domain type and identity of each

        physical domain in the protein format. Each domain position has a unique ref
        identifier used

        to construct HELM notation for complex polymer structures. Domain positions
        are grouped into ProteinFormatDomains,

        and each group can be uniquely identified by its label, and will be a single
        amino acid sequence entity in proteins

        of this format.'
      properties:
        __typename:
          type: string
        optional:
          description: Whether this domain is optional in the format. If true, entities
            of this format may not have this domain.
          type: boolean
        ref:
          description: 'A unique identifier for a physical component (chain or domain)
            in a protein format.

            This is used to form a HELM reference that is used in the protein''s complex
            polymer structure.'
          type: integer
        type:
          description: Type of the domain
          enum:
          - VL
          - CL
          - VH
          - VHH
          - CH1
          - CH2
          - CH3
          - CH4
          - J
          - H
          - L
          - VA
          - CA
          - VB
          - CB
          - VG
          - CG
          - VD
          - CD
          - F
          - ELEMENT
          type: string
      type: object
    ProteinFormatPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProteinFormat'
          type: array
        nextToken:
          type: string
      type: object
    ProteinFormatRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProteinPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Protein'
          type: array
        nextToken:
          type: string
      type: object
    ProteinRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ProteinSchema:
      description: Defines the structure, field definitions, and configuration options
        for Proteins.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        chainLinkedSchemas:
          description: Schema or interface links for each chain label in the protein
            format.
          items:
            $ref: '#/components/schemas/ChainLinkedSchema'
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/Constraint'
          - type: 'null'
        containableType:
          enum:
          - NONE
          - ENTITY
          - BATCH
          type: string
        containerNameTemplate:
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplate'
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          type: string
        domainLinkedSchemas:
          description: Schema or interface links for each domain type in the protein
            format.
          items:
            $ref: '#/components/schemas/DomainLinkedSchema'
          type: array
        fieldDefinitions:
          format: uri
          type: string
        fieldsets:
          format: uri
          type: string
        format:
          $ref: '#/components/schemas/ProteinFormatRef'
          description: The protein format that defines the structure (domains, chains,
            interactions) for entities of this schema.
        iconId:
          enum:
          - ANTIBODY
          - BASIC_FOLDER_ITEM
          type: string
        id:
          type: string
        includeRegistryIdInChips:
          type: boolean
        itemIdPrefix:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        nameTemplate:
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplate'
          - type: 'null'
        organization:
          $ref: '#/components/schemas/OrganizationRef'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfiguration'
          type: array
        systemName:
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    ProteinSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProteinSchema'
          type: array
        nextToken:
          type: string
      type: object
    ProteinVersion:
      description: 'A historical snapshot of an `Protein` at a specific point in time,
        preserving the complete

        structural state including domains, chains, and HELM notation. Protein versions
        form a

        lineage that tracks changes over time. Each version records its creator and
        creation time.

        The parent field links to the version this one was derived from. Versions
        may become out of

        sync with their constituent entities if underlying sequences change.'
      properties:
        __typename:
          type: string
        chains:
          description: The chains and associated amino acid sequences on the protein.
          items:
            $ref: '#/components/schemas/ProteinChain'
          type: array
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        domains:
          description: The domains and associated amino acid sequences on the protein.
          items:
            $ref: '#/components/schemas/ProteinDomain'
          type: array
        format:
          $ref: '#/components/schemas/ProteinFormatRef'
          description: The protein format that defines the structure (domains, chains,
            interactions) for the protein.
        id:
          type: string
        name:
          type: string
        outOfSync:
          description: Indicates if constituent domain or chain entities have changed
            since the protein was last updated.
          type: boolean
        outOfSyncReason:
          description: Any additional information about why the protein is out of
            sync.
          type:
          - 'null'
          - string
        parent:
          description: The parent version of the protein.
          oneOf:
          - $ref: '#/components/schemas/ProteinVersionRef'
          - type: 'null'
        protein:
          $ref: '#/components/schemas/ProteinRef'
          description: The protein that owns this version.
      type: object
    ProteinVersionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProteinVersion'
          type: array
        nextToken:
          type: string
      type: object
    ProteinVersionRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    PublicDataChatSourceInput:
      additionalProperties: false
      properties:
        type:
          enum:
          - public_data
          type: string
      required:
      - type
      type: object
    PutScratchPlateInInventoryInput:
      additionalProperties: false
      properties:
        barcode:
          $ref: '#/components/schemas/BarcodeInput'
          description: Barcode to assign to the new inventory plate. Use USE_NAME
            to set the barcode to the plate name, or SPECIFY_BARCODE to provide an
            explicit value.
        columnMappings:
          description: Maps columns from scratch plate layers onto container-schema
            fields. Each mapping is applied per well so values land on the matching
            well of the new plate.
          items:
            $ref: '#/components/schemas/ColumnMapping'
          type: array
        name:
          description: Name for the new inventory plate. Defaults to the scratch plate's
            name.
          type: string
        parentStorableId:
          description: API ID of the storage location (box, freezer, etc.) to place
            the new plate into.
          type: string
        plateSchemaId:
          description: ID of the plate schema to use for the new inventory plate.
            If omitted, resolved from the scratch plate's own plateSchemaId; the call
            fails if neither is set.
          type: string
        scratchPlateId:
          description: ID of the scratch plate to convert.
          type: string
        sourceId:
          description: API ID of the source entity (e.g. a project) to associate with
            the new plate.
          type: string
        studyIds:
          description: IDs of studies to associate with the new inventory plate.
          items:
            type: string
          type: array
      required:
      - scratchPlateId
      type: object
    QuantityInput:
      additionalProperties: false
      properties:
        amount:
          type: number
        unit:
          $ref: '#/components/schemas/UnitInput'
      required:
      - amount
      type: object
    RangeCoordinates:
      additionalProperties: false
      properties:
        fromDocumentPartId:
          type: string
        toDocumentPartId:
          type: string
      required:
      - fromDocumentPartId
      - toDocumentPartId
      type: object
    ReactantComponent:
      description: Reaction component sub-type for reactants
      properties:
        __typename:
          type: string
        amountActual:
          format: decimal
          type:
          - 'null'
          - string
        amountPlan:
          format: decimal
          type:
          - 'null'
          - string
        amountUnit:
          oneOf:
          - $ref: '#/components/schemas/UnitRef'
          - type: 'null'
        calculationBase:
          enum:
          - MOL_EQUIVALENT
          - MOL_PLAN
          - AMOUNT_PLAN
          type: string
        concentration:
          format: decimal
          type:
          - 'null'
          - string
        concentrationUnit:
          oneOf:
          - $ref: '#/components/schemas/UnitRef'
          - type: 'null'
        isLimitingReactant:
          type: boolean
        linkedLot:
          oneOf:
          - $ref: '#/components/schemas/CustomEntityRef'
          - type: 'null'
        linkedMolecule:
          description: Union of InternalLinkedMolecule, ExternalLinkedMolecule
          oneOf:
          - anyOf:
            - $ref: '#/components/schemas/InternalLinkedMolecule'
            - $ref: '#/components/schemas/ExternalLinkedMolecule'
            discriminator:
              propertyName: __typename
          - type: 'null'
        molActual:
          format: decimal
          type:
          - 'null'
          - string
        molEquivalent:
          format: decimal
          type:
          - 'null'
          - string
        molPlan:
          format: decimal
          type:
          - 'null'
          - string
        molUnit:
          oneOf:
          - $ref: '#/components/schemas/UnitRef'
          - type: 'null'
        purity:
          format: decimal
          type:
          - 'null'
          - string
        role:
          enum:
          - REACTANT
          - PRODUCT
          - REAGENT
          - BYPRODUCT
          - SOLVENT
          - CATALYST
          type: string
      type: object
    Reaction:
      description: A Chemical Reaction is a process where molecules are transformed
        into new molecules.
      properties:
        __typename:
          type: string
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        authors:
          oneOf:
          - format: uri
            type: string
          - type: 'null'
        components:
          items:
            anyOf:
            - $ref: '#/components/schemas/StandardReactionComponent'
            - $ref: '#/components/schemas/ReactantComponent'
            - $ref: '#/components/schemas/ProductComponent'
            description: Union of StandardReactionComponent, ReactantComponent, ProductComponent
            discriminator:
              propertyName: __typename
          type: array
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        entry:
          oneOf:
          - $ref: '#/components/schemas/EntryRef'
          - type: 'null'
        folder:
          $ref: '#/components/schemas/FolderRef'
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        webUrl:
          type: string
      type: object
    ReactionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Reaction'
          type: array
        nextToken:
          type: string
      type: object
    RegionsListItem:
      description: 'Represents a contiguous position range within a Translation or
        other multi-region feature.

        For spliced genes or complex reading frames, a Translation may span multiple
        non-contiguous

        regions (exons) that are joined during translation. Each RegionsListItem defines
        one such

        segment using 0-based coordinates (start inclusive, end exclusive). For circular
        sequences,

        regions can wrap around, but the end value is always the sequence length rather
        than 0.'
      properties:
        __typename:
          type: string
        end:
          description: '0-based exclusive end index. For ranges ending at the end
            of a circular sequence, this value is

            always the length of the sequence, never 0.'
          type: integer
        start:
          description: 0-based inclusive start index.
          type: integer
      type: object
    RegistrationOrigin:
      description: 'Captures the provenance of an entity''s registration into the
        registry. The `originEntry` links

        to the `DocumentLike` (typically an entry or notebook) from which the entity
        was registered,

        providing traceability back to the original experimental context. The `registeredAt`
        timestamp

        records when the registration occurred. This information helps scientists
        understand where

        registered entities came from and when they were added to the registry.'
      properties:
        __typename:
          type: string
        originEntry:
          oneOf:
          - $ref: '#/components/schemas/DocumentLikeRef'
          - type: 'null'
        registeredAt:
          format: datetime
          type:
          - 'null'
          - string
      type: object
    Registry:
      description: 'A centralized, validated repository for entities and inventory
        items within an organization.

        The registry serves as the source of truth for registered items—entities placed
        in the registry

        have passed validation checks (required fields, unique constraints, unique
        aliases) and received

        a unique registry identifier. Each organization has at most one registry.
        Items can become

        invalid after registration, so asynchronous validation tracks current validity
        state.

        Under the hood, the registry is a special type of project with a single root
        folder for

        entities, while inventory items live directly on the registry. Access is controlled
        through

        `collaborations`. Also known as the "Registry" in the Benchling UI sidebar.'
      properties:
        __typename:
          type: string
        id:
          type: string
        modifiedAt:
          description: DateTime the Registry was last modified
          format: datetime
          type: string
        name:
          description: Name of the Registry
          type:
          - 'null'
          - string
        owner:
          description: Organization the Registry belongs to.
          oneOf:
          - $ref: '#/components/schemas/OrganizationRef'
          - type: 'null'
      type: object
    RegistryPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Registry'
          type: array
        nextToken:
          type: string
      type: object
    RegistryRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    RemoveQuotesTransform:
      description: 'A data transform that strips quote characters from all values
        in the file. Takes no

        additional configuration parameters.'
      properties:
        __typename:
          type: string
        transformationProperties:
          description: Additional parameters for this transform - an empty object
          type:
          - 'null'
          - object
        type:
          description: The type of this transform (REMOVE_QUOTES)
          enum:
          - ADD_COLUMN
          - ARITHMETIC
          - CUSTOM
          - DUPLICATE
          - EXTRA_HEADERS
          - EXTRA_FOOTERS
          - FILTER
          - FIND_REPLACE
          - MERGE
          - MELT
          - PLATE_SHAPE
          - PIVOT
          - REMOVE_QUOTES
          - SPLIT
          - null
          type:
          - 'null'
          - string
      type: object
    RequestV2Definition:
      description: 'A reusable template that defines the structure and configuration
        for requests

        in Benchling. Also known as a "Request Template" in the UI. Each RequestV2Definition

        specifies a `templateDocument` that serves as the document template for requests,
        a

        `workflowTaskSchema` that defines the task structure and fields, and a `prefix`
        used

        to generate human-readable display IDs (e.g., "REQ-001") for submissions created
        from

        this template. Request templates are organized within `TemplateCollection`
        folders and

        support collaboration features like starring (see `Starrable`). When users
        submit a

        request, they create a `RequestV2Submission` based on this definition. The
        template

        can include a `description` to explain its intended use and can be archived
        when no

        longer needed.'
      properties:
        __typename:
          type: string
        archivableParent:
          $ref: '#/components/schemas/TemplateCollectionRef'
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        description:
          description: Description of the request template.
          type:
          - 'null'
          - string
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        prefix:
          description: The prefix for the displayId of tasks of this schema.
          type: string
        templateCollection:
          $ref: '#/components/schemas/TemplateCollectionRef'
        webUrl:
          type:
          - 'null'
          - string
        workflowTaskSchema:
          $ref: '#/components/schemas/WorkflowTaskSchemaRef'
          description: The task schema backing this configuration.
      type: object
    RequestV2DefinitionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/RequestV2Definition'
          type: array
        nextToken:
          type: string
      type: object
    RequestV2DefinitionRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    RequestV2Submission:
      description: 'A workflow request submitted from a `RequestV2Definition` (known
        as "Request Template" in the UI).

        When a request is submitted (status transitions to SENT), a `WorkflowTaskGroup`
        is automatically

        created to fulfill the request, containing tasks defined by the template''s
        workflow task schema.

        Requests are authored in a `Document` and stored within `Folder`s. The `status`
        field tracks

        the request lifecycle: requests start as DRAFT while being composed, become
        SENT when submitted,

        and transition to FULFILLED when all associated workflow tasks reach terminal
        status. Requests

        can also be DISCARDED (before submission) or CANCELLED (after submission).
        Users can

        be added as `watchers` to receive notifications about request status changes.
        Requests can be

        linked to `Study` entities for research coordination (see `Studyable` interface).'
      properties:
        __typename:
          type: string
        archivableParent:
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        authors:
          description: The authors of the request. By default, this is set to the
            creator.
          oneOf:
          - format: uri
            type: string
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        definition:
          $ref: '#/components/schemas/RequestV2DefinitionRef'
          description: The configuration model for the request submission.
        displayId:
          type:
          - 'null'
          - string
        folder:
          $ref: '#/components/schemas/FolderRef'
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        status:
          description: The first-class status of the request. Once submitted, this
            status is an aggregation of task statuses.
          enum:
          - DRAFT
          - SENT
          - DISCARDED
          - CANCELLED
          - FULFILLED
          type: string
        workflowTaskGroup:
          description: The task group created to fulfill the request.
          oneOf:
          - $ref: '#/components/schemas/WorkflowTaskGroupRef'
          - type: 'null'
      type: object
    RequestV2SubmissionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/RequestV2Submission'
          type: array
        nextToken:
          type: string
      type: object
    RequestV2SubmissionRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ResourceAppConfigSpec:
      description: 'Specifies that an app configuration field should reference a Benchling
        object instance.

        The type field identifies the kind of object required, matching the BenchlingAppType

        values used in app manifests (e.g. dna_sequence, folder, registry). Covers
        all instance

        reference types with no additional spec constraints beyond requiredConfig.
        For schema

        references use SchemaAppConfigSpec or EntitySchemaAppConfigSpec.'
      properties:
        __typename:
          type: string
        requiredConfig:
          type:
          - 'null'
          - boolean
        type:
          enum:
          - BOX_SCHEMA
          - CONTAINER_SCHEMA
          - ENTRY_SCHEMA
          - LEGACY_REQUEST_SCHEMA
          - LOCATION_SCHEMA
          - PLATE_SCHEMA
          - RESULT_SCHEMA
          - RUN_SCHEMA
          - WORKFLOW_TASK_SCHEMA
          - AA_SEQUENCE
          - ASSAY_RESULT
          - ASSAY_RUN
          - AUTOMATION_INPUT_GENERATOR
          - AUTOMATION_OUTPUT_PROCESSOR
          - BLOB
          - BOX
          - CONTAINER
          - CUSTOM_ENTITY
          - DNA_ALIGNMENT
          - DNA_OLIGO
          - DNA_SEQUENCE
          - DROPDOWN
          - DROPDOWN_OPTION
          - ENTRY
          - FIELD
          - FOLDER
          - LEGACY_REQUEST
          - LOCATION
          - MIXTURE
          - MOLECULE
          - PLATE
          - PROJECT
          - REGISTRY
          - RNA_OLIGO
          - RNA_SEQUENCE
          - WORKFLOW_TASK_STATUS
          - WORKLIST
          - null
          type:
          - 'null'
          - string
      type: object
    ResourceAppConfigValue:
      description: 'Stores a reference to any Benchling object or schema that is identified
        by a resource

        ID. The type field identifies what kind of resource is referenced, matching
        the

        BenchlingAppType values used in app manifests. Covers all linked resource
        types except

        EntitySchema (which has a subtype) and array elements.'
      properties:
        __typename:
          type: string
        type:
          enum:
          - BOX_SCHEMA
          - CONTAINER_SCHEMA
          - ENTRY_SCHEMA
          - LEGACY_REQUEST_SCHEMA
          - LOCATION_SCHEMA
          - PLATE_SCHEMA
          - RESULT_SCHEMA
          - RUN_SCHEMA
          - WORKFLOW_TASK_SCHEMA
          - AA_SEQUENCE
          - ASSAY_RESULT
          - ASSAY_RUN
          - AUTOMATION_INPUT_GENERATOR
          - AUTOMATION_OUTPUT_PROCESSOR
          - BLOB
          - BOX
          - CONTAINER
          - CUSTOM_ENTITY
          - DNA_ALIGNMENT
          - DNA_OLIGO
          - DNA_SEQUENCE
          - DROPDOWN
          - DROPDOWN_OPTION
          - ENTRY
          - FIELD
          - FOLDER
          - LEGACY_REQUEST
          - LOCATION
          - MIXTURE
          - MOLECULE
          - PLATE
          - PROJECT
          - REGISTRY
          - RNA_OLIGO
          - RNA_SEQUENCE
          - WORKFLOW_TASK_STATUS
          - WORKLIST
          - null
          type:
          - 'null'
          - string
        value:
          type:
          - 'null'
          - string
      type: object
    Result:
      allOf:
      - $ref: '#/components/schemas/IResult'
      - description: 'A Result represents a single row of experimental measurement
          data in Benchling''s lab

          automation system. Results conform to a ResultSchema that defines their
          field structure,

          enabling standardized capture of assay outputs such as absorbance readings,
          Ct values,

          concentrations, or other measured quantities. Results are typically created
          through

          lab automation output processors (see AutomationOutputProcessor), structured
          result

          tables in notebook entries (via the entry field), or programmatically via
          the API.

          Each result belongs to a Project for access control and can be archived
          when no longer

          needed. Results can be linked to entities, samples, and runs through schema
          field values,

          enabling traceability from raw measurements back to source materials.'
        properties:
          __typename:
            type: string
          creator:
            description: User who created the request
            oneOf:
            - $ref: '#/components/schemas/PrincipalRef'
            - type: 'null'
          entry:
            description: Entry that this result is attached to
            oneOf:
            - $ref: '#/components/schemas/DocumentLikeRef'
            - type: 'null'
          schemaFields:
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    ResultPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Result'
          type: array
        nextToken:
          type: string
      type: object
    ResultRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ResultSchema:
      description: 'Defines the structure and metadata fields for a category of assay
        Results in Benchling''s

        lab automation system. A ResultSchema specifies the field definitions that
        capture

        measurement data, calculated values, and other experimental outcomes. Results
        conforming

        to a schema are typically created through lab automation output processors
        (see

        AutomationOutputProcessor), structured result tables in notebook entries,
        or via the API.

        Each schema is owned by an Organization and supports collaboration settings
        for access

        control. ResultSchemas are often associated with specific assay types such
        as ELISA,

        qPCR, or mass spectrometry, enabling standardized data capture across experiments.

        Also known as "assay schema" in some contexts (note the assaysch prefix).'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        fieldDefinitions:
          description: Defines the metadata fields for results belonging to this schema
          format: uri
          type: string
        id:
          type: string
        modifiedAt:
          description: DateTime the Result Schema was last modified
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        organization:
          description: The organization that owns the schema
          oneOf:
          - $ref: '#/components/schemas/OrganizationRef'
          - type: 'null'
      type: object
    ResultSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ResultSchema'
          type: array
        nextToken:
          type: string
      type: object
    ResultSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    Review:
      description: 'Represents an active or completed review of a reviewable item
        such as an Entry or

        StageEntry. A Review tracks the overall status, the assigned reviewers (see
        `Reviewer`),

        and links back to the reviewable item. Reviews follow a configured `ReviewProcess`

        that defines the stages and actions required for completion. The review status

        progresses from submission through reviewer actions until reaching a terminal
        state

        like ACCEPTED or REJECTED.'
      properties:
        __typename:
          type: string
        createdAt:
          description: Timestamp when this review was created
          format: datetime
          type: string
        id:
          description: ID of the review
          type: string
        reviewHistory:
          description: 'Ordered list of ReviewChange records representing the full
            audit history of this review.

            Each ReviewChange captures a single action taken (e.g. send-for-review,
            approve, reject, retract),

            the timestamp it occurred, any associated comment, and an optional point-in-time
            snapshot.

            To query review history by the reviewable item''s ID (e.g. an entry ID
            like etr_...) instead of

            the review ID, use GET /benchling/review-change/items?reviewableId.anyOf=<id>.'
          format: uri
          type: string
        reviewProcess:
          description: The review process that governs this review
          oneOf:
          - $ref: '#/components/schemas/ReviewProcessRef'
          - type: 'null'
        reviewSender:
          description: The user who last sent this reviewable for review, or self-approved
            in a self-review process.
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        reviewableId:
          description: API identifier of the reviewable item (e.g. an Entry) that
            this review belongs to.
          type: string
        reviewers:
          description: Reviewers associated with this review
          oneOf:
          - items:
              $ref: '#/components/schemas/Reviewer'
            type: array
          - type: 'null'
        status:
          description: The status of this review
          enum:
          - REVIEW_SNAPSHOT_IN_PROGRESS
          - NEEDS_REVIEW
          - REJECTED
          - RETRACTED
          - ACCEPTANCE_SNAPSHOT_IN_PROGRESS
          - ACCEPTED
          - CYCLE_COMPLETED
          - ACTION_REQUIRED
          - null
          type:
          - 'null'
          - string
      type: object
    ReviewChange:
      description: 'Represents a single action taken within a review. ReviewChanges
        form an ordered

        history of all changes made to a review, including status transitions,

        reviewer assignments, and comments. Each ReviewChange records the action taken,

        any associated comment, whether it was electronically signed, and an optional

        point-in-time snapshot.'
      properties:
        __typename:
          type: string
        action:
          description: The action taken
          enum:
          - SEND_FOR_REVIEW
          - REQUEST_CHANGES
          - APPROVE
          - REJECT
          - RETRACT
          - ACCEPT
          - COMPLETE
          - SIGN
          - REVIEW
          - WITNESS
          - SELF_REVIEW
          - COMMENT
          - REASSIGN
          - null
          type:
          - 'null'
          - string
        comment:
          description: Optional comment associated with this change
          type:
          - 'null'
          - string
        createdAt:
          description: When this change occurred
          format: datetime
          type: string
        eSigned:
          description: Whether this change was electronically signed
          type:
          - 'null'
          - boolean
        id:
          description: ID of the review change
          type: string
        review:
          $ref: '#/components/schemas/ReviewRef'
          description: The review this change belongs to
        snapshot:
          description: A point-in-time snapshot of the reviewable item taken at the
            time of this action
          oneOf:
          - $ref: '#/components/schemas/ReviewSnapshot'
          - type: 'null'
      type: object
    ReviewChangePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ReviewChange'
          type: array
        nextToken:
          type: string
      type: object
    ReviewPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Review'
          type: array
        nextToken:
          type: string
      type: object
    ReviewProcess:
      description: 'Defines a review process configuration that specifies how entries
        and other

        reviewable items should be reviewed. A ReviewProcess belongs to an Organization

        and can be associated with one or more Projects. When a review is initiated,

        it follows the stages defined in the current `ReviewProcessVersion`. Review

        processes enable organizations to enforce compliance requirements by defining

        who must review, in what order, and what actions are required. Also known
        as

        "Review Lifecycle" in the backend.'
      properties:
        __typename:
          type: string
        createdAt:
          description: Timestamp when this review process was created
          format: datetime
          type: string
        currentVersion:
          description: Current version of this review process
          oneOf:
          - $ref: '#/components/schemas/ReviewProcessVersion'
          - type: 'null'
        id:
          description: ID of the review process
          type: string
        modifiedAt:
          description: Timestamp when this review process was last modified
          format: datetime
          type: string
        name:
          description: Title of the review process
          type:
          - 'null'
          - string
        organization:
          description: The organization that owns this review process
          oneOf:
          - $ref: '#/components/schemas/OrganizationRef'
          - type: 'null'
        projects:
          description: All projects that point to this review process
          format: uri
          type: string
      type: object
    ReviewProcessPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ReviewProcess'
          type: array
        nextToken:
          type: string
      type: object
    ReviewProcessRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ReviewProcessStage:
      description: 'A single stage within a ReviewProcess that defines a required
        step in the review

        workflow. Each stage specifies what action reviewers must take (see

        `ReviewProcessActionType`), who is eligible to be a reviewer (see `ReviewerType`),

        and optionally a specific Team. For sequential review processes, stages have
        a

        position index determining their order. Stages can be configured to allow
        or

        disallow authors and senders as reviewers, and can permit team member reassignment.


        The list endpoint returns stages from the current version of each accessible
        review

        process. To retrieve stages scoped to a specific review process, use

        `GET /benchling/review-process/{review_process_id}` and inspect `currentVersion.reviewStages`.'
      properties:
        __typename:
          type: string
        action:
          description: Action to be taken by the reviewer for this review process
            stage
          enum:
          - APPROVE
          - COMPLETE
          - ACCEPT
          - REVIEW
          - WITNESS
          - SELF_REVIEW
          - null
          type:
          - 'null'
          - string
        allowAuthorReviewers:
          description: Whether authors can review this review process stage
          type: boolean
        allowSenderReviewer:
          description: Whether the sender can review this review process stage
          type: boolean
        createdAt:
          description: Timestamp when this review process stage was created
          format: datetime
          type: string
        description:
          description: Description of the review process stage
          type:
          - 'null'
          - string
        id:
          description: ID of the review process stage
          type: string
        isTeamReassignable:
          description: Whether team members can reassign this review stage to other
            team members
          type:
          - 'null'
          - boolean
        name:
          description: Title of the review process stage
          type:
          - 'null'
          - string
        reviewerType:
          description: Type of reviewer that is valid for the review process stage
          enum:
          - AUTHOR
          - TEAM
          - PROJECT_MEMBERS
          - null
          type:
          - 'null'
          - string
        selectedTeam:
          description: Team that is selected to review this review process stage
          oneOf:
          - $ref: '#/components/schemas/TeamRef'
          - type: 'null'
        sequentialPositionIndex:
          description: Position of this stage in the review process
          type:
          - 'null'
          - integer
      type: object
    ReviewProcessStagePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ReviewProcessStage'
          type: array
        nextToken:
          type: string
      type: object
    ReviewProcessStageRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ReviewProcessUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ReviewProcess'
          type: array
      type: object
    ReviewProcessVersion:
      description: 'A specific version of a ReviewProcess configuration. Review processes
        are versioned

        to allow changes to review requirements while preserving the rules that apply
        to

        in-progress reviews. Each version defines the process type (self-review, parallel,

        or sequential), the terminal state when complete, and the ordered list of

        `ReviewProcessStage`s that must be completed.'
      properties:
        __typename:
          type: string
        processType:
          description: Type of this review process
          enum:
          - SELF_REVIEW
          - PARALLEL
          - SEQUENTIAL
          - null
          type:
          - 'null'
          - string
        reviewStages:
          description: List of all stages the review must go through
          items:
            $ref: '#/components/schemas/ReviewProcessStageRef'
          type: array
        terminalState:
          description: Stage of the reviewable at the end of the review process
          enum:
          - APPROVED
          - COMPLETED
          - ACCEPTED
          - REVIEWED
          - WITNESSED
          - SELF_REVIEWED
          type: string
      type: object
    ReviewRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ReviewSnapshot:
      description: 'A point-in-time snapshot of a reviewable item (e.g. an Entry)
        captured when a

        review action was taken. Snapshots are a configurable feature enabled via

        ENABLE_ELN_REVIEW_SNAPSHOTS. When status is SUCCEEDED, a time-limited downloadUrl
        is available.'
      properties:
        __typename:
          type: string
        downloadUrl:
          description: URL to download the snapshot export. Only present when status
            is SUCCEEDED.
          type:
          - 'null'
          - string
        size:
          description: Size of the snapshot export in bytes. Only present when status
            is SUCCEEDED.
          type:
          - 'null'
          - integer
        status:
          description: Status of the snapshot export
          enum:
          - PENDING
          - RUNNING
          - SUCCEEDED
          - FAILED
          - null
          type:
          - 'null'
          - string
      type: object
    Reviewer:
      description: 'Represents a user assigned to review a specific stage of an Entry''s
        review process.

        Each Reviewer is associated with a Review and tracks whether they have completed
        their

        assigned action. The reviewer status progresses from BLOCKED (if sequential
        and waiting)

        to PENDING (can act) to FINISHED or REJECTED. Reviewers are assigned based
        on the

        `ReviewProcessStage` configuration and its `ReviewerType` requirements.'
      properties:
        __typename:
          type: string
        reviewProcessStageName:
          description: Name of review process stage reviewer is meant to review
          type:
          - 'null'
          - string
        reviewerStatus:
          description: The current status of this reviewer (FINISHED, PENDING, etc.)
          enum:
          - BLOCKED
          - PENDING
          - FINISHED
          - REJECTED
          - null
          type:
          - 'null'
          - string
        user:
          description: User this reviewer represents
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
      type: object
    RnaAnnotationInput:
      additionalProperties: false
      properties:
        color:
          type: string
        customFields:
          items:
            $ref: '#/components/schemas/CustomFieldInput'
          type: array
        end:
          type: integer
        name:
          type: string
        notes:
          description: Field will be set to an empty string if not specified.
          type: string
        start:
          type: integer
        strand:
          enum:
          - FORWARD
          - null
          type:
          - 'null'
          - string
        type:
          type: string
      required:
      - name
      - end
      - start
      type: object
    RnaOligo:
      allOf:
      - $ref: '#/components/schemas/IRnaOligo'
      - description: 'Represents a short single-stranded RNA oligonucleotide in Benchling''s
          molecular biology

          platform. RNA oligos are synthetic sequences used in applications such as
          RNA interference

          (siRNA, shRNA), antisense oligonucleotides (ASOs), mRNA therapeutics, or
          CRISPR guide RNAs.

          Each oligo stores its nucleotide base sequence, annotations for features
          of interest, and

          chemical modifications (see ModifiedNucleotide) such as 2''-O-methyl sugars
          or phosphorothioate

          backbones that enhance stability and efficacy. RNA oligos can be registered
          in the Registry

          with unique identifiers, organized in folders, and linked to other entities
          via schema

          fields. Unlike RnaSequence, oligos are specifically designed for shorter,
          synthesizable

          sequences. Also referred to as RNA probes or therapeutic oligonucleotides
          depending on

          their application.'
        properties:
          __typename:
            type: string
          authors:
            oneOf:
            - format: uri
              type: string
            - type: 'null'
          creator:
            oneOf:
            - $ref: '#/components/schemas/PrincipalRef'
            - type: 'null'
          schemaFields:
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    RnaOligoCreatedWebhookEnvelopeV3:
      allOf:
      - $ref: '#/components/schemas/WebhookEnvelopeBaseV0'
      - properties:
          message:
            $ref: '#/components/schemas/RnaOligoCreatedWebhookV3'
        required:
        - message
        type: object
      description: Request body Benchling sends for a `v3.rnaOligo.created` event.
    RnaOligoCreatedWebhookV3:
      allOf:
      - $ref: '#/components/schemas/V3EventBase'
      - properties:
          type:
            description: The event type.
            enum:
            - v3.rnaOligo.created
            type: string
        required:
        - type
        type: object
      description: Message body of a `v3.rnaOligo.created` event.
    RnaOligoLinkFieldDefinition:
      description: A schema field definition for linking to RNA Oligos.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent RNA Oligo. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinition:
          $ref: '#/components/schemas/RnaOligoSchemaRef'
          description: The linked item must be of this schema. This is required because
            we do not allow linking to a generic RNA Oligo.
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    RnaOligoPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/RnaOligo'
          type: array
        nextToken:
          type: string
      type: object
    RnaOligoSchema:
      description: Defines the structure, field definitions, and configuration options
        for RNA oligos.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/Constraint'
          - type: 'null'
        containableType:
          enum:
          - NONE
          - ENTITY
          - BATCH
          type: string
        containerNameTemplate:
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplate'
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          type: string
        fieldDefinitions:
          format: uri
          type: string
        fieldsets:
          format: uri
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - OLIGO
          - OLIGO_V2
          - SEQUENCE
          type: string
        id:
          type: string
        includeRegistryIdInChips:
          type: boolean
        itemIdPrefix:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        nameTemplate:
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplate'
          - type: 'null'
        organization:
          $ref: '#/components/schemas/OrganizationRef'
        showResidues:
          description: Controls whether RNA residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfiguration'
          type: array
        systemName:
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    RnaOligoSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/RnaOligoSchema'
          type: array
        nextToken:
          type: string
      type: object
    RnaOligoSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    RnaOligoSchemaSetFieldDefinitionsInput:
      additionalProperties: false
      properties:
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateSystemCategoryLinkFieldDefinitionInput'
          type: array
      required:
      - fieldDefinitions
      type: object
    RnaOligoUpdatedWebhookEnvelopeV3:
      allOf:
      - $ref: '#/components/schemas/WebhookEnvelopeBaseV0'
      - properties:
          message:
            $ref: '#/components/schemas/RnaOligoUpdatedWebhookV3'
        required:
        - message
        type: object
      description: Request body Benchling sends for a `v3.rnaOligo.updated` event.
    RnaOligoUpdatedWebhookV3:
      allOf:
      - $ref: '#/components/schemas/V3UpdateEventBase'
      - properties:
          type:
            description: The event type.
            enum:
            - v3.rnaOligo.updated
            type: string
        required:
        - type
        type: object
      description: Message body of a `v3.rnaOligo.updated` event.
    RnaPart:
      description: 'Represents a region on an RNA sequence that matches or is derived
        from another registered

        RNA sequence. RnaPart features enable tracking the provenance of sequence
        regions, such as

        identifying that a particular element in an RNA molecule originates from a
        specific source

        sequence. Each part specifies the referenced RnaSequence, the strand orientation
        (forward

        or reverse), and the position range using 0-based coordinates with an exclusive
        end index.

        Parts appear as visual features on the sequence viewer and support traceability.'
      properties:
        __typename:
          type: string
        containerSequence:
          $ref: '#/components/schemas/RnaSequenceRef'
          description: The RNA sequence that contains this part.
        end:
          description: '0-based exclusive end index. For ranges ending at the end
            of a circular sequence, this value is

            always the length of the sequence, never 0.'
          type: integer
        id:
          description: The ID of the RNA Part.
          type: string
        sequence:
          $ref: '#/components/schemas/RnaSequenceRef'
          description: RNA sequence this part refers to.
        start:
          description: 0-based inclusive start index.
          type: integer
        strand:
          description: Strand for this part; 1 for forward strand, -1 for reverse
            strand.
          type: integer
      type: object
    RnaPartInput:
      additionalProperties: false
      properties:
        end:
          type: integer
        sequenceId:
          type: string
        start:
          type: integer
      required:
      - end
      - sequenceId
      - start
      type: object
    RnaPartUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/RnaPart'
          type: array
      type: object
    RnaSequence:
      allOf:
      - $ref: '#/components/schemas/IRnaSequence'
      - description: 'Represents an RNA sequence in Benchling''s molecular biology
          platform. An RnaSequence stores

          the nucleotide bases (using A, C, G, U) along with annotations marking functional
          regions,

          translation annotations for protein-coding regions (see Translation), primer
          binding sites

          (see Primer), and part features linking to other registered sequences (see
          RnaPart). RNA

          sequences are used for modeling messenger RNAs, non-coding RNAs, CRISPR
          guide RNAs, and

          other RNA molecules. Sequences can be registered in the Registry with a
          unique

          entityRegistryId, organized in folders, and linked via schema fields to
          other entities.

          For modified therapeutic RNAs, see modifiedNucleotides which captures chemical
          modifications.

          Also known as ''Sequence'' in the Benchling interface, with IDs prefixed
          by ''seq''.'
        properties:
          __typename:
            type: string
          authors:
            oneOf:
            - format: uri
              type: string
            - type: 'null'
          creator:
            oneOf:
            - $ref: '#/components/schemas/PrincipalRef'
            - type: 'null'
          schemaFields:
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    RnaSequenceCreatedWebhookEnvelopeV3:
      allOf:
      - $ref: '#/components/schemas/WebhookEnvelopeBaseV0'
      - properties:
          message:
            $ref: '#/components/schemas/RnaSequenceCreatedWebhookV3'
        required:
        - message
        type: object
      description: Request body Benchling sends for a `v3.rnaSequence.created` event.
    RnaSequenceCreatedWebhookV3:
      allOf:
      - $ref: '#/components/schemas/V3EventBase'
      - properties:
          type:
            description: The event type.
            enum:
            - v3.rnaSequence.created
            type: string
        required:
        - type
        type: object
      description: Message body of a `v3.rnaSequence.created` event.
    RnaSequenceLinkFieldDefinition:
      description: A schema field definition for linking to RNA sequences.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent RNA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinition:
          $ref: '#/components/schemas/RnaSequenceSchemaRef'
          description: The linked item must be of this schema. This is required because
            we do not allow linking to a generic RNA Sequence.
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    RnaSequencePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/RnaSequence'
          type: array
        nextToken:
          type: string
      type: object
    RnaSequenceRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    RnaSequenceSchema:
      description: Defines the structure, field definitions, and configuration options
        for RNA sequences
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/Constraint'
          - type: 'null'
        containableType:
          enum:
          - NONE
          - ENTITY
          - BATCH
          type: string
        containerNameTemplate:
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplate'
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        description:
          type: string
        fieldDefinitions:
          format: uri
          type: string
        fieldsets:
          format: uri
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - OLIGO_V2
          - PRIMER_PAIR
          - RNA_SEQUENCE
          - SEQUENCE
          type: string
        id:
          type: string
        includeRegistryIdInChips:
          type: boolean
        itemIdPrefix:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        nameTemplate:
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplate'
          - type: 'null'
        organization:
          $ref: '#/components/schemas/OrganizationRef'
        showResidues:
          description: Controls whether RNA residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfiguration'
          type: array
        systemName:
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    RnaSequenceSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/RnaSequenceSchema'
          type: array
        nextToken:
          type: string
      type: object
    RnaSequenceSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    RnaSequenceSchemaSetFieldDefinitionsInput:
      additionalProperties: false
      properties:
        fieldDefinitions:
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/CreateTranslationLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBooleanFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDateTimeFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFloatFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateIntegerFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateLongTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateTextFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAntibodyLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRequestLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayResultLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAssayRunLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateBlobLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateCustomEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateDropdownLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateAnyEntityLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEntryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateEquipmentLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateFieldsetLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMixtureLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateMoleculeLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoConjugateLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateOligoDuplexLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaSequenceLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateRnaOligoLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateStorableLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateSystemCategoryLinkFieldDefinitionInput'
            - $ref: '#/components/schemas/UpdateTranslationLinkFieldDefinitionInput'
          type: array
      required:
      - fieldDefinitions
      type: object
    RnaSequenceUpdatedWebhookEnvelopeV3:
      allOf:
      - $ref: '#/components/schemas/WebhookEnvelopeBaseV0'
      - properties:
          message:
            $ref: '#/components/schemas/RnaSequenceUpdatedWebhookV3'
        required:
        - message
        type: object
      description: Request body Benchling sends for a `v3.rnaSequence.updated` event.
    RnaSequenceUpdatedWebhookV3:
      allOf:
      - $ref: '#/components/schemas/V3UpdateEventBase'
      - properties:
          type:
            description: The event type.
            enum:
            - v3.rnaSequence.updated
            type: string
        required:
        - type
        type: object
      description: Message body of a `v3.rnaSequence.updated` event.
    RnaTranslationInput:
      additionalProperties: false
      properties:
        color:
          description: 'Field will be set to #84B0DC if not specified.'
          type: string
        customFields:
          items:
            $ref: '#/components/schemas/CustomFieldInput'
          type: array
        geneticCode:
          description: Field will be set to STANDARD if not specified.
          enum:
          - STANDARD
          - VERTEBRATE_MITOCHONDRIAL
          - YEAST_MITOCHONDRIAL
          - MOLD_PROTOZOAN_COELENTERATE_MITOCHONDRIAL_MYCOPLASMA_SPIROPLASMA
          - INVERTEBRATE_MITOCHONDRIAL
          - CILIATE_DASYCLADACEAN_HEXAMITA_NUCLEAR
          - ECHINODERM_FLATWORM_MITOCHONDRIAL
          - EUPLOTID_NUCLEAR
          - BACTERIAL_ARCHAEAL_PLANT_PLASTID
          - ALTERNATIVE_YEAST_NUCLEAR
          - ASCIDIAN_MITOCHONDRIAL
          - ALTERNATIVE_FLATWORM_MITOCHONDRIAL
          - CHLOROPHYCEAN_MITOCHONDRIAL
          - TREMATODE_MITOCHONDRIAL
          - SCENEDESMUS_OBLIQUUS_MITOCHONDRIAL
          - THRAUSTOCHYTRIUM_MITOCHONDRIAL
          - RHABDOPLEURIDAE_MITOCHONDRIAL
          - CANDIDATE_DIVISION_SR1_GRACILIBACTERIA
          - PACHYSOLEN_TANNOPHILUS_NUCLEAR
          - KARYORELICT_NUCLEAR
          - CONDYLOSTOMA_NUCLEAR
          - MESODINIUM_NUCLEAR
          - PERITRICH_NUCLEAR
          - BLASTOCRITHIDIA_NUCLEAR
          - CEPHALODISCIDAE_MITOCHONDRIAL_UAA_TYR
          type: string
        name:
          type: string
        notes:
          type: string
        regions:
          items:
            $ref: '#/components/schemas/TranslationRegionInput'
          type: array
        translateFirstCodonToMethionine:
          description: Field will be set to False if not specified.
          type: boolean
      required:
      - regions
      type: object
    Run:
      allOf:
      - $ref: '#/components/schemas/IRun'
      - description: 'A Run represents an execution instance of a lab automation workflow
          in Benchling, capturing

          the inputs, outputs, and metadata for a single assay or instrument operation.
          Runs conform

          to a RunSchema that defines their structure including input generators (see
          AutomationInputGenerator)

          for creating worklists and output processors (see AutomationOutputProcessor)
          for parsing

          instrument results. Runs are typically embedded in notebook entries (via
          the entry field)

          and can generate associated Analyses for data processing. Each run tracks
          validation status

          (VALID or INVALID) with optional comments, enabling quality control workflows.
          Runs belong

          to a Project for access control and can be archived when superseded or invalidated.
          Also

          known as "assay runs" in the lab automation context.'
        properties:
          __typename:
            type: string
          creator:
            description: User who created the run
            oneOf:
            - $ref: '#/components/schemas/PrincipalRef'
            - type: 'null'
          entry:
            description: Entry that this run is attached to
            oneOf:
            - $ref: '#/components/schemas/DocumentLikeRef'
            - type: 'null'
          schemaFields:
            description: Schema field values that belong to the run
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    RunCreatedWebhookEnvelopeV3:
      allOf:
      - $ref: '#/components/schemas/WebhookEnvelopeBaseV0'
      - properties:
          message:
            $ref: '#/components/schemas/RunCreatedWebhookV3'
        required:
        - message
        type: object
      description: Request body Benchling sends for a `v3.run.created` event.
    RunCreatedWebhookV3:
      allOf:
      - $ref: '#/components/schemas/V3EventBase'
      - properties:
          type:
            description: The event type.
            enum:
            - v3.run.created
            type: string
        required:
        - type
        type: object
      description: Message body of a `v3.run.created` event.
    RunDocumentContent:
      description: 'Represents a run embedded in notebook or document content.

        Run content connects a document part to its run schema and, when available,
        the specific run.'
      properties:
        __typename:
          type: string
        indentation:
          type: integer
        run:
          oneOf:
          - $ref: '#/components/schemas/RunRef'
          - type: 'null'
        runSchema:
          $ref: '#/components/schemas/RunSchemaRef'
      type: object
    RunPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Run'
          type: array
        nextToken:
          type: string
      type: object
    RunRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    RunSchema:
      description: 'Defines the structure and automation configuration for a category
        of Runs in Benchling''s

        lab automation system. A RunSchema specifies field definitions for run metadata,

        input generator configurations (see AutomationInputFileConfig) for creating
        instrument

        worklists, and output processor configurations (see AutomationOutputFileConfig)
        for

        parsing instrument results. Schemas can be linked to an AnalysisTemplate for
        automated

        data processing after runs complete. Settings control whether runs can be
        created from

        notebooks (allowCreateRunFromNotebook), inserted from the run inbox (allowInsertRunFromInbox),

        and whether equipment tracking is enabled (shouldRecordEquipment). Each schema
        is owned

        by an Organization and has a systemName used for Data Platform integration.
        RunSchemas

        define the automation workflow for specific assay types like qPCR, ELISA,
        or sequencing.'
      properties:
        __typename:
          type: string
        allowCreateRunFromNotebook:
          description: Whether new runs belonging to this schema can be created from
            the notebook
          type:
          - 'null'
          - boolean
        allowInsertRunFromInbox:
          description: Whether runs belonging to this schema can be inserted in the
            notebook from the Run Inbox
          type:
          - 'null'
          - boolean
        archiveReason:
          description: If the Run is archived, reason for archiving
          type:
          - 'null'
          - string
        archived:
          description: Whether the Run is archived
          type: boolean
        automationInputFileConfigs:
          description: Configurations for automation input generators on this run
          format: uri
          type: string
        automationOutputFileConfigs:
          description: Configurations for automation output processors on this run
          format: uri
          type: string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        fieldDefinitions:
          description: Defines the metadata fields for runs belonging to this schema
          format: uri
          type: string
        id:
          type: string
        modifiedAt:
          description: DateTime the Run Schema was last modified
          format: datetime
          type:
          - 'null'
          - string
        name:
          description: Name of the Run Schema
          type: string
        organization:
          description: Organization the Run Schema belongs to
          oneOf:
          - $ref: '#/components/schemas/OrganizationRef'
          - type: 'null'
        shouldRecordEquipment:
          description: Whether runs belonging to this schema should record equipment
            or not
          type: boolean
        systemName:
          description: 'Name for this schema in the Data Platform.

            For example, the name of the warehouse table is derived from the systemName.'
          type:
          - 'null'
          - string
      type: object
    RunSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/RunSchema'
          type: array
        nextToken:
          type: string
      type: object
    RunSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    SchemaAppConfigSpec:
      description: 'Specifies that an app configuration field should reference one
        of the schema types

        that share a common structure: container_schema, plate_schema, location_schema,

        box_schema, run_schema, result_schema, legacy_request_schema, or entry_schema.

        The type field identifies which schema kind is required. For entity_schema
        use

        EntitySchemaAppConfigSpec; for workflow_task_schema use WorkflowTaskSchemaAppConfigSpec.'
      properties:
        __typename:
          type: string
        fieldDefinitions:
          oneOf:
          - items:
              $ref: '#/components/schemas/AppConfigFieldDefinition'
            type: array
          - type: 'null'
        requiredConfig:
          type:
          - 'null'
          - boolean
        type:
          enum:
          - BOX_SCHEMA
          - CONTAINER_SCHEMA
          - ENTRY_SCHEMA
          - LEGACY_REQUEST_SCHEMA
          - LOCATION_SCHEMA
          - PLATE_SCHEMA
          - RESULT_SCHEMA
          - RUN_SCHEMA
          - WORKFLOW_TASK_SCHEMA
          - AA_SEQUENCE
          - ASSAY_RESULT
          - ASSAY_RUN
          - AUTOMATION_INPUT_GENERATOR
          - AUTOMATION_OUTPUT_PROCESSOR
          - BLOB
          - BOX
          - CONTAINER
          - CUSTOM_ENTITY
          - DNA_ALIGNMENT
          - DNA_OLIGO
          - DNA_SEQUENCE
          - DROPDOWN
          - DROPDOWN_OPTION
          - ENTRY
          - FIELD
          - FOLDER
          - LEGACY_REQUEST
          - LOCATION
          - MIXTURE
          - MOLECULE
          - PLATE
          - PROJECT
          - REGISTRY
          - RNA_OLIGO
          - RNA_SEQUENCE
          - WORKFLOW_TASK_STATUS
          - WORKLIST
          - null
          type:
          - 'null'
          - string
      type: object
    SchemaFieldDefinition:
      anyOf:
      - $ref: '#/components/schemas/AaPartLinkFieldDefinition'
      - $ref: '#/components/schemas/AaSequenceLinkFieldDefinition'
      - $ref: '#/components/schemas/AntibodyLinkFieldDefinition'
      - $ref: '#/components/schemas/AnyEntityLinkFieldDefinition'
      - $ref: '#/components/schemas/AssayRequestLinkFieldDefinition'
      - $ref: '#/components/schemas/AssayResultLinkFieldDefinition'
      - $ref: '#/components/schemas/AssayRunLinkFieldDefinition'
      - $ref: '#/components/schemas/BaseFieldDefinition'
      - $ref: '#/components/schemas/BlobLinkFieldDefinition'
      - $ref: '#/components/schemas/BooleanFieldDefinition'
      - $ref: '#/components/schemas/CustomEntityLinkFieldDefinition'
      - $ref: '#/components/schemas/DateFieldDefinition'
      - $ref: '#/components/schemas/DateTimeFieldDefinition'
      - $ref: '#/components/schemas/DnaOligoLinkFieldDefinition'
      - $ref: '#/components/schemas/DnaPartLinkFieldDefinition'
      - $ref: '#/components/schemas/DnaSequenceLinkFieldDefinition'
      - $ref: '#/components/schemas/DropdownLinkFieldDefinition'
      - $ref: '#/components/schemas/EntryLinkFieldDefinition'
      - $ref: '#/components/schemas/EquipmentLinkFieldDefinition'
      - $ref: '#/components/schemas/FieldsetLinkFieldDefinition'
      - $ref: '#/components/schemas/FloatFieldDefinition'
      - $ref: '#/components/schemas/IntegerFieldDefinition'
      - $ref: '#/components/schemas/JsonFieldDefinition'
      - $ref: '#/components/schemas/LongTextFieldDefinition'
      - $ref: '#/components/schemas/MixtureLinkFieldDefinition'
      - $ref: '#/components/schemas/MoleculeLinkFieldDefinition'
      - $ref: '#/components/schemas/OligoConjugateLinkFieldDefinition'
      - $ref: '#/components/schemas/OligoDuplexLinkFieldDefinition'
      - $ref: '#/components/schemas/RnaOligoLinkFieldDefinition'
      - $ref: '#/components/schemas/RnaSequenceLinkFieldDefinition'
      - $ref: '#/components/schemas/SchemaLinkFieldDefinition'
      - $ref: '#/components/schemas/StorableLinkFieldDefinition'
      - $ref: '#/components/schemas/SystemCategoryLinkFieldDefinition'
      - $ref: '#/components/schemas/TextFieldDefinition'
      - $ref: '#/components/schemas/TranscriptionLinkFieldDefinition'
      - $ref: '#/components/schemas/TranslationLinkFieldDefinition'
      discriminator:
        propertyName: __typename
      type: object
    SchemaFieldDefinitionRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    SchemaFieldDefinitionUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/SchemaFieldDefinition'
          type: array
      type: object
    SchemaFieldValue:
      description: 'Represents a field value on a schematized object, pairing a `fieldDefinition`
        (describing the

        field''s type and constraints) with its actual `value` (a `BenchlingValue`
        such as text, number,

        date, or link to another object). The value may be null if no value has been
        set. Used within

        the `schemaFields` collection on objects that implement `HasSchema` to provide
        access to all

        custom field values defined by the object''s schema.'
      properties:
        __typename:
          type: string
        fieldDefinition:
          $ref: '#/components/schemas/SchemaFieldDefinitionRef'
        id:
          type: string
        linkedEntityId:
          type:
          - 'null'
          - string
        value:
          description: Union of BooleanValue, DateTimeValue, DateValue, DecimalValue,
            IntegerValue, JsonValue, ObjectLinkValue, ObjectLinkListValue, TextAndUrlValue,
            TextValue, ArrayValue
          oneOf:
          - anyOf:
            - $ref: '#/components/schemas/BooleanValue'
            - $ref: '#/components/schemas/DateTimeValue'
            - $ref: '#/components/schemas/DateValue'
            - $ref: '#/components/schemas/DecimalValue'
            - $ref: '#/components/schemas/IntegerValue'
            - $ref: '#/components/schemas/JsonValue'
            - $ref: '#/components/schemas/ObjectLinkValue'
            - $ref: '#/components/schemas/ObjectLinkListValue'
            - $ref: '#/components/schemas/TextAndUrlValue'
            - $ref: '#/components/schemas/TextValue'
            - $ref: '#/components/schemas/ArrayValue'
            discriminator:
              propertyName: __typename
          - type: 'null'
      type: object
    SchemaLinkFieldDefinition:
      description: 'A schema field definition for link types that reference other
        Benchling objects. Extends

        basic field properties with link-specific constraints.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          description: determines whether multiple values are allowed
          type: boolean
        isRequired:
          type: boolean
        name:
          type: string
        schemaId:
          description: limits links to entities of a specific schema
          type:
          - 'null'
          - string
        systemName:
          type: string
        type:
          description: indicates the kind of object being linked
          enum:
          - AA_PART_LINK
          - AA_SEQUENCE_LINK
          - ASSAY_REQUEST_LINK
          - ASSAY_RESULT_LINK
          - ASSAY_RUN_LINK
          - BATCH_LINK
          - BLOB_LINK
          - BOOLEAN
          - CUSTOM_ENTITY_LINK
          - DATE
          - DATETIME
          - DNA_SEQUENCE_LINK
          - ENTITY_LINK
          - ENTRY_LINK
          - FLOAT
          - INTEGER
          - JSON
          - LONG_TEXT
          - MIXTURE_LINK
          - MOLECULE_LINK
          - BASE_MOLECULE_LINK
          - PART_LINK
          - SAMPLE_LINK
          - DROPDOWN
          - STORAGE_LINK
          - TEXT
          - TRANSCRIPTION_LINK
          - TRANSLATION_LINK
          type: string
      type: object
    SchemaSetFieldDefinitionsOutput:
      description: Return shape for the set_field_definitions API on schemas.
      properties:
        fieldDefinitions:
          items:
            $ref: '#/components/schemas/SchemaFieldDefinitionRef'
          type: array
        schemaId:
          type: string
      type: object
    ScratchFile:
      description: 'A ScratchFile represents raw file content used as intermediate
        input or output of

        pipeline steps (see PipelineStepData). Unlike File, ScratchFiles are not surfaced

        in the Data Catalog because they typically represent transient processing
        artifacts

        rather than standalone valuable data. ScratchFiles track upload state via
        uploadStatus

        and provide uploadUrl/downloadUrl for content transfer. When a ScratchFile
        is

        promoted to user-visible status, it is linked to a File object that appears
        in the

        Data Catalog. The originPipelineStepData field tracks which pipeline step
        produced

        this file.'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        downloadUrl:
          type:
          - 'null'
          - string
        errorMessage:
          type:
          - 'null'
          - string
        externalFileId:
          type:
          - 'null'
          - string
        file:
          oneOf:
          - $ref: '#/components/schemas/FileRef'
          - type: 'null'
        filename:
          type: string
        id:
          type: string
        mimeType:
          type:
          - 'null'
          - string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        originPipelineStepData:
          oneOf:
          - $ref: '#/components/schemas/PipelineStepDataRef'
          - type: 'null'
        size:
          type:
          - 'null'
          - integer
        uploadStatus:
          enum:
          - SUCCEEDED
          - FAILED_VALIDATION
          - IN_PROGRESS
          - NOT_UPLOADED
          type: string
        uploadUrl:
          type:
          - 'null'
          - string
      type: object
    ScratchFilePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ScratchFile'
          type: array
        nextToken:
          type: string
      type: object
    ScratchFileRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ScratchPlate:
      description: 'A plate design or record used for designing, tracking, and analyzing
        experimental plates

        outside of the inventory.


        Scratch plates are the working surface for plate-based workflows: you build
        up

        a plate''s layout (well roles, contents, concentrations, metadata, measurements)

        through one or more creates and updates, then optionally convert it to a

        persistent inventory plate via the `bulk-put-in-inventory` endpoint.


        Each layer of data (label, content, concentration, metadata, measurements,
        etc.)

        is accessible via its `dataFrame`.


        These endpoints are not generally available and may fail depending on your
        tenant configuration.'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        height:
          type: integer
        id:
          type: string
        layers:
          items:
            $ref: '#/components/schemas/ScratchPlateLayer'
          type: array
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        plateSchema:
          description: The plate schema associated with this scratch plate. Used as
            the default schema when converting to an inventory plate via `bulk-put-in-inventory`;
            can be overridden per-item in that call.
          oneOf:
          - $ref: '#/components/schemas/PlateSchemaRef'
          - type: 'null'
        width:
          type: integer
      type: object
    ScratchPlateLayer:
      description: A named layer within a `ScratchPlate`, each backed by its own `DataFrame`.
      properties:
        __typename:
          type: string
        dataFrame:
          $ref: '#/components/schemas/DataFrameRef'
          description: The DataFrame holding this layer's per-well data.
        name:
          type: string
      type: object
    ScratchPlateMeasurementInput:
      additionalProperties: false
      properties:
        analyticalMethod:
          type: string
        columnIndex:
          type: integer
        detectionType:
          type: string
        measurementConcept:
          type: string
        measurementIdentifier:
          type: string
        measurementName:
          type: string
        measurementUnit:
          type: string
        measurementValue:
          type: number
        rowIndex:
          type: integer
      required:
      - rowIndex
      - columnIndex
      type: object
    ScratchPlatePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ScratchPlate'
          type: array
        nextToken:
          type: string
      type: object
    ScratchPlatePlateReaderAsmInput:
      additionalProperties: false
      properties:
        scratchFileId:
          type: string
      required:
      - scratchFileId
      type: object
    ScratchPlateRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    ScratchPlateTransferInput:
      additionalProperties: false
      properties:
        direction:
          description: Well traversal order for layout-based transfers. Defaults to
            ACROSS_ROWS.
          enum:
          - ACROSS_ROWS
          - DOWN_COLUMNS
          type: string
        layout:
          description: 'Layout algorithm used with sourcePlateIds. Determines the
            fan ratio of sources to destinations: STAMP (1:1), STAMP_TO_QUADRANTS/INTERLEAVE
            (4:1), COLUMN_INTERLEAVE (2:1), and their REVERSE_ variants (1:4, 1:2).'
          enum:
          - COLUMN_INTERLEAVE
          - INTERLEAVE
          - REVERSE_COLUMN_INTERLEAVE
          - REVERSE_INTERLEAVE
          - REVERSE_STAMP_TO_QUADRANTS
          - STAMP
          - STAMP_TO_QUADRANTS
          type: string
        operations:
          description: Explicit well-to-well moves. Use this mode for fan-in, many-to-many,
            or serial dilution transfers. Mutually exclusive with sourcePlateIds +
            layout.
          items:
            $ref: '#/components/schemas/WellTransferInput'
          type: array
        skipEmpty:
          description: If true (default), empty source wells are skipped rather than
            producing empty destination wells in layout-based transfers.
          type: boolean
        sourcePlateIds:
          description: Ordered source plates for layout-based transfers. Consumed
            group by group according to the fan ratio of the chosen layout. Mutually
            exclusive with operations.
          items:
            type: string
          type: array
        transferQuantity:
          $ref: '#/components/schemas/QuantityInput'
          description: Volume to transfer per well in layout-based transfers. If omitted,
            the entire source well content is recorded as transferred.
      type: object
    ScratchPlateTransferRequestInput:
      additionalProperties: false
      properties:
        height:
          description: Number of rows in each destination scratch plate.
          type: integer
        metadataLayers:
          description: Metadata layers to apply to each created destination scratch
            plate.
          items:
            $ref: '#/components/schemas/MetadataColumnInput'
          type: array
        name:
          description: Base name for destination scratch plate(s). If multiple are
            created, numeric suffixes are appended.
          type: string
        plateSchemaId:
          description: ID of the plate schema to apply to each destination scratch
            plate. If omitted, no plate schema is attached.
          type: string
        transfer:
          $ref: '#/components/schemas/ScratchPlateTransferInput'
          description: Transfer specification describing explicit operations or a
            layout-derived transfer.
        width:
          description: Number of columns in each destination scratch plate.
          type: integer
      required:
      - name
      - height
      - width
      - transfer
      type: object
    ScratchPlateVendorFileInput:
      additionalProperties: false
      properties:
        scratchFileId:
          type: string
        vendor:
          type: string
      required:
      - scratchFileId
      - vendor
      type: object
    ScratchPlateWellInput:
      additionalProperties: false
      properties:
        columnIndex:
          type: integer
        roles:
          items:
            $ref: '#/components/schemas/WellRoleInput'
          type: array
        rowIndex:
          type: integer
        sampleSchemaId:
          type: string
        schemaTags:
          additionalProperties:
            $ref: '#/components/schemas/AnyType'
          type: object
        wellVolumeAmount:
          type: number
        wellVolumeUnitId:
          type: string
        wellVolumeUnitVersionNumber:
          type: integer
      required:
      - rowIndex
      - columnIndex
      type: object
    SearchInputMultiValueUiBlock:
      description: A multi-select search input block for selecting multiple Benchling
        entities.
      properties:
        __typename:
          type: string
        enabled:
          type:
          - 'null'
          - boolean
        id:
          type: string
        itemType:
          enum:
          - DNA_SEQUENCE
          - DNA_OLIGO
          - AA_SEQUENCE
          - CUSTOM_ENTITY
          - MIXTURE
          - BOX
          - CONTAINER
          - LOCATION
          - PLATE
          - WORKLIST
          type: string
        label:
          type:
          - 'null'
          - string
        placeholder:
          type:
          - 'null'
          - string
        required:
          type:
          - 'null'
          - boolean
        schemaId:
          type:
          - 'null'
          - string
        value:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
      type: object
    SearchInputMultiValueUiBlockInput:
      additionalProperties: false
      properties:
        enabled:
          type: boolean
        id:
          type: string
        itemType:
          enum:
          - DNA_SEQUENCE
          - DNA_OLIGO
          - AA_SEQUENCE
          - CUSTOM_ENTITY
          - MIXTURE
          - BOX
          - CONTAINER
          - LOCATION
          - PLATE
          - WORKLIST
          type: string
        label:
          type: string
        placeholder:
          type: string
        required:
          type: boolean
        schemaId:
          type: string
        type:
          enum:
          - SEARCH_INPUT_MULTIVALUE
          type: string
        value:
          items:
            type: string
          type: array
      required:
      - type
      - id
      - itemType
      type: object
    SearchInputUiBlock:
      description: A search input block for selecting a single Benchling entity.
      properties:
        __typename:
          type: string
        enabled:
          type:
          - 'null'
          - boolean
        id:
          type: string
        itemType:
          enum:
          - DNA_SEQUENCE
          - DNA_OLIGO
          - AA_SEQUENCE
          - CUSTOM_ENTITY
          - MIXTURE
          - BOX
          - CONTAINER
          - LOCATION
          - PLATE
          - WORKLIST
          type: string
        label:
          type:
          - 'null'
          - string
        placeholder:
          type:
          - 'null'
          - string
        required:
          type:
          - 'null'
          - boolean
        schemaId:
          type:
          - 'null'
          - string
        value:
          type:
          - 'null'
          - string
      type: object
    SearchInputUiBlockInput:
      additionalProperties: false
      properties:
        enabled:
          type: boolean
        id:
          type: string
        itemType:
          enum:
          - DNA_SEQUENCE
          - DNA_OLIGO
          - AA_SEQUENCE
          - CUSTOM_ENTITY
          - MIXTURE
          - BOX
          - CONTAINER
          - LOCATION
          - PLATE
          - WORKLIST
          type: string
        label:
          type: string
        placeholder:
          type: string
        required:
          type: boolean
        schemaId:
          type: string
        type:
          enum:
          - SEARCH_INPUT
          type: string
        value:
          type: string
      required:
      - type
      - id
      - itemType
      type: object
    SectionContentInput:
      additionalProperties: false
      properties:
        contentType:
          enum:
          - section
          type: string
        date:
          format: date
          type: string
        title:
          type: string
      required:
      - contentType
      type: object
    SectionDocumentContent:
      description: 'Represents a section divider within notebook or document content.

        Sections can include a title, date, and color to group related document parts.'
      properties:
        __typename:
          type: string
        color:
          enum:
          - DEFAULT
          - RED
          - ORANGE
          - YELLOW
          - GREEN
          - BLUE
          - INDIGO
          - VIOLET
          - CONTRAST_GREY
          - CONTRAST_RED
          - CONTRAST_ORANGE
          - CONTRAST_YELLOW
          - CONTRAST_GREEN
          - CONTRAST_BLUE
          - CONTRAST_INDIGO
          - CONTRAST_VIOLET
          - null
          type:
          - 'null'
          - string
        date:
          format: date
          type:
          - 'null'
          - string
        title:
          type:
          - 'null'
          - string
      type: object
    SectionUiBlock:
      description: A section block that groups child blocks together. Children are
        leaf blocks only.
      properties:
        __typename:
          type: string
        children:
          items:
            anyOf:
            - $ref: '#/components/schemas/ButtonUiBlock'
            - $ref: '#/components/schemas/ChipUiBlock'
            - $ref: '#/components/schemas/DropdownUiBlock'
            - $ref: '#/components/schemas/DropdownMultiValueUiBlock'
            - $ref: '#/components/schemas/FileUploadUiBlock'
            - $ref: '#/components/schemas/MarkdownUiBlock'
            - $ref: '#/components/schemas/SearchInputUiBlock'
            - $ref: '#/components/schemas/SearchInputMultiValueUiBlock'
            - $ref: '#/components/schemas/SelectorInputUiBlock'
            - $ref: '#/components/schemas/SelectorInputMultiValueUiBlock'
            - $ref: '#/components/schemas/TextInputUiBlock'
            description: Union of ButtonUiBlock, ChipUiBlock, DropdownUiBlock, DropdownMultiValueUiBlock,
              FileUploadUiBlock, MarkdownUiBlock, SearchInputUiBlock, SearchInputMultiValueUiBlock,
              SelectorInputUiBlock, SelectorInputMultiValueUiBlock, TextInputUiBlock
            discriminator:
              propertyName: __typename
          type: array
        id:
          type: string
      type: object
    SectionUiBlockInput:
      additionalProperties: false
      properties:
        children:
          items:
            $ref: '#/components/schemas/UiBlockLeafNodeInput'
          type: array
        id:
          type: string
        type:
          enum:
          - SECTION
          type: string
      required:
      - type
      - id
      - children
      type: object
    SecureTextAppConfigSpec:
      description: 'Specifies that an app configuration field should accept secure
        (encrypted) text.

        Used for sensitive data like API keys or credentials.'
      properties:
        __typename:
          type: string
        requiredConfig:
          type:
          - 'null'
          - boolean
      type: object
    SecureTextAppConfigValue:
      description: 'Stores a secure (encrypted) text value in an app configuration
        field.

        Used for sensitive data like API keys or credentials.'
      properties:
        __typename:
          type: string
        value:
          type:
          - 'null'
          - string
      type: object
    SelectorInput:
      additionalProperties: false
      properties:
        delete:
          type: boolean
        name:
          type: string
        options:
          items:
            type: string
          type: array
        selectorId:
          type: string
      type: object
    SelectorInputMultiValueUiBlock:
      description: A multi-select selector input block with predefined options.
      properties:
        __typename:
          type: string
        enabled:
          type:
          - 'null'
          - boolean
        id:
          type: string
        label:
          type:
          - 'null'
          - string
        options:
          items:
            type: string
          type: array
        placeholder:
          type:
          - 'null'
          - string
        required:
          type:
          - 'null'
          - boolean
        value:
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
      type: object
    SelectorInputMultiValueUiBlockInput:
      additionalProperties: false
      properties:
        enabled:
          type: boolean
        id:
          type: string
        label:
          type: string
        options:
          items:
            type: string
          type: array
        placeholder:
          type: string
        required:
          type: boolean
        type:
          enum:
          - SELECTOR_INPUT_MULTIVALUE
          type: string
        value:
          items:
            type: string
          type: array
      required:
      - type
      - id
      - options
      type: object
    SelectorInputUiBlock:
      description: A selector input block with predefined options.
      properties:
        __typename:
          type: string
        enabled:
          type:
          - 'null'
          - boolean
        id:
          type: string
        label:
          type:
          - 'null'
          - string
        options:
          items:
            type: string
          type: array
        placeholder:
          type:
          - 'null'
          - string
        required:
          type:
          - 'null'
          - boolean
        value:
          type:
          - 'null'
          - string
      type: object
    SelectorInputUiBlockInput:
      additionalProperties: false
      properties:
        enabled:
          type: boolean
        id:
          type: string
        label:
          type: string
        options:
          items:
            type: string
          type: array
        placeholder:
          type: string
        required:
          type: boolean
        type:
          enum:
          - SELECTOR_INPUT
          type: string
        value:
          type: string
      required:
      - type
      - id
      - options
      type: object
    ServicePrincipal:
      description: 'Represents a non-human identity used for system integrations and
        automated processes

        within Benchling. Service principals act as the identity for service accounts
        that

        perform actions via APIs or background processes without human intervention.
        Unlike

        `User`, which represents a human user, ServicePrincipal is used when an integration

        or automated system needs to be attributed as the actor for auditing and attribution

        purposes. Service principals implement the Principal interface, allowing them
        to

        appear as creators or actors on domain objects. Also known as "service account"
        in

        some contexts.'
      properties:
        __typename:
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type:
          - 'null'
          - string
      type: object
    ServicePrincipalPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ServicePrincipal'
          type: array
        nextToken:
          type: string
      type: object
    SingleTransferInput:
      additionalProperties: false
      properties:
        destinationContainerId:
          type: string
        finalQuantity:
          $ref: '#/components/schemas/MeasurementInput'
        sourceConcentration:
          $ref: '#/components/schemas/MeasurementInput'
        sourceContainerId:
          type:
          - 'null'
          - string
        sourceEntityId:
          type:
          - 'null'
          - string
        transferQuantity:
          $ref: '#/components/schemas/MeasurementInput'
      required:
      - destinationContainerId
      - transferQuantity
      type: object
    SplitTransform:
      description: 'A data transform that divides values in a single column into multiple
        output columns

        by splitting on a delimiter.'
      properties:
        __typename:
          type: string
        transformationProperties:
          description: Additional parameters for this transform
          oneOf:
          - $ref: '#/components/schemas/SplitTransformationProperties'
          - type: 'null'
        type:
          description: The type of this transform
          enum:
          - ADD_COLUMN
          - ARITHMETIC
          - CUSTOM
          - DUPLICATE
          - EXTRA_HEADERS
          - EXTRA_FOOTERS
          - FILTER
          - FIND_REPLACE
          - MERGE
          - MELT
          - PLATE_SHAPE
          - PIVOT
          - REMOVE_QUOTES
          - SPLIT
          - null
          type:
          - 'null'
          - string
      type: object
    SplitTransformationProperties:
      description: 'Properties for a SPLIT transform, specifying the column to split,
        the delimiter to

        split on, and the names for the resulting output columns.'
      properties:
        __typename:
          type: string
        column:
          description: Name of column to be split
          type:
          - 'null'
          - string
        delimiter:
          description: Delimiter on which to split column values
          type:
          - 'null'
          - string
        outputColumnNames:
          description: Names of columns in which to put the split values
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
      type: object
    SqlDashboard:
      description: 'A SqlDashboard is a configurable analytics page that displays
        one or more SQL-driven

        visualizations within Benchling Insights. Dashboards belong to a Project and
        contain

        ordered blocks (see SqlDashboardBlock), each with its own SQL query and chart
        or table

        visualization. Dashboards support parameterConfigs (see SqlParameterConfig)
        that allow

        users to filter data dynamically through dropdowns, date pickers, or entity
        selectors.

        SQL Dashboards query Benchling''s data warehouse.'
      properties:
        __typename:
          type: string
        blocks:
          format: uri
          type: string
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        description:
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        project:
          $ref: '#/components/schemas/ProjectRef'
      type: object
    SqlDashboardBlock:
      description: 'Represents a single query and visualization pane within a SqlDashboard.
        Each block

        contains a SQL query (sqlQuery) that runs against the Benchling data warehouse,
        along

        with a BlockVisualization that defines how the query results are displayed
        (as a chart,

        table, heatmap, etc.). Blocks are ordered by index within their parent dashboard
        and

        have a name and description for identification. SQL Dashboard Blocks enable
        users to

        build interactive analytics dashboards by combining multiple query-driven
        visualizations

        on a single page.'
      properties:
        __typename:
          type: string
        description:
          type: string
        id:
          type: string
        index:
          type: integer
        name:
          type: string
        sqlQuery:
          type: string
      type: object
    SqlDashboardBlockPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/SqlDashboardBlock'
          type: array
        nextToken:
          type: string
      type: object
    SqlDashboardBlockUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/SqlDashboardBlock'
          type: array
      type: object
    SqlDashboardPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/SqlDashboard'
          type: array
        nextToken:
          type: string
      type: object
    StageEntry:
      description: 'A StageEntry is an Entry that is associated with a specific stage
        in a legacy Workflow. Unlike regular Entries

        which exist independently in folders, StageEntries are created as part of
        workflow execution and contain the

        documentation for that stage''s work. Each StageEntry belongs to a WorkflowStage
        and may contain multiple

        StageRuns representing individual sample processing. StageEntries support
        the same content types and review

        workflows as regular Entries but are not directly archivable (their lifecycle
        is tied to the workflow). They

        can be created from an `EntryTemplate` configured for the stage.'
      properties:
        __typename:
          type: string
        applicableReviewProcesses:
          description: 'The review processes configured for this entry''s project.
            Use the paginated

            `/applicable-review-processes/items` sub-resource to retrieve the full
            list of

            ReviewProcess objects including their stages and version details.'
          format: uri
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        authors:
          description: 'Array of User Resources of the authors of the entry. This
            defaults to

            the creator but can be manually changed.'
          oneOf:
          - format: uri
            type: string
          - type: 'null'
        createdAt:
          description: DateTime the entry was created at
          format: datetime
          type:
          - 'null'
          - string
        creator:
          description: User Resource of the user who created the entry
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        customFields:
          oneOf:
          - items:
              $ref: '#/components/schemas/CustomField'
            type: array
          - type: 'null'
        displayId:
          description: User-friendly ID of the entry
          type:
          - 'null'
          - string
        folder:
          description: ID of the folder that contains the entry
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        id:
          description: ID of the entry
          type: string
        modifiedAt:
          description: DateTime the entry was last modified
          format: datetime
          type:
          - 'null'
          - string
        name:
          description: Title of the entry
          type:
          - 'null'
          - string
        review:
          description: 'The active review for this entry, if one exists. Returns a
            Review object with status,

            reviewers, review process, and review history. Null when the entry has
            not been sent

            for review or the review has been retracted.'
          oneOf:
          - $ref: '#/components/schemas/ReviewRef'
          - type: 'null'
        reviewSource:
          $ref: '#/components/schemas/ProjectRef'
          description: The project that this entry belongs to, used to determine which
            review processes apply.
        schema:
          description: Entry schema if set
          oneOf:
          - $ref: '#/components/schemas/EntrySchemaRef'
          - type: 'null'
        schemaFields:
          oneOf:
          - items:
              $ref: '#/components/schemas/SchemaFieldValue'
            type: array
          - type: 'null'
      type: object
    StageEntryPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/StageEntry'
          type: array
        nextToken:
          type: string
      type: object
    StandardReactionComponent:
      description: Generic type for most reaction components
      properties:
        __typename:
          type: string
        amountActual:
          format: decimal
          type:
          - 'null'
          - string
        amountPlan:
          format: decimal
          type:
          - 'null'
          - string
        amountUnit:
          oneOf:
          - $ref: '#/components/schemas/UnitRef'
          - type: 'null'
        calculationBase:
          enum:
          - MOL_EQUIVALENT
          - MOL_PLAN
          - AMOUNT_PLAN
          - null
          type:
          - 'null'
          - string
        concentration:
          format: decimal
          type:
          - 'null'
          - string
        concentrationUnit:
          oneOf:
          - $ref: '#/components/schemas/UnitRef'
          - type: 'null'
        linkedLot:
          oneOf:
          - $ref: '#/components/schemas/CustomEntityRef'
          - type: 'null'
        linkedMolecule:
          description: Union of InternalLinkedMolecule, ExternalLinkedMolecule
          oneOf:
          - anyOf:
            - $ref: '#/components/schemas/InternalLinkedMolecule'
            - $ref: '#/components/schemas/ExternalLinkedMolecule'
            discriminator:
              propertyName: __typename
          - type: 'null'
        molActual:
          format: decimal
          type:
          - 'null'
          - string
        molEquivalent:
          format: decimal
          type:
          - 'null'
          - string
        molPlan:
          format: decimal
          type:
          - 'null'
          - string
        molUnit:
          oneOf:
          - $ref: '#/components/schemas/UnitRef'
          - type: 'null'
        purity:
          format: decimal
          type:
          - 'null'
          - string
        role:
          enum:
          - REACTANT
          - PRODUCT
          - REAGENT
          - BYPRODUCT
          - SOLVENT
          - CATALYST
          type: string
      type: object
    StorableLinkFieldDefinition:
      description: A schema field definition for linking to storable inventory items.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    StringCellEvaluationValue:
      description: A string evaluation value.
      properties:
        __typename:
          type: string
        value:
          type: string
      type: object
    StringValueFilterTransformationProperties:
      description: 'Properties for a FILTER transform that filters rows by comparing
        a column''s string

        value using equality or inequality.'
      properties:
        __typename:
          type: string
        column:
          description: Name of column to be filtered
          type:
          - 'null'
          - string
        type:
          description: Type of filtering to perform (EQ or NE)
          enum:
          - LT
          - LE
          - GE
          - GT
          - EQ
          - NE
          - ISIN
          - NOTIN
          - ISNULL
          - NOTNULL
          - null
          type:
          - 'null'
          - string
        value:
          description: Value to filter on
          type:
          - 'null'
          - string
      type: object
    Study:
      description: 'A structured unit used to plan and organize research in Benchling.

        Each study progresses through phases (see `StudyPhase`) sequentially from
        design to execution to completion.

        The current phase determines what modifications are permitted on the study
        and its associated data.'
      properties:
        __typename:
          type: string
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        authors:
          oneOf:
          - format: uri
            type: string
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        description:
          type:
          - 'null'
          - string
        designEntry:
          oneOf:
          - $ref: '#/components/schemas/EntryRef'
          - type: 'null'
        displayId:
          type:
          - 'null'
          - string
        folder:
          $ref: '#/components/schemas/FolderRef'
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        phase:
          enum:
          - DESIGN
          - EXECUTION
          - COMPLETE
          - null
          type:
          - 'null'
          - string
        schema:
          oneOf:
          - $ref: '#/components/schemas/StudySchemaRef'
          - type: 'null'
        schemaFields:
          oneOf:
          - items:
              $ref: '#/components/schemas/SchemaFieldValue'
            type: array
          - type: 'null'
        studySchema:
          $ref: '#/components/schemas/StudySchemaRef'
          deprecated: true
          description: Use schema instead. The schema of the study.
      type: object
    StudyItemAssociation:
      description: 'Represents the link between a Study and a Studyable item (such
        as entities or molecules).

        Each association is identified by id and links a specific `study` to a specific
        `item`, and records

        when the link was created via `createdAt` and who created it via `creator`.'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        id:
          type: string
        item:
          $ref: '#/components/schemas/StudyableRef'
        study:
          $ref: '#/components/schemas/StudyRef'
      type: object
    StudyItemAssociationPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/StudyItemAssociation'
          type: array
        nextToken:
          type: string
      type: object
    StudyPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Study'
          type: array
        nextToken:
          type: string
      type: object
    StudyRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    StudySchema:
      description: 'A configuration template that defines the structure and behavior
        of Studies within an organization. Each

        `StudySchema` specifies the `studyType`, which determines available features
        and workflow capabilities.

        Schemas define custom fields through `fieldDefinitions` that studies of this
        type must populate. The

        `isDesignApprovalRequired` flag controls whether study designs must go through
        a review process before

        execution. Associated `entryTemplates` provide standardized notebook templates
        for documenting study work.

        Studies reference their schema via `Study.studySchema`.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        description:
          description: A description of this study schema for documentation purposes.
          type: string
        entryTemplates:
          format: uri
          type: string
        fieldDefinitions:
          format: uri
          type: string
        id:
          type: string
        idGenerationMode:
          description: How Study IDs are assigned for studies of this schema.
          enum:
          - AUTO_GENERATED_FROM_PREFIX
          - MANUAL
          type: string
        isDesignApprovalRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        organization:
          $ref: '#/components/schemas/OrganizationRef'
        prefix:
          type:
          - 'null'
          - string
        studyType:
          enum:
          - CUSTOM
          - PROCESS_DEVELOPMENT
          - ASSAY_DEVELOPMENT
          - CLINICAL
          - PRECLINICAL
          type: string
      type: object
    StudySchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/StudySchema'
          type: array
        nextToken:
          type: string
      type: object
    StudySchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    StudyableRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    SystemCategoryConfiguration:
      anyOf:
      - $ref: '#/components/schemas/BaseSystemCategoryConfiguration'
      discriminator:
        propertyName: __typename
      type: object
    SystemCategoryConfigurationInputBase:
      allOf:
      - properties:
          systemCategoryId:
            enum:
            - ssi_aachain
            - ssi_aadomain
            - ssi_aapair
            - ssi_aasubelement
            - ssi_antigen
            - ssi_dnachain
            - ssi_dnadomain
            - ssi_dnapair
            - ssi_dnasubelement
            type: string
        required:
        - systemCategoryId
      - oneOf:
        - $ref: '#/components/schemas/AaChainConfigurationInput'
        - $ref: '#/components/schemas/AaDomainConfigurationInput'
        - $ref: '#/components/schemas/AaPairConfigurationInput'
        - $ref: '#/components/schemas/AaSubElementConfigurationInput'
        - $ref: '#/components/schemas/AntigenConfigurationInput'
        - $ref: '#/components/schemas/DnaChainConfigurationInput'
        - $ref: '#/components/schemas/DnaDomainConfigurationInput'
        - $ref: '#/components/schemas/DnaPairConfigurationInput'
        - $ref: '#/components/schemas/DnaSubElementConfigurationInput'
      discriminator:
        propertyName: systemCategoryId
      type: object
    SystemCategoryLinkFieldDefinition:
      description: A schema field definition for linking to entities that implement
        a system category (static schema interface).
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    TableCell:
      description: 'A cell within a table row. Each cell is one of three variants:

        - A normal value cell (inputValue is set, mergeRangeParent is null)

        - A merge anchor cell (inputValue is set, mergeRange describes the span)

        - A merge child cell (mergeRangeParent points to the anchor, inputValue is
        an empty TextValue)'
      properties:
        __typename:
          type: string
        errors:
          description: 'Evaluation and validation errors present on the cell. Empty
            when the cell has no errors.

            Inspect `errorType` on each entry to distinguish evaluation failures from
            validation failures.'
          items:
            $ref: '#/components/schemas/CellError'
          type: array
        evaluationValue:
          description: Typed evaluation value computed by the evaluation pipeline.
            Read-only.
          oneOf:
          - anyOf:
            - $ref: '#/components/schemas/StringCellEvaluationValue'
            - $ref: '#/components/schemas/NumberCellEvaluationValue'
            - $ref: '#/components/schemas/BooleanCellEvaluationValue'
            - $ref: '#/components/schemas/DateCellEvaluationValue'
            - $ref: '#/components/schemas/DateTimeCellEvaluationValue'
            - $ref: '#/components/schemas/EntityLinkCellEvaluationValue'
            - $ref: '#/components/schemas/ArrayCellEvaluationValue'
            - $ref: '#/components/schemas/UnsupportedCellEvaluationValue'
            discriminator:
              propertyName: __typename
          - type: 'null'
        format:
          description: Formatting properties applied to the cell. Null when no formatting
            is applied.
          oneOf:
          - $ref: '#/components/schemas/TableCellFormat'
          - type: 'null'
        inputValue:
          anyOf:
          - $ref: '#/components/schemas/BooleanValue'
          - $ref: '#/components/schemas/DateTimeValue'
          - $ref: '#/components/schemas/DateValue'
          - $ref: '#/components/schemas/DecimalValue'
          - $ref: '#/components/schemas/IntegerValue'
          - $ref: '#/components/schemas/JsonValue'
          - $ref: '#/components/schemas/ObjectLinkValue'
          - $ref: '#/components/schemas/ObjectLinkListValue'
          - $ref: '#/components/schemas/TextAndUrlValue'
          - $ref: '#/components/schemas/TextValue'
          - $ref: '#/components/schemas/ArrayValue'
          description: The cell's input value. For unstructured tables this is always
            a TextValue.
          discriminator:
            propertyName: __typename
        mergeRange:
          description: Set only on merge anchor cells. Describes the span of the merged
            region.
          oneOf:
          - $ref: '#/components/schemas/TableMergeRange'
          - type: 'null'
        mergeRangeParent:
          description: Set only on merge child cells. Points to the anchor cell of
            the merged region.
          oneOf:
          - $ref: '#/components/schemas/MergedCellAnchor'
          - type: 'null'
        selectorId:
          description: 'Id of the dropdown selector for this cell, if any.

            Resolve against `selectors` on the container by matching this value to
            `TableCellSelector.selectorId`.'
          type:
          - 'null'
          - string
      type: object
    TableCellFormat:
      description: Formatting properties applied to an entire cell.
      properties:
        __typename:
          type: string
        alignment:
          enum:
          - LEFT
          - CENTER
          - RIGHT
          - null
          type:
          - 'null'
          - string
        backgroundColor:
          type:
          - 'null'
          - string
        foregroundColor:
          type:
          - 'null'
          - string
        link:
          type:
          - 'null'
          - string
        properties:
          items:
            enum:
            - BOLD
            - ITALIC
            - UNDERLINE
            - STRIKETHROUGH
            - IMPORTANT
            type: string
          type: array
      type: object
    TableCellSelector:
      description: A predefined dropdown selector that can be assigned to table cells.
      properties:
        __typename:
          type: string
        name:
          type: string
        options:
          items:
            type: string
          type: array
        selectorId:
          description: Identifier for this selector within the container. Matches
            `TableCell.selectorId`.
          type: string
      type: object
    TableColumnDefinition:
      description: A column definition within a table, specifying the label and optional
        width.
      properties:
        __typename:
          type: string
        isLocked:
          type: boolean
        name:
          type: string
        width:
          description: Column width in pixels. Default is 100.
          type:
          - 'null'
          - number
      type: object
    TableMergeRange:
      description: Describes the extent of a merged cell region, set on the anchor
        cell.
      properties:
        __typename:
          type: string
        mergeColSpan:
          description: Number of columns in the merged span (including the anchor).
          type: integer
        mergeRowSpan:
          description: Number of rows in the merged span (including the anchor).
          type: integer
      type: object
    TableRow:
      description: A row within a table, containing an ordered array of cells.
      properties:
        __typename:
          type: string
        cells:
          items:
            $ref: '#/components/schemas/TableCell'
          type: array
        rowIndex:
          description: The row's absolute position within the table (0-based).
          type: integer
      type: object
    TableUiBlock:
      description: A table block that displays tabular data from a dataset or data
        frame.
      properties:
        __typename:
          type: string
        dataFrameId:
          type: string
        enabled:
          type:
          - 'null'
          - boolean
        id:
          type: string
        name:
          type: string
      type: object
    TableUiBlockInput:
      additionalProperties: false
      properties:
        dataFrameId:
          description: Data frame ID backing the table.
          type: string
        enabled:
          type: boolean
        id:
          type: string
        name:
          type: string
        type:
          enum:
          - TABLE
          type: string
      required:
      - type
      - id
      - name
      - dataFrameId
      type: object
    TaskTransitionExtension:
      description: 'Records a status change event on a method task during procedure
        execution. Captures the

        comment provided, the human-readable status name, and the timestamp when the
        transition

        occurred. Used to track the history of task state changes.'
      properties:
        __typename:
          type: string
        comment:
          type: string
        statusDisplayName:
          type: string
        timestampUtcIsoformat:
          type: string
      type: object
    Team:
      description: 'Represents a subgroup of users within an `Organization`, enabling
        finer-grained user

        management and data sharing. Teams belong to exactly one organization, and
        users may

        only join a team if they are already members of that team''s parent organization.
        Each

        team member has either ADMIN or MEMBER role (see `GroupMembership`): admins
        can manage

        team membership, while members receive standard access. Unlike Organizations,
        teams

        cannot directly own Projects or Folders—they are used for collaboration and
        access

        control purposes. Teams can be configured with `provisionedCapabilities` to
        grant

        specific Benchling capabilities to members upon joining. The `membersAreAdministratorsOfSchemas`

        flag controls whether team members can create and modify certain schema types.'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type: string
        description:
          type: string
        id:
          type: string
        membersAreAdministratorsOfSchemas:
          description: 'Indicates that members of the team are able to create and
            modify schemas that do not implement the

            Collaboratable interface.'
          type: boolean
        memberships:
          format: uri
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        organization:
          $ref: '#/components/schemas/OrganizationRef'
      type: object
    TeamPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Team'
          type: array
        nextToken:
          type: string
      type: object
    TeamRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    TemplateCollectible:
      anyOf:
      - $ref: '#/components/schemas/AnalysisTemplate'
      - $ref: '#/components/schemas/EntrySubtemplate'
      - $ref: '#/components/schemas/EntryTemplate'
      - $ref: '#/components/schemas/PlateDesignTemplate'
      - $ref: '#/components/schemas/Procedure'
      - $ref: '#/components/schemas/RequestV2Definition'
      discriminator:
        propertyName: __typename
      type: object
    TemplateCollectibleUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/TemplateCollectible'
          type: array
      type: object
    TemplateCollection:
      description: 'A container that organizes related templates, subtemplates, and
        other template-like

        items. Template Collections provide a way to group and manage reusable content
        that

        teams use to create standardized entries. Each collection has an owner (typically
        an

        Organization or Team) and can be shared with others through access controls
        (see

        `Collaboration`). Collections can contain `EntryTemplate`s for creating new
        entries,

        `EntrySubtemplate`s for inserting content, form definitions, procedures, and
        analysis

        templates. In the Benchling UI, these appear in the "Template Collections"
        section.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          description: DateTime the template collection was created at
          format: datetime
          type:
          - 'null'
          - string
        description:
          description: Description of the template collection
          type:
          - 'null'
          - string
        id:
          description: ID of the template collection
          type: string
        items:
          description: All items that exist in the template collection
          oneOf:
          - format: uri
            type: string
          - type: 'null'
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          description: Title of the template collection
          type:
          - 'null'
          - string
        owner:
          description: Owner of the template collection
          oneOf:
          - $ref: '#/components/schemas/OwnerRef'
          - type: 'null'
      type: object
    TemplateCollectionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/TemplateCollection'
          type: array
        nextToken:
          type: string
      type: object
    TemplateCollectionRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    TestDefinition:
      description: 'A Test Definition is a configuration object that specifies a type
        of test or assay that can be

        ordered against samples. Each Test Definition is associated with a `ResultSchema`
        that defines

        the structure of measurement data captured when the test is performed. Test
        Definitions serve

        as templates—when a test needs to be performed on a sample, a `TestOrder`
        is created referencing

        the appropriate Test Definition. Test Definitions are used within clinical
        and preclinical study

        workflows (see `StudySampleTestPlan`) and can be linked to `Procedure` assays
        for execution.

        Belongs to an `Organization` and can be archived when no longer needed.'
      properties:
        __typename:
          type: string
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        createdAt:
          description: Timestamp of when the test definition was created.
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
          description: The user that created the test definition.
        description:
          description: The description of the test definition. Empty strings are allowed.
          type: string
        id:
          description: The ID of the test definition.
          type: string
        modifiedAt:
          description: Timestamp of when the test definition was last modified.
          format: datetime
          type: string
        name:
          description: The name of the test definition.
          type: string
        organization:
          $ref: '#/components/schemas/OrganizationRef'
          description: The organization that owns the test definition, used for auth.
        resultSchema:
          $ref: '#/components/schemas/ResultSchemaRef'
          description: The result schema of the test definition, defines the measurement
            data shape.
      type: object
    TestDefinitionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/TestDefinition'
          type: array
        nextToken:
          type: string
      type: object
    TestDefinitionRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    TestOrder:
      description: 'A Test Order represents an individual request to perform a specific
        test on a sample. Each

        Test Order references a `TestDefinition` that specifies what type of test
        to perform, and

        a `sample` (Entity) that is being tested. Test Orders track their lifecycle
        through `status`

        (see `TestStatus`), from PENDING when created, through IN_PROGRESS during
        execution, to

        COMPLETED or other terminal states. When executed via an Assay workflow, the
        `procedure`

        and `procedureMethodExecutionInstance` fields link to the execution context.
        Results are

        captured in the `result` field. Test Orders can be associated with `Study`
        objects for

        clinical/preclinical workflows and linked to specific plate wells via `plateWellAssociations`

        for laboratory execution tracking.'
      properties:
        __typename:
          type: string
        analysisComment:
          description: Additional comments provided for a test order with a status
            of blocked, invalid, or canceled.
          type:
          - 'null'
          - string
        container:
          description: The container associated with the sample being tested in this
            test order
          oneOf:
          - $ref: '#/components/schemas/ContainerRef'
          - type: 'null'
        createdAt:
          description: Timestamp of when the test order was created.
          format: datetime
          type: string
        dilutionFactor:
          description: The dilution factor of the test order.
          type:
          - 'null'
          - integer
        id:
          description: The ID of the test order.
          type: string
        modifiedAt:
          description: Timestamp of when the test order was last modified.
          format: datetime
          type: string
        name:
          description: The name of the test order.
          type: string
        procedure:
          description: 'The Assay (Procedure) for which this Test Order is created.

            Since a Test Definition can be used in multiple Assays, this association
            ensures clarity on which template should be followed for the specific
            Test Order.

            It is necessary to establish this association prior to the Assay Run to
            avoid ambiguity.'
          oneOf:
          - $ref: '#/components/schemas/ProcedureRef'
          - type: 'null'
        procedureMethodExecutionInstance:
          description: 'The execution instance of the procedure method, linking the
            Test Order to the specific Assay Run to

            enable easy retrieval of all related Test Orders.'
          oneOf:
          - $ref: '#/components/schemas/ProcedureMethodExecutionInstanceRef'
          - type: 'null'
        result:
          description: The result of the test order.
          oneOf:
          - $ref: '#/components/schemas/ResultRef'
          - type: 'null'
        sample:
          $ref: '#/components/schemas/EntityRef'
          description: The sample being tested in this test order
        status:
          description: The status of the test order.
          enum:
          - PENDING
          - BLOCKED
          - IN_PROGRESS
          - CANCELLED
          - INVALID
          - COMPLETED
          type: string
        testDefinition:
          $ref: '#/components/schemas/TestDefinitionRef'
          description: The test definition associated with this test order.
      type: object
    TestOrderPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/TestOrder'
          type: array
        nextToken:
          type: string
      type: object
    TextAndUrlValue:
      description: A type that represents text (string) values with an associated
        URL.
      properties:
        __typename:
          type: string
        url:
          description: The URL associated with the value. Please use `TextValue` if
            you don't want a URL.
          type: string
        value:
          description: The text value. It may or may not be an empty string.
          type: string
      type: object
    TextAppConfigSpec:
      description: Specifies that an app configuration field should accept a text
        string.
      properties:
        __typename:
          type: string
        enum:
          description: Optional enum constraint — if present, the value must be one
            of these strings.
          oneOf:
          - items:
              type: string
            type: array
          - type: 'null'
        requiredConfig:
          type:
          - 'null'
          - boolean
      type: object
    TextAppConfigValue:
      description: Stores a text string value in an app configuration field.
      properties:
        __typename:
          type: string
        value:
          type:
          - 'null'
          - string
      type: object
    TextBoxDocumentContent:
      description: 'Represents a fill-in text box within a notebook entry. Text boxes
        are labeled input fields

        that can be added to entry templates to capture specific pieces of information.
        They support

        rich text formatting including bold, italic, links, and mentions. Text boxes
        can optionally

        be submitted/finalized to lock their content.


        The `text` field contains the raw text with mentions represented as zero-width
        positions.

        All position-based fields are indices into this raw text.'
      properties:
        __typename:
          type: string
        formats:
          description: Text formatting applied to ranges within the text. Positions
            are indices into the raw `text` field.
          items:
            $ref: '#/components/schemas/TextFormat'
          type: array
        indentation:
          type: integer
        isSubmittable:
          description: Whether this text box can currently be submitted.
          type: boolean
        links:
          description: Hyperlinks applied to ranges within the text. Positions are
            indices into the raw `text` field.
          items:
            $ref: '#/components/schemas/LinkSpan'
          type: array
        mentions:
          description: Inline mentions of other Benchling items. Each mention's position
            is an index into the raw `text` field.
          items:
            $ref: '#/components/schemas/Mention'
          type: array
        name:
          description: The label/name of the text box.
          type: string
        submissionStatus:
          description: Whether this text box has been submitted, has unsubmitted changes,
            or is unsubmitted.
          enum:
          - UNSUBMITTED
          - SUBMITTED
          - HAS_UNSUBMITTED_CHANGES
          type: string
        text:
          description: The raw text content. Mentions are represented as zero-width
            positions; use the `mentions` field to get the referenced items and their
            positions.
          type: string
      type: object
    TextContentInput:
      additionalProperties: false
      properties:
        contentType:
          enum:
          - text
          type: string
        formats:
          items:
            $ref: '#/components/schemas/TextFormatInput'
          type: array
        indentation:
          type: integer
        links:
          items:
            $ref: '#/components/schemas/LinkSpanInput'
          type: array
        mentions:
          items:
            $ref: '#/components/schemas/MentionInput'
          type: array
        text:
          type: string
      required:
      - contentType
      - text
      type: object
    TextDocumentContent:
      description: 'Represents a paragraph of formatted text content within a notebook
        entry or document.

        TextDocumentContent is the primary way to store narrative text in the electronic
        lab notebook.

        The text can include rich formatting (see `TextFormat` for bold, italic, etc.),
        hyperlinks

        (see `LinkSpan`), and inline mentions of other Benchling items (see `Mention`).
        Multiple

        `TextDocumentContent` blocks form the body of a notebook entry between section
        headers and

        other structured content.'
      properties:
        __typename:
          type: string
        formats:
          items:
            $ref: '#/components/schemas/TextFormat'
          type: array
        indentation:
          type: integer
        links:
          items:
            $ref: '#/components/schemas/LinkSpan'
          type: array
        mentions:
          items:
            $ref: '#/components/schemas/Mention'
          type: array
        text:
          type: string
      type: object
    TextFieldDefinition:
      description: A text field definition for short, single-line text values.
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    TextFormat:
      description: 'A TextFormat applies a set of TextFormatProperties to some range
        within a text.


        Examples here would include font properties like bold, italic or underline
        as well as text color.'
      properties:
        __typename:
          type: string
        backgroundColor:
          type:
          - 'null'
          - string
        end:
          description: The index where we should stop applying a format (exclusive).
          type: integer
        foregroundColor:
          type:
          - 'null'
          - string
        properties:
          description: A span of content can have multiple TextFormatProperty specified.
          items:
            enum:
            - BOLD
            - ITALIC
            - UNDERLINE
            - STRIKETHROUGH
            - SUBSCRIPT
            - SUPERSCRIPT
            - MONOSPACE
            type: string
          type: array
        start:
          description: The index where we should start to apply a format (inclusive).
          type: integer
      type: object
    TextFormatInput:
      additionalProperties: false
      properties:
        backgroundColor:
          type:
          - 'null'
          - string
        end:
          type: integer
        foregroundColor:
          type:
          - 'null'
          - string
        properties:
          items:
            enum:
            - BOLD
            - ITALIC
            - UNDERLINE
            - STRIKETHROUGH
            - SUBSCRIPT
            - SUPERSCRIPT
            - MONOSPACE
            type: string
          type: array
        start:
          type: integer
      type: object
    TextInputUiBlock:
      description: A text input block that accepts freeform user text.
      properties:
        __typename:
          type: string
        enabled:
          type:
          - 'null'
          - boolean
        id:
          type: string
        label:
          type:
          - 'null'
          - string
        placeholder:
          type:
          - 'null'
          - string
        required:
          type:
          - 'null'
          - boolean
        value:
          type:
          - 'null'
          - string
      type: object
    TextInputUiBlockInput:
      additionalProperties: false
      properties:
        enabled:
          type: boolean
        id:
          type: string
        label:
          type: string
        placeholder:
          type: string
        required:
          type: boolean
        type:
          enum:
          - TEXT_INPUT
          type: string
        value:
          type: string
      required:
      - type
      - id
      type: object
    TextNameTemplatePartConfiguration:
      description: Configuration for a literal text name template part.
      properties:
        __typename:
          type: string
        text:
          type: string
      type: object
    TextNameTemplatePartConfigurationInput:
      additionalProperties: false
      properties:
        text:
          type: string
      required:
      - text
      type: object
    TextValue:
      description: A type that represents text (string) values.
      properties:
        __typename:
          type: string
        value:
          description: The text value. It may or may not be an empty string.
          type: string
      type: object
    Transcription:
      description: 'Represents a transcribed region on a DNA sequence that produces
        an RNA product. Transcriptions

        link a region of a DnaSequence to the corresponding RnaSequence entity, enabling
        traceability

        between DNA templates and their RNA transcripts. The position range (start/end)
        defines

        where transcription begins and ends on the DNA template, while strand indicates
        the

        transcribed strand direction. This feature is derived from schema field relationships

        rather than being directly editable as an annotation.'
      properties:
        __typename:
          type: string
        end:
          description: '0-based exclusive end index. For ranges ending at the end
            of a circular sequence, this value is

            always the length of the sequence, never 0.'
          type: integer
        rnaSequence:
          $ref: '#/components/schemas/RnaSequenceRef'
          description: RNA sequence this transcription refers to.
        start:
          description: 0-based inclusive start index.
          type: integer
        strand:
          description: Strand for this transcription; 1 for forward strand, -1 for
            reverse strand.
          type: integer
      type: object
    TranscriptionLinkFieldDefinition:
      description: A schema field definition for linking to transcriptions (RNA sequences
        created from DNA).
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent RNA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinition:
          $ref: '#/components/schemas/RnaSequenceSchemaRef'
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    TransferInput:
      additionalProperties: false
      properties:
        transfers:
          items:
            $ref: '#/components/schemas/SingleTransferInput'
          type: array
      required:
      - transfers
      type: object
    TransferOutput:
      description: 'Result of a Container.transfer call: the IDs of the destination
        containers that were updated.'
      properties:
        destinationContainerIds:
          items:
            type: string
          type: array
      type: object
    TransferScratchPlatesResult:
      description: The scratch plate(s) produced by a transfer.
      properties:
        createdPlateIds:
          deprecated: true
          description: Use createdPlates instead, and select the id subfield.
          items:
            type: string
          type: array
        createdPlates:
          description: The destination scratch plates created by the transfer.
          items:
            $ref: '#/components/schemas/ScratchPlateRef'
          type: array
        decrementedSourcePlates:
          description: Copies of the source plates the transfer drew from, holding
            what remained after it. The source plates themselves are historical records
            and are never rewritten. Empty when any drawn-from source well could not
            say how much it had left, since a partial list would read as the full
            set of what remains.
          items:
            $ref: '#/components/schemas/ScratchPlateRef'
          type: array
      type: object
    Translation:
      description: 'Represents a protein-coding region (CDS) on a nucleotide sequence,
        showing the translated

        amino acid sequence. Translations can span a single contiguous region or multiple
        regions

        for spliced genes (see RegionsListItem). The aminoAcids field contains the
        computed protein

        sequence based on the geneticCode (see CodonTranslationTable). The translateFirstCodonToMethionine

        option forces the start codon to encode methionine regardless of the actual
        codon. Translations

        display as colored overlays on the sequence viewer, with the three-letter
        amino acid codes

        shown above the nucleotide bases.'
      properties:
        __typename:
          type: string
        aminoAcids:
          description: 'Calculated amino acid translation of the specified regions,
            combining codons across regions if

            necessary.'
          type: string
        color:
          description: Hex color when displaying the translation.
          type: string
        customFields:
          description: Custom fields on the translation.
          items:
            $ref: '#/components/schemas/CustomField'
          type: array
        end:
          deprecated: true
          description: '0-based exclusive end index. For ranges ending at the end
            of a circular sequence, this value is

            always the length of the sequence, never 0. Use regions instead for location
            information.'
          type:
          - 'null'
          - integer
        geneticCode:
          description: Genetic code for the translation.
          enum:
          - STANDARD
          - VERTEBRATE_MITOCHONDRIAL
          - YEAST_MITOCHONDRIAL
          - MOLD_PROTOZOAN_COELENTERATE_MITOCHONDRIAL_MYCOPLASMA_SPIROPLASMA
          - INVERTEBRATE_MITOCHONDRIAL
          - CILIATE_DASYCLADACEAN_HEXAMITA_NUCLEAR
          - ECHINODERM_FLATWORM_MITOCHONDRIAL
          - EUPLOTID_NUCLEAR
          - BACTERIAL_ARCHAEAL_PLANT_PLASTID
          - ALTERNATIVE_YEAST_NUCLEAR
          - ASCIDIAN_MITOCHONDRIAL
          - ALTERNATIVE_FLATWORM_MITOCHONDRIAL
          - CHLOROPHYCEAN_MITOCHONDRIAL
          - TREMATODE_MITOCHONDRIAL
          - SCENEDESMUS_OBLIQUUS_MITOCHONDRIAL
          - THRAUSTOCHYTRIUM_MITOCHONDRIAL
          - RHABDOPLEURIDAE_MITOCHONDRIAL
          - CANDIDATE_DIVISION_SR1_GRACILIBACTERIA
          - PACHYSOLEN_TANNOPHILUS_NUCLEAR
          - KARYORELICT_NUCLEAR
          - CONDYLOSTOMA_NUCLEAR
          - MESODINIUM_NUCLEAR
          - PERITRICH_NUCLEAR
          - BLASTOCRITHIDIA_NUCLEAR
          - CEPHALODISCIDAE_MITOCHONDRIAL_UAA_TYR
          type: string
        name:
          description: Name of the translation.
          type: string
        notes:
          description: Text notes on the translation.
          type: string
        regions:
          description: Array of regions of the translation. For single-region translations,
            this is an array with one element.
          items:
            $ref: '#/components/schemas/RegionsListItem'
          type: array
        start:
          deprecated: true
          description: '0-based inclusive start index.

            Use regions instead for location information.'
          type:
          - 'null'
          - integer
        strand:
          description: Strand for this annotation; 1 for forward strand, -1 for reverse
            strand.
          type: integer
        translateFirstCodonToMethionine:
          description: Whether or not the first codon has been forced to be translated
            as methionine.
          type: boolean
      type: object
    TranslationInput:
      additionalProperties: false
      properties:
        color:
          description: 'Field will be set to #84B0DC if not specified.'
          type: string
        customFields:
          items:
            $ref: '#/components/schemas/CustomFieldInput'
          type: array
        geneticCode:
          description: Field will be set to STANDARD if not specified.
          enum:
          - STANDARD
          - VERTEBRATE_MITOCHONDRIAL
          - YEAST_MITOCHONDRIAL
          - MOLD_PROTOZOAN_COELENTERATE_MITOCHONDRIAL_MYCOPLASMA_SPIROPLASMA
          - INVERTEBRATE_MITOCHONDRIAL
          - CILIATE_DASYCLADACEAN_HEXAMITA_NUCLEAR
          - ECHINODERM_FLATWORM_MITOCHONDRIAL
          - EUPLOTID_NUCLEAR
          - BACTERIAL_ARCHAEAL_PLANT_PLASTID
          - ALTERNATIVE_YEAST_NUCLEAR
          - ASCIDIAN_MITOCHONDRIAL
          - ALTERNATIVE_FLATWORM_MITOCHONDRIAL
          - CHLOROPHYCEAN_MITOCHONDRIAL
          - TREMATODE_MITOCHONDRIAL
          - SCENEDESMUS_OBLIQUUS_MITOCHONDRIAL
          - THRAUSTOCHYTRIUM_MITOCHONDRIAL
          - RHABDOPLEURIDAE_MITOCHONDRIAL
          - CANDIDATE_DIVISION_SR1_GRACILIBACTERIA
          - PACHYSOLEN_TANNOPHILUS_NUCLEAR
          - KARYORELICT_NUCLEAR
          - CONDYLOSTOMA_NUCLEAR
          - MESODINIUM_NUCLEAR
          - PERITRICH_NUCLEAR
          - BLASTOCRITHIDIA_NUCLEAR
          - CEPHALODISCIDAE_MITOCHONDRIAL_UAA_TYR
          type: string
        name:
          type: string
        notes:
          type: string
        regions:
          items:
            $ref: '#/components/schemas/TranslationRegionInput'
          type: array
        strand:
          enum:
          - FORWARD
          - REVERSE
          type: string
        translateFirstCodonToMethionine:
          description: Field will be set to False if not specified.
          type: boolean
      required:
      - regions
      - strand
      type: object
    TranslationLinkFieldDefinition:
      description: A schema field definition for linking to translations (AA sequences
        created from RNA).
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        derivationType:
          enum:
          - DIRECT
          - COMPUTED
          - SNAPSHOT
          type: string
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent AA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
      type: object
    TranslationRegionInput:
      additionalProperties: false
      properties:
        end:
          type: integer
        start:
          type: integer
      required:
      - end
      - start
      type: object
    UiBlockLeafNodeInput:
      allOf:
      - properties:
          type:
            enum:
            - BUTTON
            - CHIP
            - DROPDOWN
            - DROPDOWN_MULTIVALUE
            - FILE_UPLOAD
            - MARKDOWN
            - SEARCH_INPUT
            - SEARCH_INPUT_MULTIVALUE
            - SELECTOR_INPUT
            - SELECTOR_INPUT_MULTIVALUE
            - TEXT_INPUT
            type: string
        required:
        - type
      - oneOf:
        - $ref: '#/components/schemas/ButtonUiBlockInput'
        - $ref: '#/components/schemas/ChipUiBlockInput'
        - $ref: '#/components/schemas/DropdownMultiValueUiBlockInput'
        - $ref: '#/components/schemas/DropdownUiBlockInput'
        - $ref: '#/components/schemas/FileUploadUiBlockInput'
        - $ref: '#/components/schemas/MarkdownUiBlockInput'
        - $ref: '#/components/schemas/SearchInputMultiValueUiBlockInput'
        - $ref: '#/components/schemas/SearchInputUiBlockInput'
        - $ref: '#/components/schemas/SelectorInputMultiValueUiBlockInput'
        - $ref: '#/components/schemas/SelectorInputUiBlockInput'
        - $ref: '#/components/schemas/TextInputUiBlockInput'
      discriminator:
        propertyName: type
      type: object
    Unit:
      description: 'A Unit is a specific measure of a physical quantity within Benchling''s
        tenant-specific

        unit dictionary, used to capture and convert scientific measurements across
        the platform.

        Each Unit belongs to a `UnitType` (e.g., "Volume" or "Mass") and defines its
        relationship

        to the UnitType''s base unit through a `conversionFactor`. For example, a
        milliliter unit

        would have a conversionFactor of 0.001 relative to a liter base unit. Units
        are

        identified by a human-readable `name` (e.g., "milliliter"), a shorthand `symbol`

        (e.g., "mL"), and may have `aliases` for alternate input symbols. Units within
        the same

        UnitType are inter-convertible; cross-dimensional conversions are not supported.
        Units

        appear throughout Benchling wherever measurements are recorded, including
        inventory

        container quantities (see `Measurement`), result fields, and sample properties.'
      properties:
        __typename:
          type: string
        aliases:
          description: Any additional short-form labels that should be recognized
            in input
          items:
            type: string
          type: array
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        conversionFactor:
          format: decimal
          type: string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        symbol:
          type: string
        unitType:
          $ref: '#/components/schemas/UnitTypeRef'
      type: object
    UnitInput:
      additionalProperties: false
      properties:
        versionNumber:
          type: integer
      type: object
    UnitPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Unit'
          type: array
        nextToken:
          type: string
      type: object
    UnitRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    UnitType:
      description: 'A UnitType is a dimensional category that groups inter-convertible
        `Unit` objects

        within Benchling''s tenant-specific unit dictionary. Examples include Volume,
        Mass,

        Time, Molar Concentration, and custom types like Cell Concentration. Each
        UnitType

        has a designated `baseUnit` that serves as the reference for conversion factors

        of all other units in the type—units within the same UnitType can be converted
        to

        each other, but cross-dimensional conversions are not supported. The dimensional

        composition is described by `terms` (see `UnitTypeTerm`), and derived types
        can

        specify their `formula` (see `FormulaUnitTerm`) to define relationships

        like Liter = decimeter³. UnitTypes can be flagged to provide concentration
        units

        or container quantity units for inventory features regardless of their dimensional

        terms. Historically called "Quantity" in some internal systems.'
      properties:
        __typename:
          type: string
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        baseUnit:
          oneOf:
          - $ref: '#/components/schemas/UnitRef'
          - type: 'null'
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        formula:
          oneOf:
          - items:
              $ref: '#/components/schemas/FormulaUnitTerm'
            type: array
          - type: 'null'
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        overrideIsConcentration:
          description: When true, forces this UnitType to be treated as a concentration
            type regardless of its terms. When false, the classification is determined
            by the UnitType's terms. Mutually exclusive with `overrideIsContainerQuantity`.
          type:
          - 'null'
          - boolean
        overrideIsContainerQuantity:
          description: When true, forces this UnitType to be treated as a container
            quantity type regardless of its terms. When false, the classification
            is determined by the UnitType's terms. Mutually exclusive with `overrideIsConcentration`.
          type:
          - 'null'
          - boolean
        terms:
          items:
            $ref: '#/components/schemas/UnitTypeTerm'
          type: array
        units:
          oneOf:
          - format: uri
            type: string
          - type: 'null'
      type: object
    UnitTypePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/UnitType'
          type: array
        nextToken:
          type: string
      type: object
    UnitTypeRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    UnitTypeTerm:
      description: 'A term in the dimensional formula of a `UnitType`, pairing one
        of the seven SI base

        dimensions (see `BaseUnitType`) with an integer exponent. Multiple terms together

        describe the dimensional composition of a UnitType. For example, a Volume
        UnitType

        would have a single term with value=LENGTH and exponent=3, while Acceleration
        would

        have [LENGTH^1, TIME^-2]. Terms are descriptive metadata and do not uniquely
        identify

        a UnitType—multiple UnitTypes can share the same dimensional terms.'
      properties:
        __typename:
          type: string
        exponent:
          type: integer
        value:
          enum:
          - TIME
          - LENGTH
          - MASS
          - CURRENT
          - TEMPERATURE
          - AMOUNT
          - LUMINOUS_INTENSITY
          type: string
      type: object
    UnitUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Unit'
          type: array
      type: object
    UnresolvableEmbeddedItem:
      description: 'An embedded Benchling item that exists in the system but cannot
        be fetched via the V3 REST API

        (currently Protocols, Equipment, and Trial Subjects). It has no API endpoint;
        the `id` is

        provided for informational purposes only, so that the reference can be preserved
        (e.g. when a

        document part is copied between entries).'
      properties:
        __typename:
          type: string
        id:
          description: The API identifier of the embedded item.
          type: string
      type: object
    UnstructuredTableCellFormatInput:
      additionalProperties: false
      properties:
        alignment:
          type:
          - 'null'
          - string
        backgroundColor:
          type:
          - 'null'
          - string
        foregroundColor:
          type:
          - 'null'
          - string
        link:
          type:
          - 'null'
          - string
        properties:
          items:
            type: string
          type: array
      type: object
    UnstructuredTableCellInput:
      additionalProperties: false
      properties:
        format:
          oneOf:
          - $ref: '#/components/schemas/UnstructuredTableCellFormatInput'
          - type: 'null'
        inputValue:
          $ref: '#/components/schemas/UnstructuredTableCellInputValue'
        mergeRange:
          oneOf:
          - $ref: '#/components/schemas/UnstructuredTableMergeRangeInput'
          - type: 'null'
        mergeRangeParent:
          oneOf:
          - $ref: '#/components/schemas/UnstructuredTableMergeRangeParentInput'
          - type: 'null'
        selectorId:
          type:
          - 'null'
          - string
      required:
      - inputValue
      type: object
    UnstructuredTableCellInputValue:
      additionalProperties: false
      properties:
        type:
          enum:
          - text_value
          type: string
        value:
          type: string
      required:
      - type
      - value
      type: object
    UnstructuredTableColumnInput:
      additionalProperties: false
      properties:
        isLocked:
          type: boolean
        name:
          type: string
        width:
          type:
          - 'null'
          - number
      required:
      - name
      type: object
    UnstructuredTableContentInput:
      additionalProperties: false
      properties:
        columnDefinitions:
          items:
            $ref: '#/components/schemas/UnstructuredTableColumnInput'
          type: array
        contentType:
          enum:
          - unstructured_table
          type: string
        name:
          type: string
        rows:
          items:
            $ref: '#/components/schemas/UnstructuredTableRowInput'
          type: array
      required:
      - contentType
      - name
      - columnDefinitions
      - rows
      type: object
    UnstructuredTableDocumentContentDetail:
      description: 'An unstructured (plain) table embedded within a notebook entry.
        Unlike structured

        tables, unstructured tables have freeform cells without typed columns. Cells
        can

        contain text, formulas with evaluated values, formatting, and merged regions.

        This is the detailed representation and includes row data. It is returned
        when

        retrieving a particular document part (e.g. from the document_part GET endpoint).

        Unstructured table mutation endpoints are currently in closed LA.'
      properties:
        __typename:
          type: string
        columnDefinitions:
          items:
            $ref: '#/components/schemas/TableColumnDefinition'
          type: array
        indentation:
          type: integer
        isEvaluated:
          type: boolean
        name:
          type: string
        rowCount:
          type: integer
        rows:
          items:
            $ref: '#/components/schemas/TableRow'
          type: array
      type: object
    UnstructuredTableDocumentContentSummary:
      description: 'An unstructured (plain) table embedded within a notebook entry.
        Unlike structured

        tables, unstructured tables have freeform cells without typed columns. Cells
        can

        contain text, formulas with evaluated values, formatting, and merged regions.

        This is the summary representation and excludes row data. It is returned when

        retrieving a particular document part (e.g. from the document_part GET endpoint).

        Unstructured table mutation endpoints are currently in closed LA.'
      properties:
        __typename:
          type: string
        columnDefinitions:
          items:
            $ref: '#/components/schemas/TableColumnDefinition'
          type: array
        indentation:
          type: integer
        isEvaluated:
          type: boolean
        name:
          type: string
        rowCount:
          type: integer
      type: object
    UnstructuredTableMergeRangeInput:
      additionalProperties: false
      properties:
        mergeColSpan:
          type: integer
        mergeRowSpan:
          type: integer
      required:
      - mergeRowSpan
      - mergeColSpan
      type: object
    UnstructuredTableMergeRangeParentInput:
      additionalProperties: false
      properties:
        col:
          type: integer
        row:
          type: integer
      required:
      - row
      - col
      type: object
    UnstructuredTableRowInput:
      additionalProperties: false
      properties:
        cells:
          items:
            $ref: '#/components/schemas/UnstructuredTableCellInput'
          type: array
      required:
      - cells
      type: object
    UnsupportedCellEvaluationValue:
      description: 'Sentinel for evaluation values whose internal type cannot be represented
        in the current

        API. The cell''s text field should be used as a human-readable fallback.'
      properties:
        __typename:
          type: string
        errorReason:
          type: string
      type: object
    UpdateAaPartLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent AA part. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - AA_PART_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateAaSequenceInput:
      additionalProperties: false
      properties:
        aliases:
          description: Array of aliases
          items:
            type: string
          type: array
        aminoAcids:
          description: Amino acids of the AA sequence.
          type: string
        annotations:
          description: Array of annotation objects on the AA sequence.
          items:
            $ref: '#/components/schemas/AaAnnotationInputUpdate'
          type: array
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          description: Custom fields set on the AA sequence.
          type: object
        entityRegistryId:
          description: Registry ID of the AA sequence if registered.
          type: string
        folderId:
          type: string
        name:
          description: Name of the AA sequence.
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      type: object
    UpdateAaSequenceInputWithPathParams:
      additionalProperties: false
      properties:
        aliases:
          description: Array of aliases
          items:
            type: string
          type: array
        aminoAcids:
          description: Amino acids of the AA sequence.
          type: string
        annotations:
          description: Array of annotation objects on the AA sequence.
          items:
            $ref: '#/components/schemas/AaAnnotationInputUpdate'
          type: array
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          description: Custom fields set on the AA sequence.
          type: object
        entityRegistryId:
          description: Registry ID of the AA sequence if registered.
          type: string
        folderId:
          type: string
        id:
          type: string
        name:
          description: Name of the AA sequence.
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - id
      type: object
    UpdateAaSequenceLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent AA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - AA_SEQUENCE_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateAaSequenceSchemaInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateAASequenceSchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - ANTIBODY
          - BASIC_FOLDER_ITEM
          - LINEAR
          - PROTEIN
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        showResidues:
          description: Controls whether amino acid residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    UpdateAaSequenceSchemaInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateAASequenceSchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - ANTIBODY
          - BASIC_FOLDER_ITEM
          - LINEAR
          - PROTEIN
          type: string
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        showResidues:
          description: Controls whether amino acid residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - id
      type: object
    UpdateAntibodyLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent Antibody. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - ANTIBODY_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateAntibodySchemaInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    UpdateAntibodySchemaInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - id
      type: object
    UpdateAnyEntityLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - ENTITY_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      type: object
    UpdateAppCanvasInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        blocks:
          description: Replacement list of UI blocks for the canvas layout.
          items:
            $ref: '#/components/schemas/AppCanvasUiBlockInput'
          type: array
        data:
          description: JSON string (max 5 KiB) of app-managed data not rendered in
            the canvas UI.
          type:
          - 'null'
          - string
        enabled:
          description: Whether the canvas is interactable. When false, all blocks
            are disabled regardless of their individual enabled settings.
          type: boolean
        sessionId:
          description: App session ID whose status messages are shown in the canvas.
          type:
          - 'null'
          - string
      type: object
    UpdateAppCanvasInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        blocks:
          description: Replacement list of UI blocks for the canvas layout.
          items:
            $ref: '#/components/schemas/AppCanvasUiBlockInput'
          type: array
        data:
          description: JSON string (max 5 KiB) of app-managed data not rendered in
            the canvas UI.
          type:
          - 'null'
          - string
        enabled:
          description: Whether the canvas is interactable. When false, all blocks
            are disabled regardless of their individual enabled settings.
          type: boolean
        id:
          type: string
        sessionId:
          description: App session ID whose status messages are shown in the canvas.
          type:
          - 'null'
          - string
      required:
      - id
      type: object
    UpdateAppSessionInput:
      additionalProperties: false
      properties:
        messages:
          description: Replace the current messages with this list. If omitted, the
            existing messages are carried forward unchanged.
          items:
            $ref: '#/components/schemas/AppSessionMessageInput'
          type: array
        status:
          description: Transition the session to a terminal status (SUCCEEDED, FAILED,
            or COMPLETED_WITH_WARNINGS).
          enum:
          - SUCCEEDED
          - FAILED
          - COMPLETED_WITH_WARNINGS
          type: string
        timeoutSeconds:
          description: New timeout in seconds. Must be greater than or equal to the
            current timeout.
          type: integer
      type: object
    UpdateAppSessionInputWithPathParams:
      additionalProperties: false
      properties:
        id:
          type: string
        messages:
          description: Replace the current messages with this list. If omitted, the
            existing messages are carried forward unchanged.
          items:
            $ref: '#/components/schemas/AppSessionMessageInput'
          type: array
        status:
          description: Transition the session to a terminal status (SUCCEEDED, FAILED,
            or COMPLETED_WITH_WARNINGS).
          enum:
          - SUCCEEDED
          - FAILED
          - COMPLETED_WITH_WARNINGS
          type: string
        timeoutSeconds:
          description: New timeout in seconds. Must be greater than or equal to the
            current timeout.
          type: integer
      required:
      - id
      type: object
    UpdateAssayRequestLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - ASSAY_REQUEST_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateAssayResultLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - ASSAY_RESULT_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateAssayRunLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - ASSAY_RUN_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateBlobLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - BLOB_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      type: object
    UpdateBooleanFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - BOOLEAN
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      type: object
    UpdateBoxInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        barcode:
          type: string
        name:
          type: string
        parentStorageId:
          type:
          - 'null'
          - string
        projectId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
      type: object
    UpdateBoxInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        barcode:
          type: string
        id:
          type: string
        name:
          type: string
        parentStorageId:
          type:
          - 'null'
          - string
        projectId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
      required:
      - id
      type: object
    UpdateBoxSchemaInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        containerSchemaId:
          description: The API ID of the container schema constraining what types
            of containers can be stored in boxes of this type.
          type:
          - 'null'
          - string
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        height:
          description: The number of rows in the grid layout.
          type: integer
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        prefix:
          description: The prefix used for auto-generating barcodes for inventory
            items of this schema. Must be unique within the registry and cannot end
            in a digit.
          type: string
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        width:
          description: The number of columns in the grid layout.
          type: integer
      type: object
    UpdateBoxSchemaInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        containerSchemaId:
          description: The API ID of the container schema constraining what types
            of containers can be stored in boxes of this type.
          type:
          - 'null'
          - string
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        height:
          description: The number of rows in the grid layout.
          type: integer
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        prefix:
          description: The prefix used for auto-generating barcodes for inventory
            items of this schema. Must be unique within the registry and cannot end
            in a digit.
          type: string
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        width:
          description: The number of columns in the grid layout.
          type: integer
      required:
      - id
      type: object
    UpdateChartInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        name:
          type: string
      type: object
    UpdateChartInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        id:
          type: string
        name:
          type: string
      required:
      - id
      type: object
    UpdateCollaborationInput:
      additionalProperties: false
      properties:
        accessPolicyId:
          type: string
        isAuditor:
          type: boolean
      type: object
    UpdateCollaborationInputWithPathParams:
      additionalProperties: false
      properties:
        accessPolicyId:
          type: string
        id:
          type: string
        isAuditor:
          type: boolean
      required:
      - id
      type: object
    UpdateContainerInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        checkoutRecord:
          $ref: '#/components/schemas/CheckoutRecordInput'
        name:
          type: string
        parentStorageId:
          type:
          - 'null'
          - string
        projectId:
          type:
          - 'null'
          - string
        quantity:
          $ref: '#/components/schemas/MeasurementInput'
          description: 'Quantity of a container, well, or transfer. Supports mass,
            volume, and

            other quantities.'
        restrictedSamplePartyIds:
          items:
            type: string
          type: array
        restrictionStatus:
          enum:
          - RESTRICTED
          - UNRESTRICTED
          - NOT_APPLICABLE
          type: string
        role:
          oneOf:
          - $ref: '#/components/schemas/ExperimentalRoleInput'
          - type: 'null'
        sampleOwnerIds:
          items:
            type: string
          type: array
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
      type: object
    UpdateContainerInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        checkoutRecord:
          $ref: '#/components/schemas/CheckoutRecordInput'
        id:
          type: string
        name:
          type: string
        parentStorageId:
          type:
          - 'null'
          - string
        projectId:
          type:
          - 'null'
          - string
        quantity:
          $ref: '#/components/schemas/MeasurementInput'
          description: 'Quantity of a container, well, or transfer. Supports mass,
            volume, and

            other quantities.'
        restrictedSamplePartyIds:
          items:
            type: string
          type: array
        restrictionStatus:
          enum:
          - RESTRICTED
          - UNRESTRICTED
          - NOT_APPLICABLE
          type: string
        role:
          oneOf:
          - $ref: '#/components/schemas/ExperimentalRoleInput'
          - type: 'null'
        sampleOwnerIds:
          items:
            type: string
          type: array
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
      required:
      - id
      type: object
    UpdateContainerSchemaInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        prefix:
          description: The prefix used for auto-generating barcodes for inventory
            items of this schema. Must be unique within the registry and cannot end
            in a digit.
          type: string
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
      type: object
    UpdateContainerSchemaInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        prefix:
          description: The prefix used for auto-generating barcodes for inventory
            items of this schema. Must be unique within the registry and cannot end
            in a digit.
          type: string
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
      required:
      - id
      type: object
    UpdateCustomEntityInput:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        archiveReason:
          type: string
        archived:
          description: If the CustomEntity is archived
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        entityRegistryId:
          type: string
        folderId:
          type: string
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      type: object
    UpdateCustomEntityInputWithPathParams:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        archiveReason:
          type: string
        archived:
          description: If the CustomEntity is archived
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        entityRegistryId:
          type: string
        folderId:
          type: string
        id:
          type: string
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - id
      type: object
    UpdateCustomEntityLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent custom entity.
            Important for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - CUSTOM_ENTITY_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateCustomEntitySchemaInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateEntitySchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - ANTIBODY
          - ARROW_ZIG_ZAG_DOWN
          - ARROW_ZIG_ZAG_RIGHT
          - ASSEMBLY
          - BACTERIA
          - BASIC_FOLDER_ITEM
          - BEAKER
          - BOX_ARROW_RIGHT
          - BROKEN_COLUMNS_IN_BRACKET
          - BUILDING_PLUS
          - CELL_LINE
          - CHEMICAL_COMPOUND
          - CHEMICAL_CONCATENATION
          - CHEMICAL_HOMOLOGY
          - CHEMICAL_LADDER
          - CHROMATOGRAPHY
          - CIRCLE_WITH_THICK_SEGMENT
          - CLIPBOARD_IN_BRACKETS
          - COMPOUND
          - DOCK_BOTTOM
          - FILE_BAR_CHART
          - FILE_IN_BRACKETS
          - FILL_GRID
          - FLASK
          - FLASK_RECEIPT
          - FLOWCHART
          - GRID_DOTS
          - HUMAN
          - INSTRUMENT
          - LIGHTBULB_IN_BRACKETS
          - LINEAR
          - LIST_ASTERISK
          - LIST_CHECK_XMARK
          - MATERIAL
          - MICROSCOPE
          - MIXTURE
          - MOLECULE_TO_BACKBONE
          - MOLECULE_TO_MOLECULE
          - MORTAR_PESTLE
          - MOUSE
          - NETWORK_WIRED
          - NODES_CONVERGE
          - OCHEM_MOLECULE
          - OCHEM_MOLECULE_BEAKER
          - OLIGO
          - OLIGO_ALT
          - OLIGO_V2
          - PART
          - PETRI
          - PLANT
          - PLASMID
          - POWDER
          - POWDER_BEAKER
          - PRIMER_PAIR
          - PROCESS
          - PROTEIN
          - PROTEIN_ALT
          - PROTEIN_MAGNIFYING_GLASS
          - REACTION_VESSEL
          - RECEIPT_FLASK
          - RECIPE
          - REQUEST_TEMPLATE
          - RNA
          - RNA_SEQUENCE
          - SAMPLE_SLIDE
          - SEQUENCE
          - SMALL_MOLECULE
          - SMALL_MOLECULE_BEAKER
          - SOLUTION
          - SQUARE_BRACKET_CHECK_EQUALS
          - TABLE_LIST_ALT
          - TEMPLATE
          - TUBE_EMPTY
          - VIAL
          - WELL_PLATE
          - WORKFLOW
          - WORKSHEET
          - WORM
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    UpdateCustomEntitySchemaInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateEntitySchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - ANTIBODY
          - ARROW_ZIG_ZAG_DOWN
          - ARROW_ZIG_ZAG_RIGHT
          - ASSEMBLY
          - BACTERIA
          - BASIC_FOLDER_ITEM
          - BEAKER
          - BOX_ARROW_RIGHT
          - BROKEN_COLUMNS_IN_BRACKET
          - BUILDING_PLUS
          - CELL_LINE
          - CHEMICAL_COMPOUND
          - CHEMICAL_CONCATENATION
          - CHEMICAL_HOMOLOGY
          - CHEMICAL_LADDER
          - CHROMATOGRAPHY
          - CIRCLE_WITH_THICK_SEGMENT
          - CLIPBOARD_IN_BRACKETS
          - COMPOUND
          - DOCK_BOTTOM
          - FILE_BAR_CHART
          - FILE_IN_BRACKETS
          - FILL_GRID
          - FLASK
          - FLASK_RECEIPT
          - FLOWCHART
          - GRID_DOTS
          - HUMAN
          - INSTRUMENT
          - LIGHTBULB_IN_BRACKETS
          - LINEAR
          - LIST_ASTERISK
          - LIST_CHECK_XMARK
          - MATERIAL
          - MICROSCOPE
          - MIXTURE
          - MOLECULE_TO_BACKBONE
          - MOLECULE_TO_MOLECULE
          - MORTAR_PESTLE
          - MOUSE
          - NETWORK_WIRED
          - NODES_CONVERGE
          - OCHEM_MOLECULE
          - OCHEM_MOLECULE_BEAKER
          - OLIGO
          - OLIGO_ALT
          - OLIGO_V2
          - PART
          - PETRI
          - PLANT
          - PLASMID
          - POWDER
          - POWDER_BEAKER
          - PRIMER_PAIR
          - PROCESS
          - PROTEIN
          - PROTEIN_ALT
          - PROTEIN_MAGNIFYING_GLASS
          - REACTION_VESSEL
          - RECEIPT_FLASK
          - RECIPE
          - REQUEST_TEMPLATE
          - RNA
          - RNA_SEQUENCE
          - SAMPLE_SLIDE
          - SEQUENCE
          - SMALL_MOLECULE
          - SMALL_MOLECULE_BEAKER
          - SOLUTION
          - SQUARE_BRACKET_CHECK_EQUALS
          - TABLE_LIST_ALT
          - TEMPLATE
          - TUBE_EMPTY
          - VIAL
          - WELL_PLATE
          - WORKFLOW
          - WORKSHEET
          - WORM
          type: string
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - id
      type: object
    UpdateDateFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - DATE
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      type: object
    UpdateDateTimeFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - DATE_TIME
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      type: object
    UpdateDnaOligoInput:
      additionalProperties: false
      properties:
        aliases:
          description: Array of aliases
          items:
            type: string
          type: array
        annotations:
          description: Annotations on the Oligo.
          items:
            $ref: '#/components/schemas/OligoAnnotationInput'
          type: array
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        bases:
          description: Bases of the Oligo.
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          description: Custom fields set on the Oligo.
          type: object
        customNotation:
          type: string
        customNotationId:
          type: string
        entityRegistryId:
          description: Registry ID of the Oligo if registered.
          type: string
        folderId:
          type: string
        helm:
          type: string
        name:
          description: Name of the Oligo.
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      type: object
    UpdateDnaOligoInputWithPathParams:
      additionalProperties: false
      properties:
        aliases:
          description: Array of aliases
          items:
            type: string
          type: array
        annotations:
          description: Annotations on the Oligo.
          items:
            $ref: '#/components/schemas/OligoAnnotationInput'
          type: array
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        bases:
          description: Bases of the Oligo.
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          description: Custom fields set on the Oligo.
          type: object
        customNotation:
          type: string
        customNotationId:
          type: string
        entityRegistryId:
          description: Registry ID of the Oligo if registered.
          type: string
        folderId:
          type: string
        helm:
          type: string
        id:
          type: string
        name:
          description: Name of the Oligo.
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - id
      type: object
    UpdateDnaOligoLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent DNA Oligo. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - DNA_OLIGO_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateDnaOligoSchemaInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateSequenceSchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - OLIGO
          - OLIGO_V2
          - PRIMER_PAIR
          - SEQUENCE
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        showResidues:
          description: Controls whether DNA residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    UpdateDnaOligoSchemaInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateSequenceSchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - OLIGO
          - OLIGO_V2
          - PRIMER_PAIR
          - SEQUENCE
          type: string
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        showResidues:
          description: Controls whether DNA residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - id
      type: object
    UpdateDnaPartLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent DNA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - DNA_PART_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateDnaSequenceInput:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        annotations:
          description: 'Annotations on the DNA sequence, not including translations
            or primers. Annotations on parts are

            not included.'
          items:
            $ref: '#/components/schemas/NucleotideAnnotationInput'
          type: array
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        bases:
          description: Bases of the forward strand of the DNA sequence.
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        entityRegistryId:
          type: string
        folderId:
          type: string
        isCircular:
          description: Field will be set to false if not specified.
          type: boolean
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        parts:
          description: Part features on the DNA sequence.
          items:
            $ref: '#/components/schemas/NucleotidePartInput'
          type: array
        primers:
          description: Primer bind features on the DNA sequence. Primers on parts
            are not included.
          items:
            $ref: '#/components/schemas/PrimerInput'
          type: array
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
        translations:
          description: 'Translation annotations present on the DNA sequence. Translations
            may be one region or split

            across multiple regions. Translations on parts are not included.'
          items:
            $ref: '#/components/schemas/TranslationInput'
          type: array
      type: object
    UpdateDnaSequenceInputWithPathParams:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        annotations:
          description: 'Annotations on the DNA sequence, not including translations
            or primers. Annotations on parts are

            not included.'
          items:
            $ref: '#/components/schemas/NucleotideAnnotationInput'
          type: array
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        bases:
          description: Bases of the forward strand of the DNA sequence.
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        entityRegistryId:
          type: string
        folderId:
          type: string
        id:
          type: string
        isCircular:
          description: Field will be set to false if not specified.
          type: boolean
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        parts:
          description: Part features on the DNA sequence.
          items:
            $ref: '#/components/schemas/NucleotidePartInput'
          type: array
        primers:
          description: Primer bind features on the DNA sequence. Primers on parts
            are not included.
          items:
            $ref: '#/components/schemas/PrimerInput'
          type: array
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
        translations:
          description: 'Translation annotations present on the DNA sequence. Translations
            may be one region or split

            across multiple regions. Translations on parts are not included.'
          items:
            $ref: '#/components/schemas/TranslationInput'
          type: array
      required:
      - id
      type: object
    UpdateDnaSequenceLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent DNA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - DNA_SEQUENCE_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateDnaSequenceSchemaInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateSequenceSchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - OLIGO_V2
          - PLASMID
          - PRIMER_PAIR
          - RNA_SEQUENCE
          - SEQUENCE
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        showResidues:
          description: Controls whether DNA residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    UpdateDnaSequenceSchemaInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateSequenceSchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - OLIGO_V2
          - PLASMID
          - PRIMER_PAIR
          - RNA_SEQUENCE
          - SEQUENCE
          type: string
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        showResidues:
          description: Controls whether DNA residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - id
      type: object
    UpdateDocumentPartsInput:
      allOf:
      - properties:
          operationType:
            enum:
            - delete
            - insert
            - move
            type: string
        required:
        - operationType
      - oneOf:
        - $ref: '#/components/schemas/DeleteDocumentPartsInput'
        - $ref: '#/components/schemas/InsertDocumentPartsInput'
        - $ref: '#/components/schemas/MoveDocumentPartsInput'
      discriminator:
        propertyName: operationType
      type: object
    UpdateDropdownInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        name:
          description: Name of the dropdown
          type: string
        options:
          description: Array of dropdown options
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateDropdownOptionInput'
            - $ref: '#/components/schemas/UpdateDropdownOptionInput'
          type: array
      type: object
    UpdateDropdownInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        id:
          type: string
        name:
          description: Name of the dropdown
          type: string
        options:
          description: Array of dropdown options
          items:
            anyOf:
            - $ref: '#/components/schemas/CreateDropdownOptionInput'
            - $ref: '#/components/schemas/UpdateDropdownOptionInput'
          type: array
      required:
      - id
      type: object
    UpdateDropdownLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        dropdownId:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - DROPDOWN
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - dropdownId
      type: object
    UpdateDropdownOptionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        id:
          type: string
        name:
          type: string
      required:
      - id
      type: object
    UpdateEntryInput:
      additionalProperties: false
      example:
        content:
        - contentType: text
          text: This is text content
        - contentType: external_file
          url: https://example.com/file/url
        - contentType: result_table
          resultSchemaId: assaysch_qgpYTGPS
        - contentType: registration_table
          entitySchemaId: ts_O4cZeDm9
        name: Updated Entry Title
        sectionUuid: b7e0105c-3568-4260-b0f0-897e793ac2a7
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        content:
          items:
            $ref: '#/components/schemas/CreateEntryContentInput'
          type: array
        name:
          description: Title of the entry
          type: string
        partsMutation:
          $ref: '#/components/schemas/UpdateDocumentPartsInput'
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type:
          - 'null'
          - string
        sectionUuid:
          format: uuid
          type: string
        selectors:
          description: Selectors available to table cells in this entry.
          items:
            $ref: '#/components/schemas/SelectorInput'
          type: array
      type: object
    UpdateEntryInputWithPathParams:
      additionalProperties: false
      example:
        content:
        - contentType: text
          text: This is text content
        - contentType: external_file
          url: https://example.com/file/url
        - contentType: result_table
          resultSchemaId: assaysch_qgpYTGPS
        - contentType: registration_table
          entitySchemaId: ts_O4cZeDm9
        id: etr_8rVKW0g7
        name: Updated Entry Title
        sectionUuid: b7e0105c-3568-4260-b0f0-897e793ac2a7
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        content:
          items:
            $ref: '#/components/schemas/CreateEntryContentInput'
          type: array
        id:
          type: string
        name:
          description: Title of the entry
          type: string
        partsMutation:
          $ref: '#/components/schemas/UpdateDocumentPartsInput'
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type:
          - 'null'
          - string
        sectionUuid:
          format: uuid
          type: string
        selectors:
          description: Selectors available to table cells in this entry.
          items:
            $ref: '#/components/schemas/SelectorInput'
          type: array
      required:
      - id
      type: object
    UpdateEntryLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - ENTRY_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      type: object
    UpdateEquipmentLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent Equipment. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - EQUIPMENT_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateEquipmentSchemaInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateEntitySchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - MICROSCOPE
          - SAMPLE_SLIDE
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    UpdateEquipmentSchemaInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateEntitySchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - MICROSCOPE
          - SAMPLE_SLIDE
          type: string
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - id
      type: object
    UpdateFieldValueInput:
      additionalProperties: false
      properties:
        fieldDefinitionId:
          type: string
        value:
          $ref: '#/components/schemas/AnyType'
      required:
      - value
      - fieldDefinitionId
      type: object
    UpdateFieldsetInput:
      additionalProperties: false
      properties:
        archiveReason:
          description: Reason the Fieldset was archived
          type: string
        archived:
          description: If the Fieldset is archived
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateFieldsetConstraintInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          type: string
        itemIdPrefix:
          type: string
        itemType:
          description: 'The entity item type that schemas implementing this Fieldset
            contain (e.g. DNA_SEQUENCE,

            AA_SEQUENCE, MIXTURE). Null when the Fieldset declares no base bioentity
            type.'
          enum:
          - AA_SEQUENCE
          - ANTIBODY
          - CUSTOM_ENTITY
          - DNA_OLIGO
          - DNA_SEQUENCE
          - ENTRY
          - EQUIPMENT
          - MIXTURE
          - MOLECULE
          - OLIGO_CONJUGATE
          - OLIGO_DUPLEX
          - RNA_OLIGO
          - RNA_SEQUENCE
          - TRIAL_SUBJECT
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Setting to
            null removes the name template and unlocks implementing schemas. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        systemName:
          type: string
      type: object
    UpdateFieldsetInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          description: Reason the Fieldset was archived
          type: string
        archived:
          description: If the Fieldset is archived
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateFieldsetConstraintInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          type: string
        id:
          type: string
        itemIdPrefix:
          type: string
        itemType:
          description: 'The entity item type that schemas implementing this Fieldset
            contain (e.g. DNA_SEQUENCE,

            AA_SEQUENCE, MIXTURE). Null when the Fieldset declares no base bioentity
            type.'
          enum:
          - AA_SEQUENCE
          - ANTIBODY
          - CUSTOM_ENTITY
          - DNA_OLIGO
          - DNA_SEQUENCE
          - ENTRY
          - EQUIPMENT
          - MIXTURE
          - MOLECULE
          - OLIGO_CONJUGATE
          - OLIGO_DUPLEX
          - RNA_OLIGO
          - RNA_SEQUENCE
          - TRIAL_SUBJECT
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Setting to
            null removes the name template and unlocks implementing schemas. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        systemName:
          type: string
      required:
      - id
      type: object
    UpdateFieldsetLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - FIELDSET_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateFileInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        folderId:
          type: string
        name:
          type: string
      type: object
    UpdateFileInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        folderId:
          type: string
        id:
          type: string
        name:
          type: string
      required:
      - id
      type: object
    UpdateFloatFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        displayPrecision:
          type: integer
        id:
          type: string
        isRequired:
          type: boolean
        name:
          type: string
        numericMax:
          type: number
        numericMin:
          type: number
        systemName:
          type: string
        type:
          enum:
          - FLOAT
          type: string
        unitId:
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      type: object
    UpdateFolderInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type:
          - 'null'
          - string
        name:
          type: string
      type: object
    UpdateFolderInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type:
          - 'null'
          - string
        id:
          type: string
        name:
          type: string
      required:
      - id
      type: object
    UpdateIntegerFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isRequired:
          type: boolean
        name:
          type: string
        numericMax:
          type: number
        numericMin:
          type: number
        systemName:
          type: string
        type:
          enum:
          - INTEGER
          type: string
        unitId:
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      type: object
    UpdateLibraryParameterDefinitionInput:
      additionalProperties: false
      example:
        description: The temperature at which the sample is incubated, measured in
          Celsius.
        name: Incubation Temperature (Updated)
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          description: Updated description. Maximum 2048 characters.
          type: string
        name:
          description: Updated display name. Must contain at least one alphanumeric
            character. Maximum 44 characters.
          type: string
      type: object
    UpdateLibraryParameterDefinitionInputWithPathParams:
      additionalProperties: false
      example:
        description: The temperature at which the sample is incubated, measured in
          Celsius.
        id: pardef_mG7kLpQw
        name: Incubation Temperature (Updated)
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          description: Updated description. Maximum 2048 characters.
          type: string
        id:
          type: string
        name:
          description: Updated display name. Must contain at least one alphanumeric
            character. Maximum 44 characters.
          type: string
      required:
      - id
      type: object
    UpdateLocationInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        barcode:
          type: string
        name:
          type: string
        parentStorageId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
      type: object
    UpdateLocationInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        barcode:
          type: string
        id:
          type: string
        name:
          type: string
        parentStorageId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
      required:
      - id
      type: object
    UpdateLocationSchemaInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        prefix:
          description: The prefix used for auto-generating barcodes for inventory
            items of this schema. Must be unique within the registry and cannot end
            in a digit.
          type: string
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
      type: object
    UpdateLocationSchemaInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        prefix:
          description: The prefix used for auto-generating barcodes for inventory
            items of this schema. Must be unique within the registry and cannot end
            in a digit.
          type: string
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
      required:
      - id
      type: object
    UpdateLongTextFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - LONG_TEXT
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      type: object
    UpdateMatrixPlateInput:
      additionalProperties: false
      properties:
        archiveReason:
          description: Why the plate is archived
          type: string
        archived:
          description: Whether the plate is archived
          type: boolean
        barcode:
          description: Barcode of the plate
          type: string
        name:
          description: Name of the plate; defaults to barcode if name is not provided
          type: string
        parentStorageId:
          type:
          - 'null'
          - string
        projectId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
      type: object
    UpdateMatrixPlateInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          description: Why the plate is archived
          type: string
        archived:
          description: Whether the plate is archived
          type: boolean
        barcode:
          description: Barcode of the plate
          type: string
        id:
          type: string
        name:
          description: Name of the plate; defaults to barcode if name is not provided
          type: string
        parentStorageId:
          type:
          - 'null'
          - string
        projectId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
      required:
      - id
      type: object
    UpdateMatrixPlateSchemaInput:
      additionalProperties: false
      properties:
        archiveReason:
          description: Why the schema was archived.
          type: string
        archived:
          description: Whether the schema is archived.
          type: boolean
        containerSchemaId:
          description: The API ID of the container schema constraining what types
            of containers can be inserted into plates of this type.
          type:
          - 'null'
          - string
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        height:
          description: The number of rows in the grid layout.
          type: integer
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        prefix:
          description: The prefix used for auto-generating barcodes for inventory
            items of this schema. Must be unique within the registry and cannot end
            in a digit.
          type: string
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        width:
          description: The number of columns in the grid layout.
          type: integer
      type: object
    UpdateMatrixPlateSchemaInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          description: Why the schema was archived.
          type: string
        archived:
          description: Whether the schema is archived.
          type: boolean
        containerSchemaId:
          description: The API ID of the container schema constraining what types
            of containers can be inserted into plates of this type.
          type:
          - 'null'
          - string
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        height:
          description: The number of rows in the grid layout.
          type: integer
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        prefix:
          description: The prefix used for auto-generating barcodes for inventory
            items of this schema. Must be unique within the registry and cannot end
            in a digit.
          type: string
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        width:
          description: The number of columns in the grid layout.
          type: integer
      required:
      - id
      type: object
    UpdateMixtureLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent mixture. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - MIXTURE_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateMixtureSchemaInput:
      additionalProperties: false
      properties:
        allowMeasuredIngredients:
          description: 'Whether this mixture schema allows recording measured values
            for ingredients.

            When enabled, users can track actual measured amounts in addition to target
            amounts.'
          type: boolean
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        componentLotStorageEnabled:
          description: 'Whether mixture ingredients can specify their component lot
            as a container and/or entity from inventory.

            Only applicable when allowMeasuredIngredients is true.

            Will be null when allowMeasuredIngredients is false.'
          type:
          - 'null'
          - boolean
        componentLotTextEnabled:
          description: 'Whether mixture ingredients can specify their component lot
            as a text value.

            Only applicable when allowMeasuredIngredients is true.

            Will be null when allowMeasuredIngredients is false.'
          type:
          - 'null'
          - boolean
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateEntitySchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - MIXTURE
          - MORTAR_PESTLE
          - POWDER
          - POWDER_BEAKER
          - RECIPE
          - SOLUTION
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    UpdateMixtureSchemaInputWithPathParams:
      additionalProperties: false
      properties:
        allowMeasuredIngredients:
          description: 'Whether this mixture schema allows recording measured values
            for ingredients.

            When enabled, users can track actual measured amounts in addition to target
            amounts.'
          type: boolean
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        componentLotStorageEnabled:
          description: 'Whether mixture ingredients can specify their component lot
            as a container and/or entity from inventory.

            Only applicable when allowMeasuredIngredients is true.

            Will be null when allowMeasuredIngredients is false.'
          type:
          - 'null'
          - boolean
        componentLotTextEnabled:
          description: 'Whether mixture ingredients can specify their component lot
            as a text value.

            Only applicable when allowMeasuredIngredients is true.

            Will be null when allowMeasuredIngredients is false.'
          type:
          - 'null'
          - boolean
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateEntitySchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - MIXTURE
          - MORTAR_PESTLE
          - POWDER
          - POWDER_BEAKER
          - RECIPE
          - SOLUTION
          type: string
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - id
      type: object
    UpdateMoleculeInput:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        chemicalStructure:
          $ref: '#/components/schemas/ChemicalStructureInput'
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        entityRegistryId:
          type: string
        folderId:
          type: string
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      type: object
    UpdateMoleculeInputWithPathParams:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        chemicalStructure:
          $ref: '#/components/schemas/ChemicalStructureInput'
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        entityRegistryId:
          type: string
        folderId:
          type: string
        id:
          type: string
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - id
      type: object
    UpdateMoleculeLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent molecule. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - MOLECULE_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateMoleculeSchemaInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateMoleculeSchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - SMALL_MOLECULE
          - SMALL_MOLECULE_BEAKER
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    UpdateMoleculeSchemaInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateMoleculeSchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - SMALL_MOLECULE
          - SMALL_MOLECULE_BEAKER
          type: string
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - id
      type: object
    UpdateOligoConjugateLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent Oligo Conjugate.
            Important for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - OLIGO_CONJUGATE_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateOligoConjugateSchemaInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateEntitySchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - NETWORK_WIRED
          - OLIGO
          - OLIGO_V2
          - PRIMER_PAIR
          - PROTEIN
          - RNA_SEQUENCE
          - SEQUENCE
          - SMALL_MOLECULE
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    UpdateOligoConjugateSchemaInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateEntitySchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - NETWORK_WIRED
          - OLIGO
          - OLIGO_V2
          - PRIMER_PAIR
          - PROTEIN
          - RNA_SEQUENCE
          - SEQUENCE
          - SMALL_MOLECULE
          type: string
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - id
      type: object
    UpdateOligoDuplexLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent Oligo Duplex. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - OLIGO_DUPLEX_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateOligoDuplexSchemaInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateEntitySchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - NETWORK_WIRED
          - PRIMER_PAIR
          - SEQUENCE
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    UpdateOligoDuplexSchemaInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateEntitySchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - NETWORK_WIRED
          - PRIMER_PAIR
          - SEQUENCE
          type: string
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - id
      type: object
    UpdatePlateDesignTemplateInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        name:
          type: string
      type: object
    UpdatePlateDesignTemplateInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        id:
          type: string
        name:
          type: string
      required:
      - id
      type: object
    UpdateProcedureRunPlanConditionInput:
      additionalProperties: false
      example:
        description: 100mg/kg treatment group
        methodParametersPlan:
          dataParameterValues:
          - parameterId: schver_Rm4nTvWz
            value:
              value:
                floatValue: 100.0
                type: ft_float
                value: '100.0'
          equipmentValues:
          - equipmentId: schver_Yw3tRsLm
            value:
              value:
                equipment:
                  type: ft_string
                  value: Mixer A
          materialInputValues:
          - materialInputId: schver_Kp8wNmXq
            value:
              value:
                amount:
                  floatValue: 5.0
                  type: ft_float
                  value: '5.0'
                material:
                  targetFiles:
                  - id: bfi_jdf8BV24
                  type: ft_file_link
                  value: Reagent A
        name: High Dose
        replicates:
        - replicateNumber: 1
        - replicateNumber: 2
        templateMethodVersionId: pcmdv_Hn5kRtYw
      properties:
        description:
          description: Description of the condition. Must not exceed 255 characters.
          type: string
        methodParametersPlan:
          description: Pre-filled parameter values for this condition's unit operation.
            Set to null to clear planned values and use defaults upon run creation.
          oneOf:
          - $ref: '#/components/schemas/MethodParametersPlanInput'
          - type: 'null'
        name:
          description: Display name of the condition. Must not be empty and must not
            exceed 255 characters.
          type: string
        replicates:
          description: Replace the full set of replicates for this condition. Must
            contain between 1 and 999 replicates, with consecutive `replicateNumber`
            values starting from 1.
          items:
            $ref: '#/components/schemas/ProcedureRunPlanConditionReplicateInput'
          type: array
        templateMethodVersionId:
          description: The procedure method definition version ID (`pcmdv_XXXXXXXX`)
            this condition belongs to. Update this when the parent run plan's flowchart
            config version has changed and conditions need to point to the new method
            versions.
          type: string
      type: object
    UpdateProcedureRunPlanConditionInputWithPathParams:
      additionalProperties: false
      example:
        description: 100mg/kg treatment group
        id: prpc_Bm7nWsKt
        methodParametersPlan:
          dataParameterValues:
          - parameterId: schver_Rm4nTvWz
            value:
              value:
                floatValue: 100.0
                type: ft_float
                value: '100.0'
          equipmentValues:
          - equipmentId: schver_Yw3tRsLm
            value:
              value:
                equipment:
                  type: ft_string
                  value: Mixer A
          materialInputValues:
          - materialInputId: schver_Kp8wNmXq
            value:
              value:
                amount:
                  floatValue: 5.0
                  type: ft_float
                  value: '5.0'
                material:
                  targetFiles:
                  - id: bfi_jdf8BV24
                  type: ft_file_link
                  value: Reagent A
        name: High Dose
        replicates:
        - replicateNumber: 1
        - replicateNumber: 2
        templateMethodVersionId: pcmdv_Hn5kRtYw
      properties:
        description:
          description: Description of the condition. Must not exceed 255 characters.
          type: string
        id:
          type: string
        methodParametersPlan:
          description: Pre-filled parameter values for this condition's unit operation.
            Set to null to clear planned values and use defaults upon run creation.
          oneOf:
          - $ref: '#/components/schemas/MethodParametersPlanInput'
          - type: 'null'
        name:
          description: Display name of the condition. Must not be empty and must not
            exceed 255 characters.
          type: string
        replicates:
          description: Replace the full set of replicates for this condition. Must
            contain between 1 and 999 replicates, with consecutive `replicateNumber`
            values starting from 1.
          items:
            $ref: '#/components/schemas/ProcedureRunPlanConditionReplicateInput'
          type: array
        templateMethodVersionId:
          description: The procedure method definition version ID (`pcmdv_XXXXXXXX`)
            this condition belongs to. Update this when the parent run plan's flowchart
            config version has changed and conditions need to point to the new method
            versions.
          type: string
      required:
      - id
      type: object
    UpdateProcedureRunPlanInput:
      additionalProperties: false
      example:
        conditionOrder:
        - conditionIds:
          - prpc_Bm7nWsKt
          - prpc_Zq2rPvJx
          templateMethodVersionId: pcmdv_Hn5kRtYw
        confirmationMethodByParamVersionId:
        - confirmationMethod: TABLE
          paramVersionId: schver_Rm4nTvWz
        dataEntryMode: INDIVIDUAL_CONDITION_REPLICATES
        description: Updated dose-response plan
        workflowFlowchartConfigVersionId: wffccv_Lk3mQpXn
      properties:
        conditionOrder:
          description: Reorder existing conditions per procedure method definition
            version (PMDV). For each PMDV included, **all** existing condition IDs
            for that PMDV in the plan must be present exactly once. The order of IDs
            in `conditionIds` determines the new display positions (0-indexed).
          items:
            $ref: '#/components/schemas/ConditionOrderForPmdvInput'
          type: array
        confirmationMethodByParamVersionId:
          description: Replace the confirmation method overrides for specific procedure
            parameters. Pass an empty array to clear all overrides.
          items:
            $ref: '#/components/schemas/ConfirmationMethodByParamVersionIdInput'
          type: array
        dataEntryMode:
          description: Controls how data entry worksheets are created upon promotion.
            `INDIVIDUAL_CONDITION_REPLICATES` creates one worksheet per condition-replicate.
            `ALL_CONDITION_REPLICATES_TOGETHER` creates a single shared worksheet
            (not supported for assay run plans).
          enum:
          - INDIVIDUAL_CONDITION_REPLICATES
          - ALL_CONDITION_REPLICATES_TOGETHER
          type: string
        description:
          description: A human-readable description of the run plan. Must not exceed
            255 characters.
          type: string
        workflowFlowchartConfigVersionId:
          description: 'The ID of the workflow flowchart config version to switch
            to. Format: `wffccv_XXXXXXXX`. When changed, existing conditions should
            be updated to reference method versions in the new flowchart. Set to null
            to clear the linked procedure flowchart version.'
          type:
          - 'null'
          - string
      type: object
    UpdateProcedureRunPlanInputWithPathParams:
      additionalProperties: false
      example:
        conditionOrder:
        - conditionIds:
          - prpc_Bm7nWsKt
          - prpc_Zq2rPvJx
          templateMethodVersionId: pcmdv_Hn5kRtYw
        confirmationMethodByParamVersionId:
        - confirmationMethod: TABLE
          paramVersionId: schver_Rm4nTvWz
        dataEntryMode: INDIVIDUAL_CONDITION_REPLICATES
        description: Updated dose-response plan
        id: prp_Xk9mLpQr
        workflowFlowchartConfigVersionId: wffccv_Lk3mQpXn
      properties:
        conditionOrder:
          description: Reorder existing conditions per procedure method definition
            version (PMDV). For each PMDV included, **all** existing condition IDs
            for that PMDV in the plan must be present exactly once. The order of IDs
            in `conditionIds` determines the new display positions (0-indexed).
          items:
            $ref: '#/components/schemas/ConditionOrderForPmdvInput'
          type: array
        confirmationMethodByParamVersionId:
          description: Replace the confirmation method overrides for specific procedure
            parameters. Pass an empty array to clear all overrides.
          items:
            $ref: '#/components/schemas/ConfirmationMethodByParamVersionIdInput'
          type: array
        dataEntryMode:
          description: Controls how data entry worksheets are created upon promotion.
            `INDIVIDUAL_CONDITION_REPLICATES` creates one worksheet per condition-replicate.
            `ALL_CONDITION_REPLICATES_TOGETHER` creates a single shared worksheet
            (not supported for assay run plans).
          enum:
          - INDIVIDUAL_CONDITION_REPLICATES
          - ALL_CONDITION_REPLICATES_TOGETHER
          type: string
        description:
          description: A human-readable description of the run plan. Must not exceed
            255 characters.
          type: string
        id:
          type: string
        workflowFlowchartConfigVersionId:
          description: 'The ID of the workflow flowchart config version to switch
            to. Format: `wffccv_XXXXXXXX`. When changed, existing conditions should
            be updated to reference method versions in the new flowchart. Set to null
            to clear the linked procedure flowchart version.'
          type:
          - 'null'
          - string
      required:
      - id
      type: object
    UpdateProjectInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type:
          - 'null'
          - string
        hideParentFolderNamesForSharedItems:
          type: boolean
        lockSequences:
          type: boolean
        name:
          type: string
        ownerId:
          type: string
        public:
          type: boolean
      type: object
    UpdateProjectInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type:
          - 'null'
          - string
        hideParentFolderNamesForSharedItems:
          type: boolean
        id:
          type: string
        lockSequences:
          type: boolean
        name:
          type: string
        ownerId:
          type: string
        public:
          type: boolean
      required:
      - id
      type: object
    UpdateProteinFormatInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        name:
          description: The display name of the protein format.
          type: string
      type: object
    UpdateProteinFormatInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        id:
          type: string
        name:
          description: The display name of the protein format.
          type: string
      required:
      - id
      type: object
    UpdateProteinInput:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        chains:
          description: A chain input for each chain on the relevant format. Must be
            all provided if domains are provided.
          items:
            $ref: '#/components/schemas/ProteinChainInput'
          type: array
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        domains:
          description: A domain input for each domain on the relevant format. If any
            are provided, all must be provided.
          items:
            $ref: '#/components/schemas/ProteinDomainInput'
          type: array
        entityRegistryId:
          type: string
        folderId:
          type: string
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
        studyIds:
          description: Study IDs to add the protein to.
          items:
            type: string
          type: array
      type: object
    UpdateProteinInputWithPathParams:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        chains:
          description: A chain input for each chain on the relevant format. Must be
            all provided if domains are provided.
          items:
            $ref: '#/components/schemas/ProteinChainInput'
          type: array
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        domains:
          description: A domain input for each domain on the relevant format. If any
            are provided, all must be provided.
          items:
            $ref: '#/components/schemas/ProteinDomainInput'
          type: array
        entityRegistryId:
          type: string
        folderId:
          type: string
        id:
          type: string
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
        studyIds:
          description: Study IDs to add the protein to.
          items:
            type: string
          type: array
      required:
      - id
      type: object
    UpdateReactionInput:
      additionalProperties: false
      example:
        archiveReason: Made in error
        archived: true
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
      type: object
    UpdateReactionInputWithPathParams:
      additionalProperties: false
      example:
        archiveReason: Made in error
        archived: true
        id: rxn_Xk9mLpQr
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        id:
          type: string
      required:
      - id
      type: object
    UpdateRequestV2DefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          description: Description of the request template.
          type: string
        name:
          type: string
        prefix:
          description: The prefix for the displayId of tasks of this schema.
          type: string
        templateCollectionId:
          type: string
      type: object
    UpdateRequestV2DefinitionInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          description: Description of the request template.
          type: string
        id:
          type: string
        name:
          type: string
        prefix:
          description: The prefix for the displayId of tasks of this schema.
          type: string
        templateCollectionId:
          type: string
      required:
      - id
      type: object
    UpdateResultInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
      type: object
    UpdateResultInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        id:
          type: string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
      required:
      - id
      type: object
    UpdateRnaOligoInput:
      additionalProperties: false
      properties:
        aliases:
          description: Array of aliases
          items:
            type: string
          type: array
        annotations:
          description: Annotations on the Oligo.
          items:
            $ref: '#/components/schemas/OligoAnnotationInput'
          type: array
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        bases:
          description: Bases of the Oligo.
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          description: Custom fields set on the Oligo.
          type: object
        customNotation:
          type: string
        customNotationId:
          type: string
        entityRegistryId:
          description: Registry ID of the Oligo if registered.
          type: string
        folderId:
          type: string
        helm:
          type: string
        name:
          description: Name of the Oligo.
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      type: object
    UpdateRnaOligoInputWithPathParams:
      additionalProperties: false
      properties:
        aliases:
          description: Array of aliases
          items:
            type: string
          type: array
        annotations:
          description: Annotations on the Oligo.
          items:
            $ref: '#/components/schemas/OligoAnnotationInput'
          type: array
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        bases:
          description: Bases of the Oligo.
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          description: Custom fields set on the Oligo.
          type: object
        customNotation:
          type: string
        customNotationId:
          type: string
        entityRegistryId:
          description: Registry ID of the Oligo if registered.
          type: string
        folderId:
          type: string
        helm:
          type: string
        id:
          type: string
        name:
          description: Name of the Oligo.
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
      required:
      - id
      type: object
    UpdateRnaOligoLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent RNA Oligo. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - RNA_OLIGO_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateRnaOligoSchemaInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateSequenceSchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - OLIGO
          - OLIGO_V2
          - SEQUENCE
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        showResidues:
          description: Controls whether RNA residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    UpdateRnaOligoSchemaInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateSequenceSchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - OLIGO
          - OLIGO_V2
          - SEQUENCE
          type: string
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        showResidues:
          description: Controls whether RNA residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - id
      type: object
    UpdateRnaSequenceInput:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        annotations:
          description: 'Annotations on the RNA sequence, not including translations
            or primers. Annotations on parts are

            not included.'
          items:
            $ref: '#/components/schemas/RnaAnnotationInput'
          type: array
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        bases:
          description: Bases of the RNA sequence.
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        customNotation:
          type:
          - 'null'
          - string
        customNotationId:
          type:
          - 'null'
          - string
        entityRegistryId:
          type: string
        folderId:
          type: string
        helm:
          type: string
        isCircular:
          description: Field will be set to false if not specified.
          type: boolean
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        parts:
          description: Part features on the RNA sequence.
          items:
            $ref: '#/components/schemas/RnaPartInput'
          type: array
        primers:
          description: Primer bind features on the RNA sequence. Primers on parts
            are not included.
          items:
            $ref: '#/components/schemas/PrimerInput'
          type: array
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
        translations:
          description: 'Translation annotations present on the RNA sequence. Translations
            may be one region or split

            across multiple regions. Translations on parts are not included.'
          items:
            $ref: '#/components/schemas/RnaTranslationInput'
          type: array
      type: object
    UpdateRnaSequenceInputWithPathParams:
      additionalProperties: false
      properties:
        aliases:
          items:
            type: string
          type: array
        annotations:
          description: 'Annotations on the RNA sequence, not including translations
            or primers. Annotations on parts are

            not included.'
          items:
            $ref: '#/components/schemas/RnaAnnotationInput'
          type: array
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          items:
            type: string
          type: array
        bases:
          description: Bases of the RNA sequence.
          type: string
        customFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        customNotation:
          type:
          - 'null'
          - string
        customNotationId:
          type:
          - 'null'
          - string
        entityRegistryId:
          type: string
        folderId:
          type: string
        helm:
          type: string
        id:
          type: string
        isCircular:
          description: Field will be set to false if not specified.
          type: boolean
        name:
          type: string
        namingStrategy:
          enum:
          - NEW_IDS
          - IDS_FROM_NAMES
          - DELETE_NAMES
          - SET_FROM_NAME_PARTS
          - REPLACE_NAMES_FROM_PARTS
          - KEEP_NAMES
          - REPLACE_ID_AND_NAME_FROM_PARTS
          type: string
        parts:
          description: Part features on the RNA sequence.
          items:
            $ref: '#/components/schemas/RnaPartInput'
          type: array
        primers:
          description: Primer bind features on the RNA sequence. Primers on parts
            are not included.
          items:
            $ref: '#/components/schemas/PrimerInput'
          type: array
        registryId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        schemaId:
          type: string
        translations:
          description: 'Translation annotations present on the RNA sequence. Translations
            may be one region or split

            across multiple regions. Translations on parts are not included.'
          items:
            $ref: '#/components/schemas/RnaTranslationInput'
          type: array
      required:
      - id
      type: object
    UpdateRnaSequenceLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent RNA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - RNA_SEQUENCE_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateRnaSequenceSchemaInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateSequenceSchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - OLIGO_V2
          - PRIMER_PAIR
          - RNA_SEQUENCE
          - SEQUENCE
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        showResidues:
          description: Controls whether RNA residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      type: object
    UpdateRnaSequenceSchemaInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        availableRegistrationNamingOptions:
          items:
            enum:
            - NEW_IDS
            - IDS_FROM_NAMES
            - DELETE_NAMES
            - SET_FROM_NAME_PARTS
            - REPLACE_NAMES_FROM_PARTS
            - KEEP_NAMES
            - REPLACE_ID_AND_NAME_FROM_PARTS
            type: string
          type: array
        constraint:
          oneOf:
          - $ref: '#/components/schemas/CreateSequenceSchemaConstraintInput'
          - type: 'null'
        containerNameTemplate:
          description: Replaces all existing container name template parts. Legacy
            datetimeFormat configurations are not preserved.
          oneOf:
          - $ref: '#/components/schemas/ContainerNameTemplateInput'
          - type: 'null'
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        iconId:
          enum:
          - BASIC_FOLDER_ITEM
          - LINEAR
          - OLIGO_V2
          - PRIMER_PAIR
          - RNA_SEQUENCE
          - SEQUENCE
          type: string
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        includeRegistryIdInChips:
          type: boolean
        isContainable:
          type: boolean
        itemIdPrefix:
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        nameTemplate:
          description: Replaces all existing entity name template parts. Legacy datetimeFormat
            configurations are not preserved. Updating the name template does not
            automatically modify availableRegistrationNamingOptions — update that
            field separately if needed.
          oneOf:
          - $ref: '#/components/schemas/EntityNameTemplateInput'
          - type: 'null'
        showResidues:
          description: Controls whether RNA residues are displayed in the UI.
          type: boolean
        systemCategories:
          items:
            $ref: '#/components/schemas/SystemCategoryConfigurationInputBase'
          type: array
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        useRegistryIdForItemDisplayLabel:
          type: boolean
      required:
      - id
      type: object
    UpdateScratchFileInput:
      additionalProperties: false
      properties:
        errorMessage:
          type:
          - 'null'
          - string
        uploadStatus:
          enum:
          - SUCCEEDED
          - FAILED_VALIDATION
          - IN_PROGRESS
          - NOT_UPLOADED
          type: string
      required:
      - uploadStatus
      type: object
    UpdateScratchFileInputWithPathParams:
      additionalProperties: false
      properties:
        errorMessage:
          type:
          - 'null'
          - string
        id:
          type: string
        uploadStatus:
          enum:
          - SUCCEEDED
          - FAILED_VALIDATION
          - IN_PROGRESS
          - NOT_UPLOADED
          type: string
      required:
      - id
      - uploadStatus
      type: object
    UpdateScratchPlateInput:
      additionalProperties: false
      properties:
        concentrationLayers:
          items:
            $ref: '#/components/schemas/ConcentrationLayerInput'
          type: array
        height:
          type: integer
        metadataLayers:
          items:
            $ref: '#/components/schemas/MetadataColumnInput'
          type: array
        name:
          type: string
        parameterLayers:
          items:
            $ref: '#/components/schemas/ParameterLayerInput'
          type: array
        plateSchemaId:
          type:
          - 'null'
          - string
        storageId:
          description: Inventory storage ID to record as a plate field in the metadata
            layer.
          type: string
        wells:
          items:
            $ref: '#/components/schemas/ScratchPlateWellInput'
          type: array
        width:
          type: integer
      type: object
    UpdateScratchPlateInputWithPathParams:
      additionalProperties: false
      properties:
        concentrationLayers:
          items:
            $ref: '#/components/schemas/ConcentrationLayerInput'
          type: array
        height:
          type: integer
        id:
          type: string
        metadataLayers:
          items:
            $ref: '#/components/schemas/MetadataColumnInput'
          type: array
        name:
          type: string
        parameterLayers:
          items:
            $ref: '#/components/schemas/ParameterLayerInput'
          type: array
        plateSchemaId:
          type:
          - 'null'
          - string
        storageId:
          description: Inventory storage ID to record as a plate field in the metadata
            layer.
          type: string
        wells:
          items:
            $ref: '#/components/schemas/ScratchPlateWellInput'
          type: array
        width:
          type: integer
      required:
      - id
      type: object
    UpdateSqlDashboardBlockInput:
      additionalProperties: false
      properties:
        description:
          description: A human-readable description of the block.
          type: string
        name:
          description: The display name of the block.
          type: string
        sqlQuery:
          description: The SQL query executed against the Benchling data warehouse.
            May reference dashboard parameters using {{parameter_name}} placeholder
            syntax.
          type: string
      type: object
    UpdateSqlDashboardBlockInputWithPathParams:
      additionalProperties: false
      properties:
        description:
          description: A human-readable description of the block.
          type: string
        id:
          type: string
        name:
          description: The display name of the block.
          type: string
        sqlQuery:
          description: The SQL query executed against the Benchling data warehouse.
            May reference dashboard parameters using {{parameter_name}} placeholder
            syntax.
          type: string
      required:
      - id
      type: object
    UpdateStorableLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type:
          - 'null'
          - string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - STORAGE_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateStudyInput:
      additionalProperties: false
      example:
        archiveReason: Archived
        archived: true
        authorIds:
        - ent_a0SApq3z
        - ent_t40Vb4aA
        description: Updated Study Description
        displayId: CSWNAR1
        folderId: lib_o2thOLlq
        name: Updated Study Name
        phase: EXECUTION
        schemaFields:
          boolean_field_system_name:
            value: false
          date_field_system_name:
            value: '2025-06-15'
          datetime_field_system_name:
            value: '2025-06-15T09:00:00Z'
          dropdown_field_system_name:
            value: sfso_UcQuhAwx
          entity_field_system_name:
            value:
            - bfi_jdf8BV24
          number_field_system_name:
            value: 456
          text_field_system_name:
            value: Updated text value
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          description: The IDs of the users or apps to set as study authors. Omit
            to leave authors unchanged. Pass an empty array to clear all authors.
          items:
            type: string
          type: array
        description:
          type: string
        displayId:
          type: string
        fieldValues:
          deprecated: true
          description: Use schemaFields instead.
          items:
            $ref: '#/components/schemas/UpdateFieldValueInput'
          type: array
        folderId:
          type: string
        name:
          type: string
        phase:
          enum:
          - DESIGN
          - EXECUTION
          - COMPLETE
          type: string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
      type: object
    UpdateStudyInputWithPathParams:
      additionalProperties: false
      example:
        archiveReason: Archived
        archived: true
        authorIds:
        - ent_a0SApq3z
        - ent_t40Vb4aA
        description: Updated Study Description
        displayId: CSWNAR1
        folderId: lib_o2thOLlq
        id: stdy_9CYiCggY
        name: Updated Study Name
        phase: EXECUTION
        schemaFields:
          boolean_field_system_name:
            value: false
          date_field_system_name:
            value: '2025-06-15'
          datetime_field_system_name:
            value: '2025-06-15T09:00:00Z'
          dropdown_field_system_name:
            value: sfso_UcQuhAwx
          entity_field_system_name:
            value:
            - bfi_jdf8BV24
          number_field_system_name:
            value: 456
          text_field_system_name:
            value: Updated text value
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        authorIds:
          description: The IDs of the users or apps to set as study authors. Omit
            to leave authors unchanged. Pass an empty array to clear all authors.
          items:
            type: string
          type: array
        description:
          type: string
        displayId:
          type: string
        fieldValues:
          deprecated: true
          description: Use schemaFields instead.
          items:
            $ref: '#/components/schemas/UpdateFieldValueInput'
          type: array
        folderId:
          type: string
        id:
          type: string
        name:
          type: string
        phase:
          enum:
          - DESIGN
          - EXECUTION
          - COMPLETE
          type: string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
      required:
      - id
      type: object
    UpdateStudySchemaInput:
      additionalProperties: false
      example:
        entryTemplateIds:
        - etr_kT6BHBdZ
        - etr_3wievUIJ
        isDesignApprovalRequired: false
        name: Phase II Clinical Study (Updated)
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        entryTemplateIds:
          description: Replacement entry template IDs for this schema.
          items:
            type: string
          type: array
        idGenerationMode:
          description: Updated study ID generation mode. Changing this setting only
            affects studies created from now on; existing studies keep their IDs.
            When switching to AUTO_GENERATED_FROM_PREFIX, numbering continues from
            the highest existing ID that uses the prefix. When switching to MANUAL,
            the prefix is automatically cleared if no prefix value is provided.
          enum:
          - AUTO_GENERATED_FROM_PREFIX
          - MANUAL
          type: string
        isDesignApprovalRequired:
          description: Updated design approval requirement.
          type: boolean
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        prefix:
          description: Updated ID prefix for this schema.
          type: string
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
      type: object
    UpdateStudySchemaInputWithPathParams:
      additionalProperties: false
      example:
        entryTemplateIds:
        - etr_kT6BHBdZ
        - etr_3wievUIJ
        id: stdysch_ztQQGSSF
        isDesignApprovalRequired: false
        name: Phase II Clinical Study (Updated)
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        entryTemplateIds:
          description: Replacement entry template IDs for this schema.
          items:
            type: string
          type: array
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        idGenerationMode:
          description: Updated study ID generation mode. Changing this setting only
            affects studies created from now on; existing studies keep their IDs.
            When switching to AUTO_GENERATED_FROM_PREFIX, numbering continues from
            the highest existing ID that uses the prefix. When switching to MANUAL,
            the prefix is automatically cleared if no prefix value is provided.
          enum:
          - AUTO_GENERATED_FROM_PREFIX
          - MANUAL
          type: string
        isDesignApprovalRequired:
          description: Updated design approval requirement.
          type: boolean
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        prefix:
          description: Updated ID prefix for this schema.
          type: string
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
      required:
      - id
      type: object
    UpdateSystemCategoryLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - SYSTEM_CATEGORY_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateTestDefinitionInput:
      additionalProperties: false
      example:
        archived: false
        description: Updated set of blood chemistry measurements collected for study
          samples.
        name: Updated Blood Chemistry Panel
        organizationId: org_v7Q9m2Kx
        resultSchemaId: assaysch_Z3xY7vQb
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          description: Updated human-readable description. Empty strings are allowed;
            values must be at most 255 characters.
          type: string
        name:
          description: Updated display name. When provided, it is trimmed and must
            be non-empty and unique within the organization.
          type: string
        organizationId:
          description: Updated owning organization. Use `GET /benchling/organization/items`
            to find organization IDs.
          type: string
        resultSchemaId:
          description: Updated result schema. Use `GET /benchling/result-schema/items`
            to find result schema IDs. Cannot be changed after test orders have been
            created for this test definition.
          type: string
      type: object
    UpdateTestDefinitionInputWithPathParams:
      additionalProperties: false
      example:
        archived: false
        description: Updated set of blood chemistry measurements collected for study
          samples.
        id: tdef_J8mQ2xY7
        name: Updated Blood Chemistry Panel
        organizationId: org_v7Q9m2Kx
        resultSchemaId: assaysch_Z3xY7vQb
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          description: Updated human-readable description. Empty strings are allowed;
            values must be at most 255 characters.
          type: string
        id:
          description: The API ID of the test definition to update.
          type: string
        name:
          description: Updated display name. When provided, it is trimmed and must
            be non-empty and unique within the organization.
          type: string
        organizationId:
          description: Updated owning organization. Use `GET /benchling/organization/items`
            to find organization IDs.
          type: string
        resultSchemaId:
          description: Updated result schema. Use `GET /benchling/result-schema/items`
            to find result schema IDs. Cannot be changed after test orders have been
            created for this test definition.
          type: string
      required:
      - id
      type: object
    UpdateTextFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isRequired:
          type: boolean
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - TEXT
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      type: object
    UpdateTranscriptionLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent RNA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - TRANSCRIPTION_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateTranslationLinkFieldDefinitionInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        description:
          type: string
        id:
          type: string
        isMulti:
          type: boolean
        isParent:
          description: 'Means the link is from a child to a parent AA sequence. Important
            for the registry''s lot-numbering

            functionality.'
          type: boolean
        isRequired:
          type: boolean
        linkDefinitionId:
          type: string
        name:
          type: string
        systemName:
          type: string
        type:
          enum:
          - TRANSLATION_LINK
          type: string
      required:
      - id
      - name
      - systemName
      - isRequired
      - type
      - isMulti
      - linkDefinitionId
      type: object
    UpdateUnitInput:
      additionalProperties: false
      properties:
        aliases:
          description: Any additional short-form labels that should be recognized
            in input
          items:
            type: string
          type: array
        archiveReason:
          type: string
        archived:
          type: boolean
        name:
          type: string
        symbol:
          type: string
      type: object
    UpdateUnitInputWithPathParams:
      additionalProperties: false
      properties:
        aliases:
          description: Any additional short-form labels that should be recognized
            in input
          items:
            type: string
          type: array
        archiveReason:
          type: string
        archived:
          type: boolean
        id:
          type: string
        name:
          type: string
        symbol:
          type: string
      required:
      - id
      type: object
    UpdateUnitTypeInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        formula:
          items:
            $ref: '#/components/schemas/CreateFormulaUnitTermInput'
          type: array
        name:
          type: string
        overrideIsConcentration:
          description: When true, forces this UnitType to be treated as a concentration
            type regardless of its terms. When false, the classification is determined
            by the UnitType's terms. Mutually exclusive with `overrideIsContainerQuantity`.
          type: boolean
        overrideIsContainerQuantity:
          description: When true, forces this UnitType to be treated as a container
            quantity type regardless of its terms. When false, the classification
            is determined by the UnitType's terms. Mutually exclusive with `overrideIsConcentration`.
          type: boolean
        terms:
          items:
            $ref: '#/components/schemas/CreateUnitTypeTermInput'
          type: array
      type: object
    UpdateUnitTypeInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        formula:
          items:
            $ref: '#/components/schemas/CreateFormulaUnitTermInput'
          type: array
        id:
          type: string
        name:
          type: string
        overrideIsConcentration:
          description: When true, forces this UnitType to be treated as a concentration
            type regardless of its terms. When false, the classification is determined
            by the UnitType's terms. Mutually exclusive with `overrideIsContainerQuantity`.
          type: boolean
        overrideIsContainerQuantity:
          description: When true, forces this UnitType to be treated as a container
            quantity type regardless of its terms. When false, the classification
            is determined by the UnitType's terms. Mutually exclusive with `overrideIsConcentration`.
          type: boolean
        terms:
          items:
            $ref: '#/components/schemas/CreateUnitTypeTermInput'
          type: array
      required:
      - id
      type: object
    UpdateWarehouseCredentialInput:
      additionalProperties: false
      properties:
        revoked:
          description: Indicates whether or not the WarehouseCredential has been revoked.
            When a WarehouseCredential is revoked, the credentials are deleted in
            the warehouse and can not be reactivated. The only valid value for this
            field is `true`.
          type: boolean
      required:
      - revoked
      type: object
    UpdateWarehouseCredentialInputWithPathParams:
      additionalProperties: false
      properties:
        id:
          type: string
        revoked:
          description: Indicates whether or not the WarehouseCredential has been revoked.
            When a WarehouseCredential is revoked, the credentials are deleted in
            the warehouse and can not be reactivated. The only valid value for this
            field is `true`.
          type: boolean
      required:
      - id
      - revoked
      type: object
    UpdateWellPlateInput:
      additionalProperties: false
      properties:
        archiveReason:
          description: Why the plate is archived
          type: string
        archived:
          description: Whether the plate is archived
          type: boolean
        barcode:
          description: Barcode of the plate
          type: string
        name:
          description: Name of the plate; defaults to barcode if name is not provided
          type: string
        parentStorageId:
          type:
          - 'null'
          - string
        projectId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          description: Schema field values that belong to the plate
          type: object
      type: object
    UpdateWellPlateInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          description: Why the plate is archived
          type: string
        archived:
          description: Whether the plate is archived
          type: boolean
        barcode:
          description: Barcode of the plate
          type: string
        id:
          type: string
        name:
          description: Name of the plate; defaults to barcode if name is not provided
          type: string
        parentStorageId:
          type:
          - 'null'
          - string
        projectId:
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          description: Schema field values that belong to the plate
          type: object
      required:
      - id
      type: object
    UpdateWellPlateSchemaInput:
      additionalProperties: false
      properties:
        archiveReason:
          description: Why the schema was archived.
          type: string
        archived:
          description: Whether the schema is archived.
          type: boolean
        containerSchemaId:
          description: The API ID of the container schema defining the well type for
            plates of this type.
          type: string
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        height:
          description: The number of rows in the grid layout.
          type: integer
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        prefix:
          description: The prefix used for auto-generating barcodes for inventory
            items of this schema. Must be unique within the registry and cannot end
            in a digit.
          type: string
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        width:
          description: The number of columns in the grid layout.
          type: integer
      type: object
    UpdateWellPlateSchemaInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          description: Why the schema was archived.
          type: string
        archived:
          description: Whether the schema is archived.
          type: boolean
        containerSchemaId:
          description: The API ID of the container schema defining the well type for
            plates of this type.
          type: string
        description:
          description: Updated description. When provided, must be at most 1000 characters.
          type: string
        displayName:
          deprecated: true
          description: Deprecated. Use name instead.
          type: string
        height:
          description: The number of rows in the grid layout.
          type: integer
        id:
          description: The API ID of the schema to update. The schema must exist and
            be accessible.
          type: string
        name:
          description: Updated user-facing name. When provided, must be non-empty
            after stripping whitespace, at most 255 characters, and unique within
            the organization.
          type: string
        prefix:
          description: The prefix used for auto-generating barcodes for inventory
            items of this schema. Must be unique within the registry and cannot end
            in a digit.
          type: string
        systemName:
          description: Updated SQL identifier for the warehouse table name. When provided,
            must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name,
            cannot start with 'bnch$', and must be unique within the organization.
          type: string
        width:
          description: The number of columns in the grid layout.
          type: integer
      required:
      - id
      type: object
    UpdateWorkflowOutputInput:
      additionalProperties: false
      properties:
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
      type: object
    UpdateWorkflowOutputInputWithPathParams:
      additionalProperties: false
      properties:
        id:
          type: string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
      required:
      - id
      type: object
    UpdateWorkflowTaskGroupInput:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        name:
          description: The name of the workflow task group
          type: string
        watcherIds:
          items:
            type: string
          type: array
      type: object
    UpdateWorkflowTaskGroupInputWithPathParams:
      additionalProperties: false
      properties:
        archiveReason:
          type: string
        archived:
          type: boolean
        id:
          type: string
        name:
          description: The name of the workflow task group
          type: string
        watcherIds:
          items:
            type: string
          type: array
      required:
      - id
      type: object
    UpdateWorkflowTaskInput:
      additionalProperties: false
      properties:
        assigneeId:
          type:
          - 'null'
          - string
        scheduledOn:
          description: The date on which the task is scheduled to be executed
          format: date
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        status:
          description: The status of this task
          enum:
          - PENDING
          - PLANNED
          - IN_PROGRESS
          - FAILED
          - CANCELLED
          - INVALID
          - COMPLETED
          - COMPLETED_AFTER_REVIEW
          - ACTIVE
          - SKIPPED
          - NOT_READY
          - READY
          type: string
        studyIds:
          items:
            type: string
          type: array
      type: object
    UpdateWorkflowTaskInputWithPathParams:
      additionalProperties: false
      properties:
        assigneeId:
          type:
          - 'null'
          - string
        id:
          type: string
        scheduledOn:
          description: The date on which the task is scheduled to be executed
          format: date
          type:
          - 'null'
          - string
        schemaFields:
          additionalProperties:
            $ref: '#/components/schemas/FieldValueInput'
          type: object
        status:
          description: The status of this task
          enum:
          - PENDING
          - PLANNED
          - IN_PROGRESS
          - FAILED
          - CANCELLED
          - INVALID
          - COMPLETED
          - COMPLETED_AFTER_REVIEW
          - ACTIVE
          - SKIPPED
          - NOT_READY
          - READY
          type: string
        studyIds:
          items:
            type: string
          type: array
      required:
      - id
      type: object
    UpdateWorklistInput:
      additionalProperties: false
      properties:
        addItemIds:
          description: Add items to the worklist (incremental)
          items:
            type: string
          type: array
        itemIds:
          description: Set/replace all items in the worklist
          items:
            type: string
          type: array
        name:
          type: string
        removeItemIds:
          description: Remove items from the worklist by API ID (incremental)
          items:
            type: string
          type: array
      type: object
    UpdateWorklistInputWithPathParams:
      additionalProperties: false
      properties:
        addItemIds:
          description: Add items to the worklist (incremental)
          items:
            type: string
          type: array
        id:
          type: string
        itemIds:
          description: Set/replace all items in the worklist
          items:
            type: string
          type: array
        name:
          type: string
        removeItemIds:
          description: Remove items from the worklist by API ID (incremental)
          items:
            type: string
          type: array
      required:
      - id
      type: object
    UseNameAsBarcodeInput:
      additionalProperties: false
      properties:
        barcodeMode:
          enum:
          - USE_NAME
          type: string
        useNameAsBarcode:
          type: boolean
      required:
      - barcodeMode
      - useNameAsBarcode
      type: object
    User:
      description: 'Represents a human user in Benchling who can log in, perform actions,
        and own data.

        Users belong to one or more Organizations and may be members of Teams within
        those

        organizations. As an Owner, users can own Projects, Folders, and other resources.

        As a Principal, users can be assigned as reviewers, authors, or collaborators
        on

        various items. Users have attributes like email and username for identification.

        Users are distinct from `ServicePrincipal`, which represents non-human service

        accounts used for integrations.'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type: string
        email:
          type: string
        id:
          type: string
        lastSeen:
          format: datetime
          type:
          - 'null'
          - string
        modifiedAt:
          format: datetime
          type: string
        name:
          type:
          - 'null'
          - string
        status:
          enum:
          - ACTIVE
          - SUSPENDED
          type: string
        username:
          type: string
      type: object
    UserPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/User'
          type: array
        nextToken:
          type: string
      type: object
    UserRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    V3EventBase:
      description: Fields common to every v3 event message.
      properties:
        createdAt:
          description: RFC 3339 timestamp of when the event was created.
          format: date-time
          type: string
        deprecated:
          description: Whether this event type is deprecated.
          type: boolean
        id:
          description: API ID of the event.
          examples:
          - evt_1jdbvuo2740aslk
          type: string
        resourceId:
          description: API ID of the resource the event is about.
          examples:
          - seq_1jdbvuo2740aslk
          type: string
        stability:
          description: Stability of the resource type the event is about.
          enum:
          - stable
          - beta
          type: string
        type:
          description: The event type.
          examples:
          - v3.dnaSequence.created
          type: string
      required:
      - id
      - type
      - createdAt
      - resourceId
      - stability
      - deprecated
      type: object
    V3UpdateEventBase:
      allOf:
      - $ref: '#/components/schemas/V3EventBase'
      - properties:
          properties:
            description: Names of the properties that changed.
            examples:
            - - name
              - folderId
            items:
              type: string
            type: array
        required:
        - properties
        type: object
      description: Fields common to every v3 update event message.
    WarehouseCredential:
      description: 'Represents credentials for connecting to Benchling''s data warehouse,
        enabling users to query data

        using SQL tools like database clients or BI platforms. This includes all warehouse
        login types:

        user-generated Direct Access credentials, as well as temporary Insights and
        Agent credentials.

        Each WarehouseCredential is tied to a specific Benchling `user` whose permissions
        determine what

        data is accessible through those credentials. Credentials can have an optional
        `expiresAt` date

        for time-limited access and can be permanently disabled via the `revoked`
        flag. Once revoked,

        credentials cannot be reactivated. Users can create multiple credentials (up
        to a per-user limit)

        with different `label` values to distinguish between uses.'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        expiresAt:
          description: 'The time after which new connections using the username/password
            will

            not be permitted. Upon expiration, currently open connections are not

            terminated.'
          format: datetime
          type:
          - 'null'
          - string
        id:
          type: string
        label:
          description: An optional label defined by the user who created the WarehouseCredential.
          type:
          - 'null'
          - string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        revoked:
          description: 'Indicates whether or not the WarehouseCredential has been
            revoked.

            When a WarehouseCredential is revoked, the credentials are deleted in
            the

            warehouse and can not be reactivated.'
          type: boolean
        user:
          $ref: '#/components/schemas/PrincipalRef'
          description: The Benchling user whose permissions are used when creating
            the WarehouseCredential
        username:
          description: The username to connect to the warehouse.
          type: string
      type: object
    WarehouseCredentialPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/WarehouseCredential'
          type: array
        nextToken:
          type: string
      type: object
    WarehouseCredentialRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    WarehouseCustomView:
      description: 'A custom SQL view created by users in Benchling''s data warehouse,
        allowing them to

        define reusable queries that can be accessed like tables.

        Views appear in a dedicated schema and can be queried via Insights Dashboards
        or Direct Access.

        View names are unique within the tenant.

        View''s `viewQuery` field contains the SQL SELECT statement that defines the
        view.

        View''s `existsInWarehouse` flag indicates whether the view exists in the
        warehouse. It is updated

        asynchronously, so it may be out of date for a brief period of time.'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        description:
          type: string
        existsInWarehouse:
          type: boolean
        id:
          type: string
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type: string
        viewQuery:
          type: string
      type: object
    WarehouseCustomViewPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/WarehouseCustomView'
          type: array
        nextToken:
          type: string
      type: object
    WebhookApp:
      description: The Benchling App the webhook was delivered to.
      properties:
        id:
          description: API ID of the app.
          examples:
          - app_1jdbvuo2740aslk
          type: string
      required:
      - id
      type: object
    WebhookAppDefinition:
      description: The app definition the receiving app was installed from.
      properties:
        id:
          description: API ID of the app definition.
          examples:
          - appdef_1jdbvuo2740aslk
          type:
          - 'null'
          - string
        versionNumber:
          description: Version of the app definition the receiving app is installed
            at.
          examples:
          - 0.0.1
          type: string
      required:
      - id
      - versionNumber
      type: object
    WebhookEnvelopeBaseV0:
      description: Fields common to every webhook request body. The event itself is
        carried in the `message` property of the event-specific payload.
      properties:
        app:
          $ref: '#/components/schemas/WebhookApp'
        appDefinition:
          $ref: '#/components/schemas/WebhookAppDefinition'
        baseURL:
          description: Base URL of the tenant the webhook was sent from.
          examples:
          - https://mytenant.benchling.com
          type: string
        tenantId:
          description: Global ID of the tenant the webhook was sent from.
          examples:
          - ten_7fbo183
          type: string
        version:
          description: Version of the webhook envelope shape. Always `0`.
          enum:
          - '0'
          type: string
      required:
      - version
      - baseURL
      - tenantId
      - app
      - appDefinition
      type: object
    WellPlate:
      allOf:
      - $ref: '#/components/schemas/IWellPlate'
      - description: 'A WellPlate is a multi-well plate in Benchling''s inventory
          system where wells are

          permanently fixed to the plate structure. This is the standard plate type
          for laboratory

          multi-well formats such as 96-well, 384-well, and 1536-well plates used
          in high-throughput

          screening, PCR, and other assay workflows. The plate''s grid dimensions
          are defined by its

          WellPlateSchema, and each well (see WellPlatePosition) can contain samples,
          track quantities,

          and be assigned experimental roles. WellPlates can be stored in Locations
          (via parentStorage),

          associated with Studies, and identified by barcode. The plateRecords field
          tracks the history

          of transfers and annotations performed on the plate (see PlateRecord). Unlike
          MatrixPlate

          where containers can be inserted or removed, WellPlate wells are integral
          to the plate.'
        properties:
          __typename:
            type: string
          creator:
            $ref: '#/components/schemas/PrincipalRef'
            description: The user who created the plate
          positions:
            description: The wells of the plate
            format: uri
            type: string
          schemaFields:
            description: Schema field values that belong to the plate
            oneOf:
            - items:
                $ref: '#/components/schemas/SchemaFieldValue'
              type: array
            - type: 'null'
        type: object
    WellPlatePaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/WellPlate'
          type: array
        nextToken:
          type: string
      type: object
    WellPlatePosition:
      description: 'Represents a single well within a WellPlate, functioning as a
        fixed container at a

        specific grid position. Each WellPlatePosition has coordinates identifying
        its row

        and column, can hold sample contents (see ContainerContent), and tracks quantity
        as

        a Measurement. Wells can be assigned an ExperimentalRole for assay organization
        and

        support freeze/thaw tracking (see FreezeThawInfo) and expiration tracking
        (see

        ExpirationInfo) when enabled on the well''s ContainerSchema. Unlike containers
        in a

        MatrixPlate, WellPlatePositions are permanent parts of the plate structure
        and cannot

        be removed or repositioned. Wells are accessed through the parent WellPlate''s
        positions

        field.'
      properties:
        __typename:
          type: string
        contents:
          description: Well contents of the well plate.
          items:
            $ref: '#/components/schemas/ContainerContent'
          type: array
        coordinates:
          $ref: '#/components/schemas/GridCoordinates'
          description: Coordinates of the current position within the well plate.
        createdAt:
          description: When the well plate was created.
          format: datetime
          type: string
        expirationInfo:
          $ref: '#/components/schemas/ExpirationInfo'
          description: Expiration info for the container.
        id:
          description: The ID of the container representing the well at this plate
            position.
          type: string
        modifiedAt:
          description: When the well plate was last modified.
          format: datetime
          type: string
        name:
          description: The name of the container representing the well at this position.
          type: string
        quantity:
          description: Quantity of a well. Supports mass, volume, and other quantities.
          oneOf:
          - $ref: '#/components/schemas/Measurement'
          - type: 'null'
        role:
          oneOf:
          - $ref: '#/components/schemas/ExperimentalRole'
          - type: 'null'
        schema:
          $ref: '#/components/schemas/ContainerSchemaRef'
          description: The container schema used by wells in the well plate.
      type: object
    WellPlatePositionPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/WellPlatePosition'
          type: array
        nextToken:
          type: string
      type: object
    WellPlatePositionUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/WellPlatePosition'
          type: array
      type: object
    WellPlateSchema:
      description: 'Defines the structure and constraints for a category of WellPlates
        in Benchling''s

        inventory system. A WellPlateSchema specifies the grid dimensions (height
        and width)

        determining how many wells the plate has, and requires a ContainerSchema that
        defines

        the well properties (volume capacity, custom fields, etc.). Custom field definitions

        allow capturing plate-level metadata beyond individual well data. Each WellPlateSchema

        is associated with a Registry and has a prefix for generating display IDs
        and barcodes.

        Examples include "96-Well PCR Plate", "384-Well Assay Plate", or organization-specific

        plate formats. Unlike MatrixPlateSchema which defines tube rack formats with
        removable

        containers, WellPlateSchema is for fixed-well plates where wells are permanent.'
      properties:
        __typename:
          type: string
        archiveReason:
          description: Why the schema was archived.
          type:
          - 'null'
          - string
        archived:
          description: Whether the schema is archived.
          type: boolean
        containerSchema:
          $ref: '#/components/schemas/ContainerSchemaRef'
          description: The container schema used for positions in plates of this schema.
        createdAt:
          description: When the schema was created.
          format: datetime
          type: string
        description:
          description: A description of the schema.
          type: string
        fieldDefinitions:
          description: The fields inherited by plates of this schema.
          format: uri
          type: string
        height:
          description: The number of rows in plates of this schema.
          type: integer
        id:
          description: The ID of the schema.
          type: string
        modifiedAt:
          description: When the schema was last modified.
          format: datetime
          type: string
        name:
          description: The name of the schema.
          type: string
        prefix:
          description: The prefix of barcodes autogenerated for plates of this schema.
          type: string
        registry:
          $ref: '#/components/schemas/RegistryRef'
          description: The schema's registry.
        systemName:
          description: A unique, stable identifier for this schema used for programmatic
            access and integrations.
          type: string
        width:
          description: The number of columns in plates of this schema.
          type: integer
      type: object
    WellPlateSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/WellPlateSchema'
          type: array
        nextToken:
          type: string
      type: object
    WellPlateSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    WellRoleInput:
      additionalProperties: false
      properties:
        group:
          type: string
        role:
          type: string
        subrole:
          type: string
      required:
      - role
      type: object
    WellTransferInput:
      additionalProperties: false
      properties:
        destinationPlateIndex:
          type: integer
        destinationWellPosition:
          type: string
        diluentEntityId:
          type: string
        diluentQuantity:
          $ref: '#/components/schemas/QuantityInput'
        finalVolume:
          $ref: '#/components/schemas/QuantityInput'
        sourceDestinationPlateIndex:
          type: integer
        sourcePlateId:
          type: string
        sourceWellPosition:
          type: string
        transferQuantity:
          $ref: '#/components/schemas/QuantityInput'
      required:
      - sourceWellPosition
      - destinationPlateIndex
      - destinationWellPosition
      type: object
    WorkflowOutput:
      description: 'Represents the result or product of completing a `WorkflowTask`.
        Each output is associated

        with a single task. Outputs can contain schema-defined

        fields that capture structured data from task execution. In flowchart workflows,
        outputs

        can serve as inputs to downstream tasks, enabling data flow between workflow
        steps.

        The output schema is defined by the `WorkflowOutputSchema` associated with
        the parent task''s schema.'
      properties:
        __typename:
          type: string
        archiveReason:
          description: Reason the item was archived
          type:
          - 'null'
          - string
        archived:
          description: If the item is archived
          type: boolean
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
          description: The creator of the item
        displayId:
          description: User-friendly ID of the workflow output
          type: string
        id:
          description: The ID of the workflow output
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        schema:
          $ref: '#/components/schemas/WorkflowOutputSchemaRef'
        task:
          $ref: '#/components/schemas/WorkflowTaskRef'
      type: object
    WorkflowOutputPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/WorkflowOutput'
          type: array
        nextToken:
          type: string
      type: object
    WorkflowOutputSchema:
      description: 'Defines the structure of `WorkflowOutput` instances produced by
        tasks of a given

        `WorkflowTaskSchema`. Each output schema specifies `fieldDefinitions` for
        the data to

        be captured, an optional `prefix` for human-readable output IDs, and a `name`
        for

        identification. Output schemas belong to an `Organization` and are linked
        to their parent

        `workflowTaskSchema`. In flowcharts, output schemas can define data that flows
        between nodes.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        createdAt:
          format: datetime
          type: string
        fieldDefinitions:
          format: uri
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        organization:
          $ref: '#/components/schemas/OrganizationRef'
        prefix:
          type: string
        workflowTaskSchema:
          $ref: '#/components/schemas/WorkflowTaskSchemaRef'
      type: object
    WorkflowOutputSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/WorkflowOutputSchema'
          type: array
        nextToken:
          type: string
      type: object
    WorkflowOutputSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    WorkflowTask:
      description: 'Represents a unit of work within a `WorkflowTaskGroup`. Each task
        has a `status` that progresses

        through a configurable lifecycle (see `WorkflowTaskStatusLifecycle`), an optional
        `assignee`

        and `responsibleParties` for ownership, and a `scheduledOn` date for planning.

        Tasks may or may not produce `WorkflowOutput` instances upon completion. In
        flowchart workflows, tasks can

        have upstream dependencies (`flowchartPreviousItems`) and downstream dependents

        (`flowchartNextItems`), with `rootWorkflowTask` pointing to the flowchart''s
        entry point.

        Tasks support schema-defined custom fields via `schemaFields` and can be linked
        to `Study`

        entities for research coordination.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        assignee:
          description: The assignee of this task
          oneOf:
          - $ref: '#/components/schemas/UserRef'
          - type: 'null'
        childTasks:
          description: All descendants of a root task in a flowchart. This will be
            empty if this task is not a root task.
          oneOf:
          - format: uri
            type: string
          - type: 'null'
        clonedFrom:
          description: The task that this task was cloned from
          oneOf:
          - $ref: '#/components/schemas/WorkflowTaskRef'
          - type: 'null'
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        displayId:
          description: User-friendly ID of the workflow task
          type:
          - 'null'
          - string
        executionEntry:
          description: The entry that this task is executed in. This is only non-null
            for tasks with an ENTRY execution type.
          oneOf:
          - $ref: '#/components/schemas/EntryRef'
          - type: 'null'
        executionType:
          description: The method by which the task of the workflow is executed
          enum:
          - DIRECT
          - ENTRY
          - FLOWCHART
          - PROCEDURE
          - PROCEDURE_METHOD
          - PROCEDURE_STEP
          - PIPELINE
          type: string
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        responsibleParties:
          description: The responsible parties for this task
          oneOf:
          - items:
              $ref: '#/components/schemas/ObjectRef'
              description: Union of User, Team
            type: array
          - type: 'null'
        rootWorkflowTask:
          deprecated: true
          description: The root task of the flowchart that this task is a part of
          oneOf:
          - $ref: '#/components/schemas/WorkflowTaskRef'
          - type: 'null'
        rootWorkflowTasks:
          description: 'All root tasks of the flowchart(s) that this task is a part
            of. A task may be associated with more than one

            root task when branches rooted at different flowchart tasks are pooled
            together.'
          oneOf:
          - format: uri
            type: string
          - type: 'null'
        scheduledOn:
          description: The date on which the task is scheduled to be executed
          format: date
          type:
          - 'null'
          - string
        schema:
          $ref: '#/components/schemas/WorkflowTaskSchemaRef'
        schemaFields:
          oneOf:
          - items:
              $ref: '#/components/schemas/SchemaFieldValue'
            type: array
          - type: 'null'
        status:
          description: The status of this task
          enum:
          - PENDING
          - PLANNED
          - IN_PROGRESS
          - FAILED
          - CANCELLED
          - INVALID
          - COMPLETED
          - COMPLETED_AFTER_REVIEW
          - ACTIVE
          - SKIPPED
          - NOT_READY
          - READY
          type: string
      type: object
    WorkflowTaskGroup:
      description: 'A container that groups related `WorkflowTask` instances together,
        representing a cohesive

        unit of work. Task groups are created from a `WorkflowTaskSchema` (via `workflowTaskSchema`).

        They are stored in `Folder`s and can have `authors` and `watchers` for

        collaboration. In flowchart workflows, task groups can be nested:

        `childWorkflowTaskGroups` contains sub-groups for flowchart nodes, and

        `rootWorkflowTaskGroup` points to the parent when this group is part of a
        larger flowchart.

        When created from a `RequestV2Submission`, the `requestSubmission` field links
        back to the

        originating request. Task groups aggregate the outputs from all their tasks
        via

        `workflowOutputs`.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        authors:
          oneOf:
          - format: uri
            type: string
          - type: 'null'
        childWorkflowTaskGroups:
          description: The list of workflow task groups for which this task group
            is the root in a flowchart
          oneOf:
          - format: uri
            type: string
          - type: 'null'
        createdAt:
          format: datetime
          type: string
        creator:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        displayId:
          description: User-friendly ID of the workflow task group
          type:
          - 'null'
          - string
        folder:
          $ref: '#/components/schemas/FolderRef'
        id:
          description: The ID of the workflow task group
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          description: The name of the workflow task group
          type:
          - 'null'
          - string
        requestSubmission:
          description: A request that this task group was created to fulfill.
          oneOf:
          - $ref: '#/components/schemas/RequestV2SubmissionRef'
          - type: 'null'
        rootWorkflowTaskGroup:
          description: 'The workflow task group which corresponds to the root node
            in a flowchart. This is only non-null for

            task groups that are part of a flowchart'
          oneOf:
          - $ref: '#/components/schemas/WorkflowTaskGroupRef'
          - type: 'null'
        watchers:
          description: The users or teams watching the workflow task group
          oneOf:
          - items:
              $ref: '#/components/schemas/ObjectRef'
              description: Union of User, Team
            type: array
          - type: 'null'
        workflowTaskSchema:
          $ref: '#/components/schemas/WorkflowTaskSchemaRef'
      type: object
    WorkflowTaskGroupPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/WorkflowTaskGroup'
          type: array
        nextToken:
          type: string
      type: object
    WorkflowTaskGroupRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    WorkflowTaskPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/WorkflowTask'
          type: array
        nextToken:
          type: string
      type: object
    WorkflowTaskRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    WorkflowTaskSchema:
      description: 'A configuration template that defines the structure and behavior
        of `WorkflowTask` instances.

        Each schema specifies an `executionType` (direct, entry, or flowchart) and

        custom `fieldDefinitions` for task data. Schemas belong to an `Organization`
        and can optionally reference an `entryTemplate`

        for entry-based execution or a `flowchartConfig` for flowchart-based execution.
        The `prefix`

        and `taskGroupPrefix` fields define the human-readable ID format for tasks
        and task groups.

        Default folders can be configured via `defaultCreationFolder` and `defaultEntryExecutionFolder`.

        Schemas support `responsibleParties` for default assignment and `validationRules`
        for data

        validation (see `HasValidationRules`). The associated `workflowOutputSchema`
        defines the

        structure of outputs produced by tasks of this schema.'
      properties:
        __typename:
          type: string
        archiveReason:
          type:
          - 'null'
          - string
        archived:
          type: boolean
        canOnlyBePartOfFlowchart:
          type: boolean
        canSetAssigneeOnTaskCreation:
          description: 'Whether or not tasks of this schema can be created with a
            non-null

            assignee.'
          type: boolean
        createdAt:
          format: datetime
          type: string
        defaultCreationFolder:
          description: ID of the default folder for creating workflow task groups
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        defaultEntryExecutionFolder:
          description: ID of the default folder for workflow task execution entries
          oneOf:
          - $ref: '#/components/schemas/FolderRef'
          - type: 'null'
        entryTemplate:
          description: 'The ID of the template of the entries tasks of this schema
            will be

            executed into.'
          oneOf:
          - $ref: '#/components/schemas/EntryTemplateRef'
          - type: 'null'
        executionType:
          description: The method by which instances of this schema are executed
          enum:
          - DIRECT
          - ENTRY
          - FLOWCHART
          - PROCEDURE
          - PROCEDURE_METHOD
          - PROCEDURE_STEP
          - PIPELINE
          type: string
        fieldDefinitions:
          format: uri
          type: string
        id:
          type: string
        isPropagateWatchersEnabled:
          type: boolean
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        organization:
          $ref: '#/components/schemas/OrganizationRef'
          description: The organization that owns the schema.
        prefix:
          description: The prefix for the displayId of tasks of this schema.
          type: string
        responsibleParties:
          description: The default responsible parties for tasks of this schema
          oneOf:
          - items:
              $ref: '#/components/schemas/ObjectRef'
              description: Union of User, Team
            type: array
          - type: 'null'
        systemName:
          description: A unique, stable identifier for this schema used for programmatic
            access and integrations.
          type: string
        taskGroupInstructions:
          description: The instructions for task groups of this schema
          type:
          - 'null'
          - string
        taskGroupPrefix:
          description: 'The prefix for the displayId of task groups containing tasks
            of this

            schema'
          type: string
        workflowOutputSchema:
          oneOf:
          - $ref: '#/components/schemas/WorkflowOutputSchemaRef'
          - type: 'null'
      type: object
    WorkflowTaskSchemaAppConfigSpec:
      description: 'Specifies that an app configuration field should reference a workflow
        task schema.

        Kept separate from SchemaAppConfigSpec because it supports output field definitions.'
      properties:
        __typename:
          type: string
        fieldDefinitions:
          oneOf:
          - items:
              $ref: '#/components/schemas/AppConfigFieldDefinition'
            type: array
          - type: 'null'
        output:
          description: Output field definitions for the workflow task schema.
          oneOf:
          - $ref: '#/components/schemas/AppConfigWorkflowTaskSchemaOutput'
          - type: 'null'
        requiredConfig:
          type:
          - 'null'
          - boolean
      type: object
    WorkflowTaskSchemaPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/WorkflowTaskSchema'
          type: array
        nextToken:
          type: string
      type: object
    WorkflowTaskSchemaRef:
      properties:
        __typename:
          type: string
        id:
          format: api_id
          type: string
      type: object
    WorkflowTaskUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/WorkflowTask'
          type: array
      type: object
    Worklist:
      description: 'A typed collection of items used to group related objects for
        batch operations. Unlike

        folders, items can belong to multiple worklists simultaneously, making worklists
        useful

        as temporary holding grounds for arbitrary groups of items. Each worklist
        has an `itemType`

        that restricts what kinds of objects it can contain (containers, entities,
        or plates).

        Common use cases include scanning containers into a worklist before adding
        them to a

        transfer table, or grouping entities for bulk export. Worklists have an `owner`
        and support

        `collaborations` for access control (see `Collaboratable` interface). The
        `items` field

        returns the collection of `Worklistable` objects currently in the worklist.'
      properties:
        __typename:
          type: string
        createdAt:
          format: datetime
          type:
          - 'null'
          - string
        creator:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        id:
          type: string
        itemType:
          enum:
          - CONTAINER
          - ENTITY
          - PLATE
          - null
          type:
          - 'null'
          - string
        items:
          oneOf:
          - format: uri
            type: string
          - type: 'null'
        modifiedAt:
          format: datetime
          type:
          - 'null'
          - string
        name:
          type:
          - 'null'
          - string
        owner:
          oneOf:
          - $ref: '#/components/schemas/OwnerRef'
          - type: 'null'
      type: object
    WorklistPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Worklist'
          type: array
        nextToken:
          type: string
      type: object
    Worklistable:
      anyOf:
      - $ref: '#/components/schemas/AaSequence'
      - $ref: '#/components/schemas/Assembly'
      - $ref: '#/components/schemas/Container'
      - $ref: '#/components/schemas/CustomEntity'
      - $ref: '#/components/schemas/DnaOligo'
      - $ref: '#/components/schemas/DnaSequence'
      - $ref: '#/components/schemas/MatrixPlate'
      - $ref: '#/components/schemas/Mixture'
      - $ref: '#/components/schemas/Molecule'
      - $ref: '#/components/schemas/OligoConjugate'
      - $ref: '#/components/schemas/OligoDuplex'
      - $ref: '#/components/schemas/Plate'
      - $ref: '#/components/schemas/Protein'
      - $ref: '#/components/schemas/RnaOligo'
      - $ref: '#/components/schemas/RnaSequence'
      - $ref: '#/components/schemas/WellPlate'
      - $ref: '#/components/schemas/WellPlatePosition'
      discriminator:
        propertyName: __typename
      type: object
    WorklistableUnpaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Worklistable'
          type: array
      type: object
    Worksheet:
      description: 'A structured document container used to organize and execute procedural
        work within

        Benchling''s notebook system. Worksheets contain ordered `WorksheetStepGroup`s,
        each

        holding `WorksheetStep`s that represent individual tasks or documentation
        units. Each

        step has an associated `Document` for capturing content. Worksheets support
        workflow

        integration through associated `WorkflowTask`s, can be linked to `Study` objects
        for

        experimental context, and include review capabilities (see `Review`). They
        are stored

        within `Folder`s and support archival.'
      properties:
        __typename:
          type: string
        applicableReviewProcesses:
          format: uri
          type: string
        archiveDatetime:
          format: datetime
          type:
          - 'null'
          - string
        archiveReason:
          type:
          - 'null'
          - string
        archiveUser:
          oneOf:
          - $ref: '#/components/schemas/PrincipalRef'
          - type: 'null'
        archived:
          type: boolean
        authors:
          oneOf:
          - format: uri
            type: string
          - type: 'null'
        createdAt:
          format: datetime
          type: string
        creator:
          $ref: '#/components/schemas/PrincipalRef'
        folder:
          $ref: '#/components/schemas/FolderRef'
        id:
          type: string
        modifiedAt:
          format: datetime
          type: string
        name:
          type: string
        review:
          oneOf:
          - $ref: '#/components/schemas/ReviewRef'
          - type: 'null'
        reviewSource:
          $ref: '#/components/schemas/ProjectRef'
      type: object
    WorksheetPaginatedList:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/Worksheet'
          type: array
        nextToken:
          type: string
      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
info:
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  title: Benchling API
  version: 2.0.0
openapi: 3.1.0
paths:
  /aa-sequence:
    post:
      description: Create AaSequence.
      operationId: AaSequence.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: &id001
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAaSequenceInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AaSequence'
          description: Created
        '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: Create AaSequence
      tags:
      - AaSequence
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /aa-sequence-schema:
    post:
      description: Create AaSequenceSchema.
      operationId: AaSequenceSchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAaSequenceSchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AaSequenceSchema'
          description: Created
        '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: Create AaSequenceSchema
      tags:
      - AaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /aa-sequence-schema/items:
    get:
      description: List AaSequenceSchema items.
      operationId: AaSequenceSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AaSequenceSchemaPaginatedList'
          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 AaSequenceSchema items
      tags:
      - AaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /aa-sequence-schema/{aa_sequence_schema_id}:
    get:
      description: Get a single AaSequenceSchema by ID.
      operationId: AaSequenceSchema.Get
      parameters:
      - description: ID of the AaSequenceSchema.
        in: path
        name: aa_sequence_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AaSequenceSchema'
          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 AaSequenceSchema by ID
      tags:
      - AaSequenceSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update AaSequenceSchema.
      operationId: AaSequenceSchema.Update
      parameters:
      - description: ID of the AaSequenceSchema.
        in: path
        name: aa_sequence_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAaSequenceSchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AaSequenceSchema'
          description: OK
        '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: Update AaSequenceSchema
      tags:
      - AaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /aa-sequence-schema/{aa_sequence_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: AaSequenceSchema.fieldDefinitions.List
      parameters:
      - description: ID of the AaSequenceSchema.
        in: path
        name: aa_sequence_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - AaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /aa-sequence-schema/{aa_sequence_schema_id}/fieldsets/items:
    get:
      description: List Fieldset items.
      operationId: AaSequenceSchema.fieldsets.List
      parameters:
      - description: ID of the AaSequenceSchema.
        in: path
        name: aa_sequence_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsetUnpaginatedList'
          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 Fieldset items
      tags:
      - AaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /aa-sequence-schema/{aa_sequence_schema_id}:apply-fieldset:
    post:
      description: Apply a fieldset to the schema
      operationId: AaSequenceSchema.ApplyFieldset
      parameters:
      - description: ID of the AaSequenceSchema.
        in: path
        name: aa_sequence_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitySchemaApplyFieldsetInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Apply a fieldset to the schema
      tags:
      - AaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /aa-sequence-schema/{aa_sequence_schema_id}:set-field-definitions:
    post:
      description: Set field definitions on the schema
      operationId: AaSequenceSchema.SetFieldDefinitions
      parameters:
      - description: ID of the AaSequenceSchema.
        in: path
        name: aa_sequence_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AaSequenceSchemaSetFieldDefinitionsInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Set field definitions on the schema
      tags:
      - AaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /aa-sequence-schema:batch-create:
    post:
      description: Batch create AaSequenceSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: AaSequenceSchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateAaSequenceSchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/AaSequenceSchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create AaSequenceSchema
      tags:
      - AaSequenceSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /aa-sequence-schema:batch-update:
    patch:
      description: Batch update AaSequenceSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: AaSequenceSchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateAaSequenceSchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/AaSequenceSchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update AaSequenceSchema
      tags:
      - AaSequenceSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /aa-sequence-schema:bulk-create:
    post:
      description: Bulk create AaSequenceSchema.
      operationId: AaSequenceSchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create AaSequenceSchema
      tags:
      - AaSequenceSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /aa-sequence-schema:bulk-update:
    patch:
      description: Bulk update AaSequenceSchema.
      operationId: AaSequenceSchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update AaSequenceSchema
      tags:
      - AaSequenceSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /aa-sequence/items:
    get:
      description: List AaSequence items.
      operationId: AaSequence.List
      parameters:
      - $ref: '#/components/parameters/aminoAcids.anyOf'
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/authors.anyOf'
      - $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/fieldset.anyOf'
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/mentionedIn.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/project.eq'
      - $ref: '#/components/parameters/registry.eq'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/schema.anyOf'
      - $ref: '#/components/parameters/schema.eq'
      - $ref: '#/components/parameters/systemCategory.anyOf'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AaSequencePaginatedList'
          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 AaSequence items
      tags:
      - AaSequence
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /aa-sequence/{aa_sequence_id}:
    get:
      description: Get a single AaSequence by ID.
      operationId: AaSequence.Get
      parameters:
      - description: ID of the AaSequence.
        in: path
        name: aa_sequence_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AaSequence'
          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 AaSequence by ID
      tags:
      - AaSequence
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update AaSequence.
      operationId: AaSequence.Update
      parameters:
      - description: ID of the AaSequence.
        in: path
        name: aa_sequence_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAaSequenceInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AaSequence'
          description: OK
        '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: Update AaSequence
      tags:
      - AaSequence
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /aa-sequence/{aa_sequence_id}/authors/items:
    get:
      description: List Principal items.
      operationId: AaSequence.authors.List
      parameters:
      - description: ID of the AaSequence.
        in: path
        name: aa_sequence_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - AaSequence
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /aa-sequence:batch-create:
    post:
      description: Batch create AaSequence synchronously in one transaction. Maximum
        25 items per request.
      operationId: AaSequence.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateAaSequenceInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/AaSequence'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create AaSequence
      tags:
      - AaSequence
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /aa-sequence:batch-update:
    patch:
      description: Batch update AaSequence synchronously in one transaction. Maximum
        25 items per request.
      operationId: AaSequence.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateAaSequenceInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/AaSequence'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update AaSequence
      tags:
      - AaSequence
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /aa-sequence:bulk-create:
    post:
      description: Bulk create AaSequence.
      operationId: AaSequence.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create AaSequence
      tags:
      - AaSequence
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /aa-sequence:bulk-update:
    patch:
      description: Bulk update AaSequence.
      operationId: AaSequence.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update AaSequence
      tags:
      - AaSequence
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /agents:
    post:
      description: Create or continue a chat with an agent
      operationId: Agent.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            examples:
              benchling_ask_v1:
                value:
                  agent: benchling_ask_v1
                  input:
                  - text: What is the most recently created entry?
                    type: text
              benchling_deep_research_v1:
                value:
                  agent: benchling_deep_research_v1
                  input:
                  - text: What should I do next?
                    type: text
                  sources:
                  - type: public_data
              new_chat:
                value:
                  input:
                  - text: What should I do next?
                    type: text
                  sources:
                  - type: public_data
            schema:
              $ref: '#/components/schemas/CreateAgentInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                properties:
                  pollingUri:
                    type: string
                  taskId:
                    type: string
                type: object
          description: Task started
        '400':
          $ref: '#/components/responses/BadRequest'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Create or continue a chat with an agent
      tags:
      - Agent
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /analysis-template-data-frame-variable/items:
    get:
      description: List AnalysisTemplateDataFrameVariable items.
      operationId: AnalysisTemplateDataFrameVariable.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalysisTemplateDataFrameVariablePaginatedList'
          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 AnalysisTemplateDataFrameVariable items
      tags:
      - AnalysisTemplateDataFrameVariable
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /analysis-template-data-frame-variable/{analysis_template_data_frame_variable_id}:
    get:
      description: Get a single AnalysisTemplateDataFrameVariable by ID.
      operationId: AnalysisTemplateDataFrameVariable.Get
      parameters:
      - description: ID of the AnalysisTemplateDataFrameVariable.
        in: path
        name: analysis_template_data_frame_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalysisTemplateDataFrameVariable'
          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 AnalysisTemplateDataFrameVariable by ID
      tags:
      - AnalysisTemplateDataFrameVariable
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /analysis-template-variable/items:
    get:
      description: List AnalysisTemplateVariable items.
      operationId: AnalysisTemplateVariable.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalysisTemplateVariablePaginatedList'
          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 AnalysisTemplateVariable items
      tags:
      - AnalysisTemplateVariable
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /analysis-template-variable/{analysis_template_variable_id}:
    get:
      description: Get a single AnalysisTemplateVariable by ID.
      operationId: AnalysisTemplateVariable.Get
      parameters:
      - description: ID of the AnalysisTemplateVariable.
        in: path
        name: analysis_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalysisTemplateVariable'
          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 AnalysisTemplateVariable by ID
      tags:
      - AnalysisTemplateVariable
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /analysis-template/items:
    get:
      description: List AnalysisTemplate items.
      operationId: AnalysisTemplate.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalysisTemplatePaginatedList'
          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 AnalysisTemplate items
      tags:
      - AnalysisTemplate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /analysis-template/{analysis_template_id}:
    get:
      description: Get a single AnalysisTemplate by ID.
      operationId: AnalysisTemplate.Get
      parameters:
      - description: ID of the AnalysisTemplate.
        in: path
        name: analysis_template_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalysisTemplate'
          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 AnalysisTemplate by ID
      tags:
      - AnalysisTemplate
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /analysis-template/{analysis_template_id}/archivable-children/items:
    get:
      description: List AnalysisTemplateDataFrameVariable items.
      operationId: AnalysisTemplate.archivableChildren.List
      parameters:
      - description: ID of the AnalysisTemplate.
        in: path
        name: analysis_template_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalysisTemplateDataFrameVariableUnpaginatedList'
          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 AnalysisTemplateDataFrameVariable items
      tags:
      - AnalysisTemplate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /analysis-template/{analysis_template_id}/config-variables/items:
    get:
      description: List AnalysisTemplateVariable items.
      operationId: AnalysisTemplate.configVariables.List
      parameters:
      - description: ID of the AnalysisTemplate.
        in: path
        name: analysis_template_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalysisTemplateVariableUnpaginatedList'
          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 AnalysisTemplateVariable items
      tags:
      - AnalysisTemplate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /analysis-template/{analysis_template_id}/data-frame-variables/items:
    get:
      description: List AnalysisTemplateDataFrameVariable items.
      operationId: AnalysisTemplate.dataFrameVariables.List
      parameters:
      - description: ID of the AnalysisTemplate.
        in: path
        name: analysis_template_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalysisTemplateDataFrameVariableUnpaginatedList'
          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 AnalysisTemplateDataFrameVariable items
      tags:
      - AnalysisTemplate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /analysis-template/{analysis_template_id}/steps/items:
    get:
      description: List PipelineStep items.
      operationId: AnalysisTemplate.steps.List
      parameters:
      - description: ID of the AnalysisTemplate.
        in: path
        name: analysis_template_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineStepUnpaginatedList'
          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 PipelineStep items
      tags:
      - AnalysisTemplate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /analysis/items:
    get:
      description: List Analysis items.
      operationId: Analysis.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalysisPaginatedList'
          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 Analysis items
      tags:
      - Analysis
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /analysis/{analysis_id}:
    get:
      description: Get a single Analysis by ID.
      operationId: Analysis.Get
      parameters:
      - description: ID of the Analysis.
        in: path
        name: analysis_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Analysis'
          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 Analysis by ID
      tags:
      - Analysis
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /analysis/{analysis_id}/steps/items:
    get:
      description: List PipelineStep items.
      operationId: Analysis.steps.List
      parameters:
      - description: ID of the Analysis.
        in: path
        name: analysis_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineStepUnpaginatedList'
          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 PipelineStep items
      tags:
      - Analysis
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /app-canvas:
    post:
      description: Create AppCanvas.
      operationId: AppCanvas.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAppCanvasInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppCanvas'
          description: Created
        '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: Create AppCanvas
      tags:
      - AppCanvas
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /app-canvas/{app_canvas_id}:
    get:
      description: Get a single AppCanvas by ID.
      operationId: AppCanvas.Get
      parameters:
      - description: ID of the AppCanvas.
        in: path
        name: app_canvas_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppCanvas'
          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 AppCanvas by ID
      tags:
      - AppCanvas
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update AppCanvas.
      operationId: AppCanvas.Update
      parameters:
      - description: ID of the AppCanvas.
        in: path
        name: app_canvas_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAppCanvasInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppCanvas'
          description: OK
        '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: Update AppCanvas
      tags:
      - AppCanvas
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /app-canvas:batch-create:
    post:
      description: Batch create AppCanvas synchronously in one transaction. Maximum
        25 items per request.
      operationId: AppCanvas.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateAppCanvasInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/AppCanvas'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create AppCanvas
      tags:
      - AppCanvas
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /app-canvas:batch-update:
    patch:
      description: Batch update AppCanvas synchronously in one transaction. Maximum
        25 items per request.
      operationId: AppCanvas.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateAppCanvasInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/AppCanvas'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update AppCanvas
      tags:
      - AppCanvas
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /app-canvas:bulk-create:
    post:
      description: Bulk create AppCanvas.
      operationId: AppCanvas.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create AppCanvas
      tags:
      - AppCanvas
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /app-canvas:bulk-update:
    patch:
      description: Bulk update AppCanvas.
      operationId: AppCanvas.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update AppCanvas
      tags:
      - AppCanvas
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /app-config-value/items:
    get:
      description: List AppConfigValue items.
      operationId: AppConfigValue.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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppConfigValuePaginatedList'
          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 AppConfigValue items
      tags:
      - AppConfigValue
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /app-config-value/{app_config_value_id}:
    get:
      description: Get a single AppConfigValue by ID.
      operationId: AppConfigValue.Get
      parameters:
      - description: ID of the AppConfigValue.
        in: path
        name: app_config_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppConfigValue'
          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 AppConfigValue by ID
      tags:
      - AppConfigValue
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /app-installation/items:
    get:
      description: List AppInstallation items.
      operationId: AppInstallation.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppInstallationPaginatedList'
          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 AppInstallation items
      tags:
      - AppInstallation
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /app-installation/{app_installation_id}:
    get:
      description: Get a single AppInstallation by ID.
      operationId: AppInstallation.Get
      parameters:
      - description: ID of the AppInstallation.
        in: path
        name: app_installation_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppInstallation'
          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 AppInstallation by ID
      tags:
      - AppInstallation
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /app-installation/{app_installation_id}/configuration-values/items:
    get:
      description: List AppConfigValue items.
      operationId: AppInstallation.configurationValues.List
      parameters:
      - description: ID of the AppInstallation.
        in: path
        name: app_installation_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppConfigValueUnpaginatedList'
          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 AppConfigValue items
      tags:
      - AppInstallation
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /app-session:
    post:
      description: Create AppSession.
      operationId: AppSession.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAppSessionInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppSession'
          description: Created
        '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: Create AppSession
      tags:
      - AppSession
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /app-session/items:
    get:
      description: List AppSession items.
      operationId: AppSession.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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppSessionPaginatedList'
          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 AppSession items
      tags:
      - AppSession
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /app-session/{app_session_id}:
    get:
      description: Get a single AppSession by ID.
      operationId: AppSession.Get
      parameters:
      - description: ID of the AppSession.
        in: path
        name: app_session_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppSession'
          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 AppSession by ID
      tags:
      - AppSession
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update AppSession.
      operationId: AppSession.Update
      parameters:
      - description: ID of the AppSession.
        in: path
        name: app_session_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAppSessionInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppSession'
          description: OK
        '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: Update AppSession
      tags:
      - AppSession
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /app-session:batch-create:
    post:
      description: Batch create AppSession synchronously in one transaction. Maximum
        25 items per request.
      operationId: AppSession.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateAppSessionInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/AppSession'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create AppSession
      tags:
      - AppSession
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /app-session:batch-update:
    patch:
      description: Batch update AppSession synchronously in one transaction. Maximum
        25 items per request.
      operationId: AppSession.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateAppSessionInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/AppSession'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update AppSession
      tags:
      - AppSession
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /app-session:bulk-create:
    post:
      description: Bulk create AppSession.
      operationId: AppSession.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create AppSession
      tags:
      - AppSession
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /app-session:bulk-update:
    patch:
      description: Bulk update AppSession.
      operationId: AppSession.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update AppSession
      tags:
      - AppSession
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /assembly/items:
    get:
      description: List Assembly items.
      operationId: Assembly.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssemblyPaginatedList'
          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 Assembly items
      tags:
      - Assembly
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /assembly/{assembly_id}:
    get:
      description: Get a single Assembly by ID.
      operationId: Assembly.Get
      parameters:
      - description: ID of the Assembly.
        in: path
        name: assembly_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Assembly'
          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 Assembly by ID
      tags:
      - Assembly
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /audit-log/items:
    get:
      description: List AuditLog items.
      operationId: AuditLog.List
      parameters:
      - $ref: '#/components/parameters/action.anyOf'
      - $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/objectId.anyOf'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/reasonCode.anyOf'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/userId.anyOf'
      - 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:asc.'
        in: query
        name: sort
        schema:
          default: createdAt:asc
          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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditLogPaginatedList'
          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 AuditLog items
      tags:
      - AuditLog
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /audit-log/{audit_log_id}:
    get:
      description: Get a single AuditLog by ID.
      operationId: AuditLog.Get
      parameters:
      - description: ID of the AuditLog.
        in: path
        name: audit_log_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditLog'
          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 AuditLog by ID
      tags:
      - AuditLog
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /audit-log:export:
    post:
      description: Export the full audit log for an object as a CSV or PDF file
      operationId: AuditLog.Export
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuditLogExportInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Export the full audit log for an object as a CSV or PDF file
      tags:
      - AuditLog
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /box:
    post:
      description: Create Box.
      operationId: Box.Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBoxInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Box'
          description: Created
        '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: Create Box
      tags:
      - Box
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /box-schema:
    post:
      description: Create BoxSchema.
      operationId: BoxSchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBoxSchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoxSchema'
          description: Created
        '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: Create BoxSchema
      tags:
      - BoxSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /box-schema/items:
    get:
      description: List BoxSchema items.
      operationId: BoxSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoxSchemaPaginatedList'
          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 BoxSchema items
      tags:
      - BoxSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /box-schema/{box_schema_id}:
    get:
      description: Get a single BoxSchema by ID.
      operationId: BoxSchema.Get
      parameters:
      - description: ID of the BoxSchema.
        in: path
        name: box_schema_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoxSchema'
          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 BoxSchema by ID
      tags:
      - BoxSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update BoxSchema.
      operationId: BoxSchema.Update
      parameters:
      - description: ID of the BoxSchema.
        in: path
        name: box_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBoxSchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoxSchema'
          description: OK
        '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: Update BoxSchema
      tags:
      - BoxSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /box-schema/{box_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: BoxSchema.fieldDefinitions.List
      parameters:
      - description: ID of the BoxSchema.
        in: path
        name: box_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - BoxSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /box-schema:batch-create:
    post:
      description: Batch create BoxSchema synchronously in one transaction. Maximum
        25 items per request.
      operationId: BoxSchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateBoxSchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/BoxSchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create BoxSchema
      tags:
      - BoxSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /box-schema:batch-update:
    patch:
      description: Batch update BoxSchema synchronously in one transaction. Maximum
        25 items per request.
      operationId: BoxSchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateBoxSchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/BoxSchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update BoxSchema
      tags:
      - BoxSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /box-schema:bulk-create:
    post:
      description: Bulk create BoxSchema.
      operationId: BoxSchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create BoxSchema
      tags:
      - BoxSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /box-schema:bulk-update:
    patch:
      description: Bulk update BoxSchema.
      operationId: BoxSchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update BoxSchema
      tags:
      - BoxSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /box/items:
    get:
      description: List Box items.
      operationId: Box.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/barcode.anyOf'
      - $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/mentionedIn.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/parentStorage.eq'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/schema.anyOf'
      - $ref: '#/components/parameters/schema.eq'
      - 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoxPaginatedList'
          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 Box items
      tags:
      - Box
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /box/{box_id}:
    get:
      description: Get a single Box by ID.
      operationId: Box.Get
      parameters:
      - description: ID of the Box.
        in: path
        name: box_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Box'
          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 Box by ID
      tags:
      - Box
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update Box.
      operationId: Box.Update
      parameters:
      - description: ID of the Box.
        in: path
        name: box_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBoxInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Box'
          description: OK
        '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: Update Box
      tags:
      - Box
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /box:batch-create:
    post:
      description: Batch create Box synchronously in one transaction. Maximum 25 items
        per request.
      operationId: Box.BatchCreate
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateBoxInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Box'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create Box
      tags:
      - Box
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /box:batch-update:
    patch:
      description: Batch update Box synchronously in one transaction. Maximum 25 items
        per request.
      operationId: Box.BatchUpdate
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateBoxInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Box'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Box
      tags:
      - Box
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /box:bulk-create:
    post:
      description: Bulk create Box.
      operationId: Box.BulkCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create Box
      tags:
      - Box
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /box:bulk-update:
    patch:
      description: Bulk update Box.
      operationId: Box.BulkUpdate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Box
      tags:
      - Box
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /bulk-export:
    post:
      description: 'Create a bulk export task that will export data from the requested
        list of models into data files.

        The data files would be in serialized JSON format matching v3 api response
        spec of the models.

        The task will run asynchronously and the results can be retrieved using the
        bulk-export task ID.

        '
      operationId: BulkExport.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                models:
                  additionalProperties:
                    type: object
                  example:
                    Box: {}
                    Container:
                      filters:
                        modifiedAt:
                          gte: '2025-09-15T05:22:30Z'
                  maxItems: 100
                  minItems: 1
                  type: object
              required:
              - models
              type: object
        description: Provide the list of model names to be exported.
      responses:
        '202':
          content:
            application/json:
              schema:
                properties:
                  pollingUri:
                    type: string
                  taskId:
                    type: string
                type: object
          description: Task started
        '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: Create a bulk export task
      tags:
      - BulkExport
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /chart:
    post:
      description: Create Chart.
      operationId: Chart.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateChartInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Chart'
          description: Created
        '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: Create Chart
      tags:
      - Chart
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /chart/items:
    get:
      description: List Chart items.
      operationId: Chart.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChartPaginatedList'
          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 Chart items
      tags:
      - Chart
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /chart/{chart_id}:
    get:
      description: Get a single Chart by ID.
      operationId: Chart.Get
      parameters:
      - description: ID of the Chart.
        in: path
        name: chart_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Chart'
          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 Chart by ID
      tags:
      - Chart
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update Chart.
      operationId: Chart.Update
      parameters:
      - description: ID of the Chart.
        in: path
        name: chart_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateChartInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Chart'
          description: OK
        '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: Update Chart
      tags:
      - Chart
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /chart:batch-create:
    post:
      description: Batch create Chart synchronously in one transaction. Maximum 25
        items per request.
      operationId: Chart.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateChartInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Chart'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create Chart
      tags:
      - Chart
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /chart:batch-update:
    patch:
      description: Batch update Chart synchronously in one transaction. Maximum 25
        items per request.
      operationId: Chart.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateChartInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Chart'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Chart
      tags:
      - Chart
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /chart:bulk-create:
    post:
      description: Bulk create Chart.
      operationId: Chart.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create Chart
      tags:
      - Chart
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /chart:bulk-update:
    patch:
      description: Bulk update Chart.
      operationId: Chart.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Chart
      tags:
      - Chart
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /collaboration:
    post:
      description: Create Collaboration.
      operationId: Collaboration.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCollaborationInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collaboration'
          description: Created
        '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: Create Collaboration
      tags:
      - Collaboration
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /collaboration/items:
    get:
      description: List Collaboration items.
      operationId: Collaboration.List
      parameters:
      - $ref: '#/components/parameters/collaboratorId.anyOf'
      - $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/resourceId.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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollaborationPaginatedList'
          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 Collaboration items
      tags:
      - Collaboration
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /collaboration/{collaboration_id}:
    delete:
      description: Delete Collaboration.
      operationId: Collaboration.Delete
      parameters:
      - description: ID of the Collaboration.
        in: path
        name: collaboration_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: *id001
      responses:
        '204':
          description: No Content
        '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: Delete Collaboration
      tags:
      - Collaboration
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
    get:
      description: Get a single Collaboration by ID.
      operationId: Collaboration.Get
      parameters:
      - description: ID of the Collaboration.
        in: path
        name: collaboration_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collaboration'
          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 Collaboration by ID
      tags:
      - Collaboration
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update Collaboration.
      operationId: Collaboration.Update
      parameters:
      - description: ID of the Collaboration.
        in: path
        name: collaboration_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCollaborationInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collaboration'
          description: OK
        '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: Update Collaboration
      tags:
      - Collaboration
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /collaboration:batch-create:
    post:
      description: Batch create Collaboration synchronously in one transaction. Maximum
        25 items per request.
      operationId: Collaboration.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateCollaborationInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Collaboration'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create Collaboration
      tags:
      - Collaboration
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /collaboration:batch-delete:
    post:
      description: Batch delete Collaboration synchronously in one transaction. Maximum
        25 items per request.
      operationId: Collaboration.BatchDelete
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/DeleteCollaborationInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      additionalProperties: false
                      properties:
                        id:
                          type: string
                      required:
                      - id
                      type: object
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch delete Collaboration
      tags:
      - Collaboration
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /collaboration:batch-update:
    patch:
      description: Batch update Collaboration synchronously in one transaction. Maximum
        25 items per request.
      operationId: Collaboration.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateCollaborationInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Collaboration'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Collaboration
      tags:
      - Collaboration
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /collaboration:bulk-create:
    post:
      description: Bulk create Collaboration.
      operationId: Collaboration.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create Collaboration
      tags:
      - Collaboration
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /collaboration:bulk-update:
    patch:
      description: Bulk update Collaboration.
      operationId: Collaboration.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Collaboration
      tags:
      - Collaboration
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /config-import-history-entry/items:
    get:
      description: List ConfigImportHistoryEntry items.
      operationId: ConfigImportHistoryEntry.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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigImportHistoryEntryPaginatedList'
          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 ConfigImportHistoryEntry items
      tags:
      - ConfigImportHistoryEntry
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /config-import-history-entry/{config_import_history_entry_id}:
    get:
      description: Get a single ConfigImportHistoryEntry by ID.
      operationId: ConfigImportHistoryEntry.Get
      parameters:
      - description: ID of the ConfigImportHistoryEntry.
        in: path
        name: config_import_history_entry_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigImportHistoryEntry'
          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 ConfigImportHistoryEntry by ID
      tags:
      - ConfigImportHistoryEntry
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /container:
    post:
      description: Create Container.
      operationId: Container.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateContainerInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Container'
          description: Created
        '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: Create Container
      tags:
      - Container
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /container-schema:
    post:
      description: Create ContainerSchema.
      operationId: ContainerSchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateContainerSchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerSchema'
          description: Created
        '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: Create ContainerSchema
      tags:
      - ContainerSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /container-schema/items:
    get:
      description: List ContainerSchema items.
      operationId: ContainerSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerSchemaPaginatedList'
          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 ContainerSchema items
      tags:
      - ContainerSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /container-schema/{container_schema_id}:
    get:
      description: Get a single ContainerSchema by ID.
      operationId: ContainerSchema.Get
      parameters:
      - description: ID of the ContainerSchema.
        in: path
        name: container_schema_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerSchema'
          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 ContainerSchema by ID
      tags:
      - ContainerSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update ContainerSchema.
      operationId: ContainerSchema.Update
      parameters:
      - description: ID of the ContainerSchema.
        in: path
        name: container_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateContainerSchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerSchema'
          description: OK
        '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: Update ContainerSchema
      tags:
      - ContainerSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /container-schema/{container_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: ContainerSchema.fieldDefinitions.List
      parameters:
      - description: ID of the ContainerSchema.
        in: path
        name: container_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - ContainerSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /container-schema:batch-create:
    post:
      description: Batch create ContainerSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: ContainerSchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateContainerSchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/ContainerSchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create ContainerSchema
      tags:
      - ContainerSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /container-schema:batch-update:
    patch:
      description: Batch update ContainerSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: ContainerSchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateContainerSchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/ContainerSchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update ContainerSchema
      tags:
      - ContainerSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /container-schema:bulk-create:
    post:
      description: Bulk create ContainerSchema.
      operationId: ContainerSchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create ContainerSchema
      tags:
      - ContainerSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /container-schema:bulk-update:
    patch:
      description: Bulk update ContainerSchema.
      operationId: ContainerSchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update ContainerSchema
      tags:
      - ContainerSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /container/items:
    get:
      description: List Container items.
      operationId: Container.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/barcode.anyOf'
      - $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/mentionedIn.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/parentStorage.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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerPaginatedList'
          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 Container items
      tags:
      - Container
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /container/{container_id}:
    get:
      description: Get a single Container by ID.
      operationId: Container.Get
      parameters:
      - description: ID of the Container.
        in: path
        name: container_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Container'
          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 Container by ID
      tags:
      - Container
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update Container.
      operationId: Container.Update
      parameters:
      - description: ID of the Container.
        in: path
        name: container_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateContainerInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Container'
          description: OK
        '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: Update Container
      tags:
      - Container
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /container/{container_id}:remove-content:
    post:
      description: Remove content from a container.
      operationId: Container.RemoveContent
      parameters:
      - description: ID of the Container.
        in: path
        name: container_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContainerRemoveContentInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Container'
          description: OK
        '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: Remove content from a container.
      tags:
      - Container
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /container/{container_id}:update-content-concentration:
    post:
      description: Update the concentration of content in a container.
      operationId: Container.UpdateContentConcentration
      parameters:
      - description: ID of the Container.
        in: path
        name: container_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContainerUpdateContentConcentrationInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Container'
          description: OK
        '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: Update the concentration of content in a container.
      tags:
      - Container
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /container:batch-create:
    post:
      description: Batch create Container synchronously in one transaction. Maximum
        25 items per request.
      operationId: Container.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateContainerInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Container'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create Container
      tags:
      - Container
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /container:batch-update:
    patch:
      description: Batch update Container synchronously in one transaction. Maximum
        25 items per request.
      operationId: Container.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateContainerInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Container'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Container
      tags:
      - Container
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /container:bulk-create:
    post:
      description: Bulk create Container.
      operationId: Container.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create Container
      tags:
      - Container
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /container:bulk-update:
    patch:
      description: Bulk update Container.
      operationId: Container.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Container
      tags:
      - Container
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /container:transfer:
    post:
      description: Transfer contents from sources into destination containers. Each
        row specifies a destination container and exactly one source (container or
        entity), the quantity to transfer, an optional final quantity to dilute the
        destination to, and an optional source concentration override.
      operationId: Container.Transfer
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Transfer contents from sources into destination containers. Each row
        specifies a destination container and exactly one source (container or entity),
        the quantity to transfer, an optional final quantity to dilute the destination
        to, and an optional source concentration override.
      tags:
      - Container
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /custom-entity:
    post:
      description: Create CustomEntity.
      operationId: CustomEntity.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomEntityInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEntity'
          description: Created
        '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: Create CustomEntity
      tags:
      - CustomEntity
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /custom-entity-schema:
    post:
      description: Create CustomEntitySchema.
      operationId: CustomEntitySchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomEntitySchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEntitySchema'
          description: Created
        '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: Create CustomEntitySchema
      tags:
      - CustomEntitySchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /custom-entity-schema/items:
    get:
      description: List CustomEntitySchema items.
      operationId: CustomEntitySchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEntitySchemaPaginatedList'
          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 CustomEntitySchema items
      tags:
      - CustomEntitySchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /custom-entity-schema/{custom_entity_schema_id}:
    get:
      description: Get a single CustomEntitySchema by ID.
      operationId: CustomEntitySchema.Get
      parameters:
      - description: ID of the CustomEntitySchema.
        in: path
        name: custom_entity_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEntitySchema'
          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 CustomEntitySchema by ID
      tags:
      - CustomEntitySchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update CustomEntitySchema.
      operationId: CustomEntitySchema.Update
      parameters:
      - description: ID of the CustomEntitySchema.
        in: path
        name: custom_entity_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomEntitySchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEntitySchema'
          description: OK
        '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: Update CustomEntitySchema
      tags:
      - CustomEntitySchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /custom-entity-schema/{custom_entity_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: CustomEntitySchema.fieldDefinitions.List
      parameters:
      - description: ID of the CustomEntitySchema.
        in: path
        name: custom_entity_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - CustomEntitySchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /custom-entity-schema/{custom_entity_schema_id}/fieldsets/items:
    get:
      description: List Fieldset items.
      operationId: CustomEntitySchema.fieldsets.List
      parameters:
      - description: ID of the CustomEntitySchema.
        in: path
        name: custom_entity_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsetUnpaginatedList'
          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 Fieldset items
      tags:
      - CustomEntitySchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /custom-entity-schema/{custom_entity_schema_id}:apply-fieldset:
    post:
      description: Apply a fieldset to the schema
      operationId: CustomEntitySchema.ApplyFieldset
      parameters:
      - description: ID of the CustomEntitySchema.
        in: path
        name: custom_entity_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitySchemaApplyFieldsetInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Apply a fieldset to the schema
      tags:
      - CustomEntitySchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /custom-entity-schema/{custom_entity_schema_id}:set-field-definitions:
    post:
      description: Set field definitions on the schema
      operationId: CustomEntitySchema.SetFieldDefinitions
      parameters:
      - description: ID of the CustomEntitySchema.
        in: path
        name: custom_entity_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomEntitySchemaSetFieldDefinitionsInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Set field definitions on the schema
      tags:
      - CustomEntitySchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /custom-entity-schema:batch-create:
    post:
      description: Batch create CustomEntitySchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: CustomEntitySchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateCustomEntitySchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/CustomEntitySchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create CustomEntitySchema
      tags:
      - CustomEntitySchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /custom-entity-schema:batch-update:
    patch:
      description: Batch update CustomEntitySchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: CustomEntitySchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateCustomEntitySchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/CustomEntitySchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update CustomEntitySchema
      tags:
      - CustomEntitySchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /custom-entity-schema:bulk-create:
    post:
      description: Bulk create CustomEntitySchema.
      operationId: CustomEntitySchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create CustomEntitySchema
      tags:
      - CustomEntitySchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /custom-entity-schema:bulk-update:
    patch:
      description: Bulk update CustomEntitySchema.
      operationId: CustomEntitySchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update CustomEntitySchema
      tags:
      - CustomEntitySchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /custom-entity/items:
    get:
      description: List CustomEntity items.
      operationId: CustomEntity.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/authors.anyOf'
      - $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/fieldset.anyOf'
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/mentionedIn.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/project.eq'
      - $ref: '#/components/parameters/registry.eq'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/schema.anyOf'
      - $ref: '#/components/parameters/schema.eq'
      - $ref: '#/components/parameters/systemCategory.anyOf'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEntityPaginatedList'
          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 CustomEntity items
      tags:
      - CustomEntity
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /custom-entity/{custom_entity_id}:
    get:
      description: Get a single CustomEntity by ID.
      operationId: CustomEntity.Get
      parameters:
      - description: ID of the CustomEntity.
        in: path
        name: custom_entity_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEntity'
          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 CustomEntity by ID
      tags:
      - CustomEntity
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update CustomEntity.
      operationId: CustomEntity.Update
      parameters:
      - description: ID of the CustomEntity.
        in: path
        name: custom_entity_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomEntityInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEntity'
          description: OK
        '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: Update CustomEntity
      tags:
      - CustomEntity
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /custom-entity/{custom_entity_id}/authors/items:
    get:
      description: List Principal items.
      operationId: CustomEntity.authors.List
      parameters:
      - description: ID of the CustomEntity.
        in: path
        name: custom_entity_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - CustomEntity
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /custom-entity:batch-create:
    post:
      description: Batch create CustomEntity synchronously in one transaction. Maximum
        25 items per request.
      operationId: CustomEntity.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateCustomEntityInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/CustomEntity'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create CustomEntity
      tags:
      - CustomEntity
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /custom-entity:batch-update:
    patch:
      description: Batch update CustomEntity synchronously in one transaction. Maximum
        25 items per request.
      operationId: CustomEntity.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateCustomEntityInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/CustomEntity'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update CustomEntity
      tags:
      - CustomEntity
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /custom-entity:bulk-create:
    post:
      description: Bulk create CustomEntity.
      operationId: CustomEntity.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create CustomEntity
      tags:
      - CustomEntity
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /custom-entity:bulk-update:
    patch:
      description: Bulk update CustomEntity.
      operationId: CustomEntity.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update CustomEntity
      tags:
      - CustomEntity
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /data-frame/items:
    get:
      description: List DataFrame items.
      operationId: DataFrame.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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFramePaginatedList'
          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 DataFrame items
      tags:
      - DataFrame
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /data-frame/{data_frame_id}:
    get:
      description: Get a single DataFrame by ID.
      operationId: DataFrame.Get
      parameters:
      - description: ID of the DataFrame.
        in: path
        name: data_frame_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFrame'
          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 DataFrame by ID
      tags:
      - DataFrame
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /dataset/items:
    get:
      description: List Dataset items.
      operationId: Dataset.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetPaginatedList'
          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 Dataset items
      tags:
      - Dataset
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dataset/{dataset_id}:
    get:
      description: Get a single Dataset by ID.
      operationId: Dataset.Get
      parameters:
      - description: ID of the Dataset.
        in: path
        name: dataset_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dataset'
          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 Dataset by ID
      tags:
      - Dataset
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /dna-oligo:
    post:
      description: Create DnaOligo.
      operationId: DnaOligo.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDnaOligoInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaOligo'
          description: Created
        '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: Create DnaOligo
      tags:
      - DnaOligo
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-oligo-schema:
    post:
      description: Create DnaOligoSchema.
      operationId: DnaOligoSchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDnaOligoSchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaOligoSchema'
          description: Created
        '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: Create DnaOligoSchema
      tags:
      - DnaOligoSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-oligo-schema/items:
    get:
      description: List DnaOligoSchema items.
      operationId: DnaOligoSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaOligoSchemaPaginatedList'
          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 DnaOligoSchema items
      tags:
      - DnaOligoSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-oligo-schema/{dna_oligo_schema_id}:
    get:
      description: Get a single DnaOligoSchema by ID.
      operationId: DnaOligoSchema.Get
      parameters:
      - description: ID of the DnaOligoSchema.
        in: path
        name: dna_oligo_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaOligoSchema'
          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 DnaOligoSchema by ID
      tags:
      - DnaOligoSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update DnaOligoSchema.
      operationId: DnaOligoSchema.Update
      parameters:
      - description: ID of the DnaOligoSchema.
        in: path
        name: dna_oligo_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDnaOligoSchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaOligoSchema'
          description: OK
        '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: Update DnaOligoSchema
      tags:
      - DnaOligoSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-oligo-schema/{dna_oligo_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: DnaOligoSchema.fieldDefinitions.List
      parameters:
      - description: ID of the DnaOligoSchema.
        in: path
        name: dna_oligo_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - DnaOligoSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-oligo-schema/{dna_oligo_schema_id}/fieldsets/items:
    get:
      description: List Fieldset items.
      operationId: DnaOligoSchema.fieldsets.List
      parameters:
      - description: ID of the DnaOligoSchema.
        in: path
        name: dna_oligo_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsetUnpaginatedList'
          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 Fieldset items
      tags:
      - DnaOligoSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-oligo-schema/{dna_oligo_schema_id}:apply-fieldset:
    post:
      description: Apply a fieldset to the schema
      operationId: DnaOligoSchema.ApplyFieldset
      parameters:
      - description: ID of the DnaOligoSchema.
        in: path
        name: dna_oligo_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitySchemaApplyFieldsetInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Apply a fieldset to the schema
      tags:
      - DnaOligoSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-oligo-schema/{dna_oligo_schema_id}:set-field-definitions:
    post:
      description: Set field definitions on the schema
      operationId: DnaOligoSchema.SetFieldDefinitions
      parameters:
      - description: ID of the DnaOligoSchema.
        in: path
        name: dna_oligo_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DnaOligoSchemaSetFieldDefinitionsInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Set field definitions on the schema
      tags:
      - DnaOligoSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-oligo-schema:batch-create:
    post:
      description: Batch create DnaOligoSchema synchronously in one transaction. Maximum
        25 items per request.
      operationId: DnaOligoSchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateDnaOligoSchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/DnaOligoSchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create DnaOligoSchema
      tags:
      - DnaOligoSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /dna-oligo-schema:batch-update:
    patch:
      description: Batch update DnaOligoSchema synchronously in one transaction. Maximum
        25 items per request.
      operationId: DnaOligoSchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateDnaOligoSchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/DnaOligoSchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update DnaOligoSchema
      tags:
      - DnaOligoSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /dna-oligo-schema:bulk-create:
    post:
      description: Bulk create DnaOligoSchema.
      operationId: DnaOligoSchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create DnaOligoSchema
      tags:
      - DnaOligoSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /dna-oligo-schema:bulk-update:
    patch:
      description: Bulk update DnaOligoSchema.
      operationId: DnaOligoSchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update DnaOligoSchema
      tags:
      - DnaOligoSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /dna-oligo/items:
    get:
      description: List DnaOligo items.
      operationId: DnaOligo.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/authors.anyOf'
      - $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/fieldset.anyOf'
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/mentionedIn.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/project.eq'
      - $ref: '#/components/parameters/registry.eq'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/schema.anyOf'
      - $ref: '#/components/parameters/schema.eq'
      - $ref: '#/components/parameters/systemCategory.anyOf'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaOligoPaginatedList'
          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 DnaOligo items
      tags:
      - DnaOligo
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-oligo/{dna_oligo_id}:
    get:
      description: Get a single DnaOligo by ID.
      operationId: DnaOligo.Get
      parameters:
      - description: ID of the DnaOligo.
        in: path
        name: dna_oligo_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaOligo'
          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 DnaOligo by ID
      tags:
      - DnaOligo
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update DnaOligo.
      operationId: DnaOligo.Update
      parameters:
      - description: ID of the DnaOligo.
        in: path
        name: dna_oligo_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDnaOligoInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaOligo'
          description: OK
        '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: Update DnaOligo
      tags:
      - DnaOligo
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-oligo/{dna_oligo_id}/authors/items:
    get:
      description: List Principal items.
      operationId: DnaOligo.authors.List
      parameters:
      - description: ID of the DnaOligo.
        in: path
        name: dna_oligo_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - DnaOligo
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-oligo/{dna_oligo_id}/modified-nucleotides/items:
    get:
      description: List ModifiedNucleotide items.
      operationId: DnaOligo.modifiedNucleotides.List
      parameters:
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/pageSize'
      - description: ID of the DnaOligo.
        in: path
        name: dna_oligo_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifiedNucleotidePaginatedList'
          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 ModifiedNucleotide items
      tags:
      - DnaOligo
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-oligo:batch-create:
    post:
      description: Batch create DnaOligo synchronously in one transaction. Maximum
        25 items per request.
      operationId: DnaOligo.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateDnaOligoInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/DnaOligo'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create DnaOligo
      tags:
      - DnaOligo
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /dna-oligo:batch-update:
    patch:
      description: Batch update DnaOligo synchronously in one transaction. Maximum
        25 items per request.
      operationId: DnaOligo.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateDnaOligoInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/DnaOligo'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update DnaOligo
      tags:
      - DnaOligo
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /dna-oligo:bulk-create:
    post:
      description: Bulk create DnaOligo.
      operationId: DnaOligo.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create DnaOligo
      tags:
      - DnaOligo
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /dna-oligo:bulk-update:
    patch:
      description: Bulk update DnaOligo.
      operationId: DnaOligo.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update DnaOligo
      tags:
      - DnaOligo
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /dna-sequence:
    post:
      description: Create DnaSequence.
      operationId: DnaSequence.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDnaSequenceInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaSequence'
          description: Created
        '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: Create DnaSequence
      tags:
      - DnaSequence
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-sequence-schema:
    post:
      description: Create DnaSequenceSchema.
      operationId: DnaSequenceSchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDnaSequenceSchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaSequenceSchema'
          description: Created
        '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: Create DnaSequenceSchema
      tags:
      - DnaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-sequence-schema/items:
    get:
      description: List DnaSequenceSchema items.
      operationId: DnaSequenceSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaSequenceSchemaPaginatedList'
          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 DnaSequenceSchema items
      tags:
      - DnaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-sequence-schema/{dna_sequence_schema_id}:
    get:
      description: Get a single DnaSequenceSchema by ID.
      operationId: DnaSequenceSchema.Get
      parameters:
      - description: ID of the DnaSequenceSchema.
        in: path
        name: dna_sequence_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaSequenceSchema'
          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 DnaSequenceSchema by ID
      tags:
      - DnaSequenceSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update DnaSequenceSchema.
      operationId: DnaSequenceSchema.Update
      parameters:
      - description: ID of the DnaSequenceSchema.
        in: path
        name: dna_sequence_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDnaSequenceSchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaSequenceSchema'
          description: OK
        '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: Update DnaSequenceSchema
      tags:
      - DnaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-sequence-schema/{dna_sequence_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: DnaSequenceSchema.fieldDefinitions.List
      parameters:
      - description: ID of the DnaSequenceSchema.
        in: path
        name: dna_sequence_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - DnaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-sequence-schema/{dna_sequence_schema_id}/fieldsets/items:
    get:
      description: List Fieldset items.
      operationId: DnaSequenceSchema.fieldsets.List
      parameters:
      - description: ID of the DnaSequenceSchema.
        in: path
        name: dna_sequence_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsetUnpaginatedList'
          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 Fieldset items
      tags:
      - DnaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-sequence-schema/{dna_sequence_schema_id}:apply-fieldset:
    post:
      description: Apply a fieldset to the schema
      operationId: DnaSequenceSchema.ApplyFieldset
      parameters:
      - description: ID of the DnaSequenceSchema.
        in: path
        name: dna_sequence_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitySchemaApplyFieldsetInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Apply a fieldset to the schema
      tags:
      - DnaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-sequence-schema/{dna_sequence_schema_id}:set-field-definitions:
    post:
      description: Set field definitions on the schema
      operationId: DnaSequenceSchema.SetFieldDefinitions
      parameters:
      - description: ID of the DnaSequenceSchema.
        in: path
        name: dna_sequence_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DnaSequenceSchemaSetFieldDefinitionsInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Set field definitions on the schema
      tags:
      - DnaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-sequence-schema:batch-create:
    post:
      description: Batch create DnaSequenceSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: DnaSequenceSchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateDnaSequenceSchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/DnaSequenceSchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create DnaSequenceSchema
      tags:
      - DnaSequenceSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /dna-sequence-schema:batch-update:
    patch:
      description: Batch update DnaSequenceSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: DnaSequenceSchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateDnaSequenceSchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/DnaSequenceSchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update DnaSequenceSchema
      tags:
      - DnaSequenceSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /dna-sequence-schema:bulk-create:
    post:
      description: Bulk create DnaSequenceSchema.
      operationId: DnaSequenceSchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create DnaSequenceSchema
      tags:
      - DnaSequenceSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /dna-sequence-schema:bulk-update:
    patch:
      description: Bulk update DnaSequenceSchema.
      operationId: DnaSequenceSchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update DnaSequenceSchema
      tags:
      - DnaSequenceSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /dna-sequence/items:
    get:
      description: List DnaSequence items.
      operationId: DnaSequence.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/authors.anyOf'
      - $ref: '#/components/parameters/bases.anyOf'
      - $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/fieldset.anyOf'
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/mentionedIn.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/project.eq'
      - $ref: '#/components/parameters/registry.eq'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/schema.anyOf'
      - $ref: '#/components/parameters/schema.eq'
      - $ref: '#/components/parameters/systemCategory.anyOf'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaSequencePaginatedList'
          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 DnaSequence items
      tags:
      - DnaSequence
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-sequence/{dna_sequence_id}:
    get:
      description: Get a single DnaSequence by ID.
      operationId: DnaSequence.Get
      parameters:
      - description: ID of the DnaSequence.
        in: path
        name: dna_sequence_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaSequence'
          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 DnaSequence by ID
      tags:
      - DnaSequence
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update DnaSequence.
      operationId: DnaSequence.Update
      parameters:
      - description: ID of the DnaSequence.
        in: path
        name: dna_sequence_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDnaSequenceInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaSequence'
          description: OK
        '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: Update DnaSequence
      tags:
      - DnaSequence
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-sequence/{dna_sequence_id}/authors/items:
    get:
      description: List Principal items.
      operationId: DnaSequence.authors.List
      parameters:
      - description: ID of the DnaSequence.
        in: path
        name: dna_sequence_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - DnaSequence
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-sequence/{dna_sequence_id}/parts/items:
    get:
      description: List DnaPart items.
      operationId: DnaSequence.parts.List
      parameters:
      - description: ID of the DnaSequence.
        in: path
        name: dna_sequence_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DnaPartUnpaginatedList'
          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 DnaPart items
      tags:
      - DnaSequence
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dna-sequence:batch-create:
    post:
      description: Batch create DnaSequence synchronously in one transaction. Maximum
        25 items per request.
      operationId: DnaSequence.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateDnaSequenceInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/DnaSequence'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create DnaSequence
      tags:
      - DnaSequence
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /dna-sequence:batch-update:
    patch:
      description: Batch update DnaSequence synchronously in one transaction. Maximum
        25 items per request.
      operationId: DnaSequence.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateDnaSequenceInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/DnaSequence'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update DnaSequence
      tags:
      - DnaSequence
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /dna-sequence:bulk-create:
    post:
      description: Bulk create DnaSequence.
      operationId: DnaSequence.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create DnaSequence
      tags:
      - DnaSequence
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /dna-sequence:bulk-update:
    patch:
      description: Bulk update DnaSequence.
      operationId: DnaSequence.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update DnaSequence
      tags:
      - DnaSequence
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /document-export:
    post:
      description: 'Create an asynchronous task that exports a single item that can
        be downloaded as a ZIP

        archive. The task can be polled via the returned `pollingUri` for status and,
        on success,

        a download link.


        Supported item types are resolved from the `id` prefix: notebook entries (`etr_`),

        worksheets (`wks_`), sequences (`seq_`), proteins (`prtn_`), and molecules
        (`mol_`).


        In rare cases, attachments still being scanned for viruses are omitted from
        the export.

        '
      operationId: DocumentExport.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                format:
                  description: 'Export format. Only supported for notebook entries
                    (`pdf` or `html`, default

                    `pdf`). All other item types render to their single native output,
                    so providing

                    `format` for a non-entry item is rejected with a 400.

                    '
                  enum:
                  - pdf
                  - html
                  example: pdf
                  type: string
                id:
                  description: API ID of the item to export.
                  example: etr_aBcD1234
                  type: string
              required:
              - id
              type: object
        description: The item to export and the desired format.
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                properties:
                  pollingUri:
                    example: https://example.benchling.com/api/v3/tasks/document-export/3f152353-7593-48bc-8049-962890d1be84
                    type: string
                  taskId:
                    example: 3f152353-7593-48bc-8049-962890d1be84
                    type: string
                required:
                - taskId
                - pollingUri
                type: object
          description: Export task started
        '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: Export a single item to a downloadable file
      tags:
      - DocumentExport
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /document-part-unstructured-table/{doc_part_id}:
    get:
      description: 'Return the unstructured table content for a DocumentPart that
        is an unstructured table.

        Return 404 if the document part does not exist.

        Return 400 if the document part is not an unstructured table.


        Rows are paginated: pass `pageSize` and the `nextToken` from the previous
        response to page

        through rows. Each row carries its absolute `rowIndex`.

        '
      operationId: DocumentPartUnstructuredTable.Get
      parameters:
      - in: path
        name: doc_part_id
        required: true
        schema:
          type: string
      - description: Maximum number of table rows to return in a single page.
        in: query
        name: pageSize
        schema:
          default: 1000
          maximum: 1000
          minimum: 1
          type: integer
      - description: Page token from a previous response, used to fetch the next page
          of rows.
        in: query
        name: nextToken
        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:
                properties:
                  __typename:
                    type: string
                  container:
                    $ref: '#/components/schemas/ObjectRef'
                  content:
                    $ref: '#/components/schemas/UnstructuredTableDocumentContentDetail'
                  id:
                    type: string
                  modifiedAt:
                    format: date-time
                    type: string
                  modifier:
                    oneOf:
                    - $ref: '#/components/schemas/PrincipalRef'
                    - type: 'null'
                  nextToken:
                    description: 'Opaque cursor for the next page of rows. Empty string
                      when there are no more rows.

                      Note: a merge anchor cell may reside on an earlier page than
                      its child cells.

                      '
                    type: string
                  pageSize:
                    description: The page size applied to this response.
                    type: integer
                  versionId:
                    type: string
                type: object
          description: Unstructured table content
        '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 unstructured table content for a document part
      tags:
      - DocumentPart
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: 'Update an unstructured table''s column definitions and cell content.

        All row and column indices in this endpoint are 0-based.

        Both columnDefinitions and rows are optional; omitting either preserves the
        existing values.

        When provided, they fully replace the existing values with no per-field carry-forward.

        Cells in locked columns cannot be modified; lock enforcement uses the post-mutation

        column state, so unlocking a column and editing its cells can be done in a
        single request.

        When adding rows to a table with locked columns, the new rows'' locked-column
        cells must be empty.

        Requires versionId for optimistic concurrency; returns 409 on stale version.

        Returns 400 if the document part is not an unstructured table or validation
        fails.

        '
      operationId: DocumentPartUnstructuredTable.Update
      parameters:
      - in: path
        name: doc_part_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
      requestBody:
        content:
          application/json:
            schema:
              properties:
                columnDefinitions:
                  description: 'Column definitions for the table. Omit to preserve
                    existing columns. When provided, fully replaces all column definitions;
                    omitted fields on each column definition default to null (not
                    the existing value).

                    '
                  items:
                    properties:
                      isLocked:
                        type: boolean
                      name:
                        nullable: true
                        type: string
                      width:
                        nullable: true
                        type: number
                    type: object
                  type: array
                name:
                  description: 'Display name of the table. Must be non-empty, at most
                    100 characters, and unique within the document. Omit to preserve
                    the existing name.

                    '
                  type: string
                rows:
                  description: 'Row data for the table. Omit to preserve existing
                    rows. When provided, fully replaces all rows with no per-cell
                    carry-forward of format, selectorId, or other fields from the
                    existing table.

                    '
                  items:
                    properties:
                      cells:
                        items:
                          description: 'A cell is one of three variants:

                            - Value cell: inputValue object; mergeRange and mergeRangeParent
                            both null or omitted.

                            - Anchor cell: inputValue object and mergeRange object;
                            mergeRangeParent null or omitted. Defines the top-left
                            of a merged region.

                            - Child cell: mergeRangeParent object; mergeRange null
                            or omitted and inputValue empty. References the anchor
                            cell that owns this position.

                            mergeRange and mergeRangeParent are optional; omitting
                            either field is equivalent to sending null (clears the
                            value).

                            '
                          properties:
                            format:
                              description: 'Cell formatting. If provided, fully replaces
                                any existing format. Set to null, an empty object,
                                or omit to clear all formatting.

                                '
                              nullable: true
                              properties:
                                alignment:
                                  enum:
                                  - LEFT
                                  - CENTER
                                  - RIGHT
                                  nullable: true
                                  type: string
                                backgroundColor:
                                  description: 'Hex color code (#RGB or #RRGGBB).'
                                  nullable: true
                                  type: string
                                foregroundColor:
                                  description: 'Hex color code (#RGB or #RRGGBB).'
                                  nullable: true
                                  type: string
                                link:
                                  nullable: true
                                  type: string
                                properties:
                                  items:
                                    enum:
                                    - BOLD
                                    - ITALIC
                                    - UNDERLINE
                                    - STRIKETHROUGH
                                    - IMPORTANT
                                    type: string
                                  type: array
                              type: object
                            inputValue:
                              description: The cell's input value. For unstructured
                                tables this is always a TextValue.
                              properties:
                                type:
                                  enum:
                                  - text_value
                                  type: string
                                value:
                                  type: string
                              required:
                              - type
                              - value
                              type: object
                            mergeRange:
                              description: 'Defines this cell as the anchor of a merged
                                region with the given row and column span. Send null
                                to clear any existing merge anchor. Omitting is equivalent
                                to null.

                                '
                              nullable: true
                              properties:
                                mergeColSpan:
                                  minimum: 1
                                  type: integer
                                mergeRowSpan:
                                  minimum: 1
                                  type: integer
                              required:
                              - mergeRowSpan
                              - mergeColSpan
                              type: object
                            mergeRangeParent:
                              description: 'Marks this cell as a merge child belonging
                                to the anchor at the given (row, col). Send null to
                                clear any existing merge parent. Omitting is equivalent
                                to null.

                                '
                              nullable: true
                              properties:
                                col:
                                  type: integer
                                row:
                                  type: integer
                              required:
                              - row
                              - col
                              type: object
                            selectorId:
                              description: 'Id of a TableCellSelector on the parent
                                entry or template. Set to assign a dropdown selector
                                to this cell. Set to null or omit to clear the selector
                                reference.

                                '
                              nullable: true
                              type: string
                          required:
                          - inputValue
                          type: object
                        type: array
                    required:
                    - cells
                    type: object
                  type: array
                versionId:
                  description: The document's current versionId from the last GET
                    response. Required for optimistic concurrency.
                  type: string
              required:
              - versionId
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  __typename:
                    type: string
                  container:
                    $ref: '#/components/schemas/ObjectRef'
                  content:
                    $ref: '#/components/schemas/UnstructuredTableDocumentContentDetail'
                  id:
                    type: string
                  modifiedAt:
                    format: date-time
                    type: string
                  modifier:
                    oneOf:
                    - $ref: '#/components/schemas/PrincipalRef'
                    - type: 'null'
                  versionId:
                    type: string
                type: object
          description: Updated unstructured table content
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Update an unstructured table
      tags:
      - DocumentPart
      - Tier 1 Rate Limit
      x-bnch-rate-limit-tier: 1
  /document-part/items:
    get:
      description: List DocumentPart items.
      operationId: DocumentPart.List
      parameters:
      - $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/returning'
      - description: 'Method by which to order results. Valid sorts are: 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:
          - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentPartPaginatedList'
          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 DocumentPart items
      tags:
      - DocumentPart
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /document-part/{document_part_id}:
    get:
      description: Get a single DocumentPart by ID.
      operationId: DocumentPart.Get
      parameters:
      - description: ID of the DocumentPart.
        in: path
        name: document_part_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentPart'
          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 DocumentPart by ID
      tags:
      - DocumentPart
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /dropdown:
    post:
      description: Create Dropdown.
      operationId: Dropdown.Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDropdownInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dropdown'
          description: Created
        '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: Create Dropdown
      tags:
      - Dropdown
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dropdown-link-field-definition/items:
    get:
      description: List DropdownLinkFieldDefinition items.
      operationId: DropdownLinkFieldDefinition.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DropdownLinkFieldDefinitionPaginatedList'
          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 DropdownLinkFieldDefinition items
      tags:
      - DropdownLinkFieldDefinition
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dropdown-link-field-definition/{dropdown_link_field_definition_id}:
    get:
      description: Get a single DropdownLinkFieldDefinition by ID.
      operationId: DropdownLinkFieldDefinition.Get
      parameters:
      - description: ID of the DropdownLinkFieldDefinition.
        in: path
        name: dropdown_link_field_definition_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DropdownLinkFieldDefinition'
          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 DropdownLinkFieldDefinition by ID
      tags:
      - DropdownLinkFieldDefinition
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /dropdown-option/items:
    get:
      description: List DropdownOption items.
      operationId: DropdownOption.List
      parameters:
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/returning'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DropdownOptionPaginatedList'
          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 DropdownOption items
      tags:
      - DropdownOption
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dropdown-option/{dropdown_option_id}:
    get:
      description: Get a single DropdownOption by ID.
      operationId: DropdownOption.Get
      parameters:
      - description: ID of the DropdownOption.
        in: path
        name: dropdown_option_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DropdownOption'
          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 DropdownOption by ID
      tags:
      - DropdownOption
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /dropdown/items:
    get:
      description: List Dropdown items.
      operationId: Dropdown.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/id.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/returning'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DropdownPaginatedList'
          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 Dropdown items
      tags:
      - Dropdown
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dropdown/{dropdown_id}:
    get:
      description: Get a single Dropdown by ID.
      operationId: Dropdown.Get
      parameters:
      - description: ID of the Dropdown.
        in: path
        name: dropdown_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dropdown'
          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 Dropdown by ID
      tags:
      - Dropdown
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update Dropdown.
      operationId: Dropdown.Update
      parameters:
      - description: ID of the Dropdown.
        in: path
        name: dropdown_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDropdownInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dropdown'
          description: OK
        '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: Update Dropdown
      tags:
      - Dropdown
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dropdown/{dropdown_id}/options/items:
    get:
      description: List DropdownOption items.
      operationId: Dropdown.options.List
      parameters:
      - description: ID of the Dropdown.
        in: path
        name: dropdown_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DropdownOptionUnpaginatedList'
          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 DropdownOption items
      tags:
      - Dropdown
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /dropdown:batch-create:
    post:
      description: Batch create Dropdown synchronously in one transaction. Maximum
        25 items per request.
      operationId: Dropdown.BatchCreate
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateDropdownInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Dropdown'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create Dropdown
      tags:
      - Dropdown
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /dropdown:batch-update:
    patch:
      description: Batch update Dropdown synchronously in one transaction. Maximum
        25 items per request.
      operationId: Dropdown.BatchUpdate
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateDropdownInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Dropdown'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Dropdown
      tags:
      - Dropdown
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /dropdown:bulk-create:
    post:
      description: Bulk create Dropdown.
      operationId: Dropdown.BulkCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create Dropdown
      tags:
      - Dropdown
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /dropdown:bulk-update:
    patch:
      description: Bulk update Dropdown.
      operationId: Dropdown.BulkUpdate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Dropdown
      tags:
      - Dropdown
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /entity-schema/items:
    get:
      description: List EntitySchema items.
      operationId: EntitySchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitySchemaPaginatedList'
          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 EntitySchema items
      tags:
      - EntitySchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /entity-schema/{entity_schema_id}:
    get:
      description: Get a single EntitySchema by ID.
      operationId: EntitySchema.Get
      parameters:
      - description: ID of the EntitySchema.
        in: path
        name: entity_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitySchema'
          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 EntitySchema by ID
      tags:
      - EntitySchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /entity-schema/{entity_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: EntitySchema.fieldDefinitions.List
      parameters:
      - description: ID of the EntitySchema.
        in: path
        name: entity_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - EntitySchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /entry:
    post:
      description: Create Entry.
      operationId: Entry.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEntryInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entry'
          description: Created
        '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: Create Entry
      tags:
      - Entry
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /entry-schema/items:
    get:
      description: List EntrySchema items.
      operationId: EntrySchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntrySchemaPaginatedList'
          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 EntrySchema items
      tags:
      - EntrySchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /entry-schema/{entry_schema_id}:
    get:
      description: Get a single EntrySchema by ID.
      operationId: EntrySchema.Get
      parameters:
      - description: ID of the EntrySchema.
        in: path
        name: entry_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntrySchema'
          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 EntrySchema by ID
      tags:
      - EntrySchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /entry-schema/{entry_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: EntrySchema.fieldDefinitions.List
      parameters:
      - description: ID of the EntrySchema.
        in: path
        name: entry_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - EntrySchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /entry-subtemplate/items:
    get:
      description: List EntrySubtemplate items.
      operationId: EntrySubtemplate.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntrySubtemplatePaginatedList'
          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 EntrySubtemplate items
      tags:
      - EntrySubtemplate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /entry-subtemplate/{entry_subtemplate_id}:
    get:
      description: Get a single EntrySubtemplate by ID.
      operationId: EntrySubtemplate.Get
      parameters:
      - description: ID of the EntrySubtemplate.
        in: path
        name: entry_subtemplate_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntrySubtemplate'
          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 EntrySubtemplate by ID
      tags:
      - EntrySubtemplate
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /entry-template/items:
    get:
      description: List EntryTemplate items.
      operationId: EntryTemplate.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntryTemplatePaginatedList'
          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 EntryTemplate items
      tags:
      - EntryTemplate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /entry-template/{entry_template_id}:
    get:
      description: Get a single EntryTemplate by ID.
      operationId: EntryTemplate.Get
      parameters:
      - description: ID of the EntryTemplate.
        in: path
        name: entry_template_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntryTemplate'
          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 EntryTemplate by ID
      tags:
      - EntryTemplate
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /entry/items:
    get:
      description: List Entry items.
      operationId: Entry.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/authors.anyOf'
      - $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/mentionedIn.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/returning'
      - $ref: '#/components/parameters/schema.anyOf'
      - $ref: '#/components/parameters/schema.eq'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntryPaginatedList'
          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 Entry items
      tags:
      - Entry
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /entry/{entry_id}:
    get:
      description: Get a single Entry by ID.
      operationId: Entry.Get
      parameters:
      - description: ID of the Entry.
        in: path
        name: entry_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entry'
          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 Entry by ID
      tags:
      - Entry
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update Entry.
      operationId: Entry.Update
      parameters:
      - description: ID of the Entry.
        in: path
        name: entry_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEntryInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entry'
          description: OK
        '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: Update Entry
      tags:
      - Entry
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /entry/{entry_id}/applicable-review-processes/items:
    get:
      description: List ReviewProcess items.
      operationId: Entry.applicableReviewProcesses.List
      parameters:
      - description: ID of the Entry.
        in: path
        name: entry_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewProcessUnpaginatedList'
          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 ReviewProcess items
      tags:
      - Entry
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /entry/{entry_id}/authors/items:
    get:
      description: List Principal items.
      operationId: Entry.authors.List
      parameters:
      - description: ID of the Entry.
        in: path
        name: entry_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - Entry
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /entry/{entry_id}/parts/items:
    get:
      description: List DocumentPart items.
      operationId: Entry.parts.List
      parameters:
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/pageSize'
      - description: ID of the Entry.
        in: path
        name: entry_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentPartPaginatedList'
          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 DocumentPart items
      tags:
      - Entry
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /entry:batch-create:
    post:
      description: Batch create Entry synchronously in one transaction. Maximum 25
        items per request.
      operationId: Entry.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateEntryInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Entry'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create Entry
      tags:
      - Entry
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /entry:batch-update:
    patch:
      description: Batch update Entry synchronously in one transaction. Maximum 25
        items per request.
      operationId: Entry.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateEntryInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Entry'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Entry
      tags:
      - Entry
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /entry:bulk-create:
    post:
      description: Bulk create Entry.
      operationId: Entry.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create Entry
      tags:
      - Entry
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /entry:bulk-update:
    patch:
      description: Bulk update Entry.
      operationId: Entry.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Entry
      tags:
      - Entry
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /enzyme-list/items:
    get:
      description: List EnzymeList items.
      operationId: EnzymeList.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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnzymeListPaginatedList'
          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 EnzymeList items
      tags:
      - EnzymeList
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /enzyme-list/{enzyme_list_id}:
    get:
      description: Get a single EnzymeList by ID.
      operationId: EnzymeList.Get
      parameters:
      - description: ID of the EnzymeList.
        in: path
        name: enzyme_list_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnzymeList'
          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 EnzymeList by ID
      tags:
      - EnzymeList
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /enzyme-list/{enzyme_list_id}/enzymes/items:
    get:
      description: List Enzyme items.
      operationId: EnzymeList.enzymes.List
      parameters:
      - description: ID of the EnzymeList.
        in: path
        name: enzyme_list_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnzymeUnpaginatedList'
          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 Enzyme items
      tags:
      - EnzymeList
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /enzyme/items:
    get:
      description: List Enzyme items.
      operationId: Enzyme.List
      parameters:
      - $ref: '#/components/parameters/id.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/returning'
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnzymePaginatedList'
          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 Enzyme items
      tags:
      - Enzyme
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /enzyme/{enzyme_id}:
    get:
      description: Get a single Enzyme by ID.
      operationId: Enzyme.Get
      parameters:
      - description: ID of the Enzyme.
        in: path
        name: enzyme_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Enzyme'
          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 Enzyme by ID
      tags:
      - Enzyme
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /enzyme/{enzyme_id}/isoschizomers/items:
    get:
      description: List Enzyme items.
      operationId: Enzyme.isoschizomers.List
      parameters:
      - description: ID of the Enzyme.
        in: path
        name: enzyme_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnzymeUnpaginatedList'
          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 Enzyme items
      tags:
      - Enzyme
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /equipment-schema:
    post:
      description: Create EquipmentSchema.
      operationId: EquipmentSchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEquipmentSchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentSchema'
          description: Created
        '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: Create EquipmentSchema
      tags:
      - EquipmentSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /equipment-schema/items:
    get:
      description: List EquipmentSchema items.
      operationId: EquipmentSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentSchemaPaginatedList'
          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 EquipmentSchema items
      tags:
      - EquipmentSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /equipment-schema/{equipment_schema_id}:
    get:
      description: Get a single EquipmentSchema by ID.
      operationId: EquipmentSchema.Get
      parameters:
      - description: ID of the EquipmentSchema.
        in: path
        name: equipment_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentSchema'
          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 EquipmentSchema by ID
      tags:
      - EquipmentSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update EquipmentSchema.
      operationId: EquipmentSchema.Update
      parameters:
      - description: ID of the EquipmentSchema.
        in: path
        name: equipment_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEquipmentSchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EquipmentSchema'
          description: OK
        '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: Update EquipmentSchema
      tags:
      - EquipmentSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /equipment-schema/{equipment_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: EquipmentSchema.fieldDefinitions.List
      parameters:
      - description: ID of the EquipmentSchema.
        in: path
        name: equipment_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - EquipmentSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /equipment-schema/{equipment_schema_id}/fieldsets/items:
    get:
      description: List Fieldset items.
      operationId: EquipmentSchema.fieldsets.List
      parameters:
      - description: ID of the EquipmentSchema.
        in: path
        name: equipment_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsetUnpaginatedList'
          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 Fieldset items
      tags:
      - EquipmentSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /equipment-schema/{equipment_schema_id}:apply-fieldset:
    post:
      description: Apply a fieldset to the schema
      operationId: EquipmentSchema.ApplyFieldset
      parameters:
      - description: ID of the EquipmentSchema.
        in: path
        name: equipment_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitySchemaApplyFieldsetInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Apply a fieldset to the schema
      tags:
      - EquipmentSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /equipment-schema/{equipment_schema_id}:set-field-definitions:
    post:
      description: Set field definitions on the schema
      operationId: EquipmentSchema.SetFieldDefinitions
      parameters:
      - description: ID of the EquipmentSchema.
        in: path
        name: equipment_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EquipmentSchemaSetFieldDefinitionsInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Set field definitions on the schema
      tags:
      - EquipmentSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /equipment-schema:batch-create:
    post:
      description: Batch create EquipmentSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: EquipmentSchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateEquipmentSchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/EquipmentSchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create EquipmentSchema
      tags:
      - EquipmentSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /equipment-schema:batch-update:
    patch:
      description: Batch update EquipmentSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: EquipmentSchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateEquipmentSchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/EquipmentSchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update EquipmentSchema
      tags:
      - EquipmentSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /equipment-schema:bulk-create:
    post:
      description: Bulk create EquipmentSchema.
      operationId: EquipmentSchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create EquipmentSchema
      tags:
      - EquipmentSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /equipment-schema:bulk-update:
    patch:
      description: Bulk update EquipmentSchema.
      operationId: EquipmentSchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update EquipmentSchema
      tags:
      - EquipmentSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /event-subscription/items:
    get:
      description: List EventSubscription items.
      operationId: EventSubscription.List
      parameters:
      - $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/returning'
      - description: 'Method by which to order results. Valid sorts are: 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:
          - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSubscriptionPaginatedList'
          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 EventSubscription items
      tags:
      - EventSubscription
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /event-subscription/{event_subscription_id}:
    get:
      description: Get a single EventSubscription by ID.
      operationId: EventSubscription.Get
      parameters:
      - description: ID of the EventSubscription.
        in: path
        name: event_subscription_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSubscription'
          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 EventSubscription by ID
      tags:
      - EventSubscription
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /feature-library-item/items:
    get:
      description: List FeatureLibraryItem items.
      operationId: FeatureLibraryItem.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/featureLibrary.eq'
      - $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/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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureLibraryItemPaginatedList'
          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 FeatureLibraryItem items
      tags:
      - FeatureLibraryItem
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /feature-library-item/{feature_library_item_id}:
    get:
      description: Get a single FeatureLibraryItem by ID.
      operationId: FeatureLibraryItem.Get
      parameters:
      - description: ID of the FeatureLibraryItem.
        in: path
        name: feature_library_item_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureLibraryItem'
          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 FeatureLibraryItem by ID
      tags:
      - FeatureLibraryItem
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /feature-library/items:
    get:
      description: List FeatureLibrary items.
      operationId: FeatureLibrary.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/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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureLibraryPaginatedList'
          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 FeatureLibrary items
      tags:
      - FeatureLibrary
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /feature-library/{feature_library_id}:
    get:
      description: Get a single FeatureLibrary by ID.
      operationId: FeatureLibrary.Get
      parameters:
      - description: ID of the FeatureLibrary.
        in: path
        name: feature_library_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureLibrary'
          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 FeatureLibrary by ID
      tags:
      - FeatureLibrary
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /feature-library/{feature_library_id}/features/items:
    get:
      description: List FeatureLibraryItem items.
      operationId: FeatureLibrary.features.List
      parameters:
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/pageSize'
      - description: ID of the FeatureLibrary.
        in: path
        name: feature_library_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureLibraryItemPaginatedList'
          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 FeatureLibraryItem items
      tags:
      - FeatureLibrary
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /fieldset:
    post:
      description: Create Fieldset.
      operationId: Fieldset.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFieldsetInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fieldset'
          description: Created
        '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: Create Fieldset
      tags:
      - Fieldset
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /fieldset/items:
    get:
      description: List Fieldset items.
      operationId: Fieldset.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsetPaginatedList'
          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 Fieldset items
      tags:
      - Fieldset
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /fieldset/{fieldset_id}:
    get:
      description: Get a single Fieldset by ID.
      operationId: Fieldset.Get
      parameters:
      - description: ID of the Fieldset.
        in: path
        name: fieldset_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fieldset'
          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 Fieldset by ID
      tags:
      - Fieldset
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update Fieldset.
      operationId: Fieldset.Update
      parameters:
      - description: ID of the Fieldset.
        in: path
        name: fieldset_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFieldsetInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fieldset'
          description: OK
        '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: Update Fieldset
      tags:
      - Fieldset
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /fieldset/{fieldset_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: Fieldset.fieldDefinitions.List
      parameters:
      - description: ID of the Fieldset.
        in: path
        name: fieldset_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - Fieldset
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /fieldset/{fieldset_id}:set-field-definitions:
    post:
      description: Set field definitions on the fieldset
      operationId: Fieldset.SetFieldDefinitions
      parameters:
      - description: ID of the Fieldset.
        in: path
        name: fieldset_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FieldsetSetFieldDefinitionsInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Set field definitions on the fieldset
      tags:
      - Fieldset
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /fieldset:batch-create:
    post:
      description: Batch create Fieldset synchronously in one transaction. Maximum
        25 items per request.
      operationId: Fieldset.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateFieldsetInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Fieldset'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create Fieldset
      tags:
      - Fieldset
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /fieldset:batch-update:
    patch:
      description: Batch update Fieldset synchronously in one transaction. Maximum
        25 items per request.
      operationId: Fieldset.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateFieldsetInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Fieldset'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Fieldset
      tags:
      - Fieldset
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /fieldset:bulk-create:
    post:
      description: Bulk create Fieldset.
      operationId: Fieldset.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create Fieldset
      tags:
      - Fieldset
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /fieldset:bulk-update:
    patch:
      description: Bulk update Fieldset.
      operationId: Fieldset.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Fieldset
      tags:
      - Fieldset
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /file:
    post:
      description: Create File.
      operationId: File.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFileInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
          description: Created
        '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: Create File
      tags:
      - File
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /file/items:
    get:
      description: List File items.
      operationId: File.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilePaginatedList'
          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 File items
      tags:
      - File
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /file/{file_id}:
    get:
      description: Get a single File by ID.
      operationId: File.Get
      parameters:
      - description: ID of the File.
        in: path
        name: file_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
          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 File by ID
      tags:
      - File
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update File.
      operationId: File.Update
      parameters:
      - description: ID of the File.
        in: path
        name: file_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFileInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/File'
          description: OK
        '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: Update File
      tags:
      - File
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /file:batch-create:
    post:
      description: Batch create File synchronously in one transaction. Maximum 25
        items per request.
      operationId: File.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateFileInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/File'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create File
      tags:
      - File
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /file:batch-update:
    patch:
      description: Batch update File synchronously in one transaction. Maximum 25
        items per request.
      operationId: File.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateFileInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/File'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update File
      tags:
      - File
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /file:bulk-create:
    post:
      description: Bulk create File.
      operationId: File.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create File
      tags:
      - File
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /file:bulk-update:
    patch:
      description: Bulk update File.
      operationId: File.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update File
      tags:
      - File
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /folder:
    post:
      description: Create Folder.
      operationId: Folder.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFolderInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
          description: Created
        '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: Create Folder
      tags:
      - Folder
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /folder/items:
    get:
      description: List Folder items.
      operationId: Folder.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/parent.eq'
      - $ref: '#/components/parameters/project.eq'
      - $ref: '#/components/parameters/returning'
      - description: 'Method by which to order results. Valid sorts are: 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:
          - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolderPaginatedList'
          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 Folder items
      tags:
      - Folder
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /folder/{folder_id}:
    delete:
      description: Delete Folder.
      operationId: Folder.Delete
      parameters:
      - description: ID of the Folder.
        in: path
        name: folder_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: *id001
      responses:
        '204':
          description: No Content
        '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: Delete Folder
      tags:
      - Folder
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
    get:
      description: Get a single Folder by ID.
      operationId: Folder.Get
      parameters:
      - description: ID of the Folder.
        in: path
        name: folder_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
          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 Folder by ID
      tags:
      - Folder
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update Folder.
      operationId: Folder.Update
      parameters:
      - description: ID of the Folder.
        in: path
        name: folder_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFolderInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
          description: OK
        '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: Update Folder
      tags:
      - Folder
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /folder/{folder_id}/children/items:
    get:
      description: List Folder items.
      operationId: Folder.children.List
      parameters:
      - description: ID of the Folder.
        in: path
        name: folder_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolderUnpaginatedList'
          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 Folder items
      tags:
      - Folder
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /folder/{folder_id}:move:
    post:
      description: Move a Folder into another Folder
      operationId: Folder.Move
      parameters:
      - description: ID of the Folder.
        in: path
        name: folder_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MoveFolderInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
          description: OK
        '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: Move a Folder into another Folder
      tags:
      - Folder
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /folder:batch-create:
    post:
      description: Batch create Folder synchronously in one transaction. Maximum 25
        items per request.
      operationId: Folder.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateFolderInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Folder'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create Folder
      tags:
      - Folder
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /folder:batch-delete:
    post:
      description: Batch delete Folder synchronously in one transaction. Maximum 25
        items per request.
      operationId: Folder.BatchDelete
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/DeleteFolderInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      additionalProperties: false
                      properties:
                        id:
                          type: string
                      required:
                      - id
                      type: object
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch delete Folder
      tags:
      - Folder
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /folder:batch-update:
    patch:
      description: Batch update Folder synchronously in one transaction. Maximum 25
        items per request.
      operationId: Folder.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateFolderInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Folder'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Folder
      tags:
      - Folder
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /folder:bulk-create:
    post:
      description: Bulk create Folder.
      operationId: Folder.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create Folder
      tags:
      - Folder
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /folder:bulk-update:
    patch:
      description: Bulk update Folder.
      operationId: Folder.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Folder
      tags:
      - Folder
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /germline/items:
    get:
      description: List Germline items.
      operationId: Germline.List
      parameters:
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/returning'
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GermlinePaginatedList'
          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 Germline items
      tags:
      - Germline
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /germline/{germline_id}:
    get:
      description: Get a single Germline by ID.
      operationId: Germline.Get
      parameters:
      - description: ID of the Germline.
        in: path
        name: germline_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Germline'
          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 Germline by ID
      tags:
      - Germline
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /group-membership/items:
    get:
      description: List GroupMembership items.
      operationId: GroupMembership.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/groupId.eq'
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/memberId.eq'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupMembershipPaginatedList'
          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 GroupMembership items
      tags:
      - GroupMembership
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /group-membership/{group_membership_id}:
    get:
      description: Get a single GroupMembership by ID.
      operationId: GroupMembership.Get
      parameters:
      - description: ID of the GroupMembership.
        in: path
        name: group_membership_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupMembership'
          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 GroupMembership by ID
      tags:
      - GroupMembership
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /label-template/items:
    get:
      description: List LabelTemplate items.
      operationId: LabelTemplate.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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelTemplatePaginatedList'
          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 LabelTemplate items
      tags:
      - LabelTemplate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /label-template/{label_template_id}:
    get:
      description: Get a single LabelTemplate by ID.
      operationId: LabelTemplate.Get
      parameters:
      - description: ID of the LabelTemplate.
        in: path
        name: label_template_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelTemplate'
          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 LabelTemplate by ID
      tags:
      - LabelTemplate
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /legacy-app-installation/items:
    get:
      description: List LegacyAppInstallation items.
      operationId: LegacyAppInstallation.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyAppInstallationPaginatedList'
          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 LegacyAppInstallation items
      tags:
      - LegacyAppInstallation
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /legacy-app-installation/{legacy_app_installation_id}:
    get:
      description: Get a single LegacyAppInstallation by ID.
      operationId: LegacyAppInstallation.Get
      parameters:
      - description: ID of the LegacyAppInstallation.
        in: path
        name: legacy_app_installation_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyAppInstallation'
          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 LegacyAppInstallation by ID
      tags:
      - LegacyAppInstallation
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /legacy-app-installation/{legacy_app_installation_id}/configuration-values/items:
    get:
      description: List AppConfigValue items.
      operationId: LegacyAppInstallation.configurationValues.List
      parameters:
      - description: ID of the LegacyAppInstallation.
        in: path
        name: legacy_app_installation_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppConfigValueUnpaginatedList'
          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 AppConfigValue items
      tags:
      - LegacyAppInstallation
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /library-parameter-definition:
    post:
      description: 'Create a new library parameter definition in the Parameter Library.

        ## Required fields

        | Field | Description |

        | --- | --- |

        | `name` | Display name (1-44 characters, must contain at least one alphanumeric
        character) |

        | `description` | What this parameter measures or represents (max 2048 characters)
        |

        | `dataType` | One of `FLOAT`, `DATETIME`, `TEXT`, or `DROPDOWN` |


        ## Conditionally required fields

        - **`unitTypeId`** — Required when `dataType` is `FLOAT`. Must be omitted
        or null otherwise. Obtain a valid ID from `GET /benchling/unit-type/items`.

        - **`schemaFieldSelectorId`** — Required when `dataType` is `DROPDOWN`. Must
        be omitted or null otherwise. Obtain a valid ID from `GET /benchling/dropdown/items`.


        ## Notes

        - The **creator** is automatically set to the authenticated user or app. The
        deprecated `creatorId` field is ignored.

        - `dataType` and `unitTypeId` are **immutable** after creation.

        - There is a per-tenant limit on the total number of library parameter definitions.'
      operationId: LibraryParameterDefinition.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLibraryParameterDefinitionInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LibraryParameterDefinition'
          description: Created
        '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: Create LibraryParameterDefinition
      tags:
      - LibraryParameterDefinition
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /library-parameter-definition/items:
    get:
      description: List LibraryParameterDefinition items.
      operationId: LibraryParameterDefinition.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LibraryParameterDefinitionPaginatedList'
          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 LibraryParameterDefinition items
      tags:
      - LibraryParameterDefinition
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /library-parameter-definition/{library_parameter_definition_id}:
    get:
      description: Get a single LibraryParameterDefinition by ID.
      operationId: LibraryParameterDefinition.Get
      parameters:
      - description: ID of the LibraryParameterDefinition.
        in: path
        name: library_parameter_definition_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LibraryParameterDefinition'
          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 LibraryParameterDefinition by ID
      tags:
      - LibraryParameterDefinition
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: 'Update a library parameter definition.

        ## Updatable fields

        | Field | Description |

        | --- | --- |

        | `name` | Display name (1-44 characters, at least one alphanumeric character)
        |

        | `description` | Parameter description (max 2048 characters) |


        ## Archiving

        To archive, set all three fields together:

        - `archived`: `true`

        - `archiveReason`: a non-empty string explaining why

        - `archiveUserId`: the ID of the user performing the archive (format: `ent_XXXXXXXX`)


        To unarchive, set `archived` to `false`.


        ## Immutable fields

        The following fields are set at creation and **cannot be changed** via update:

        - `dataType`

        - `unitTypeId`'
      operationId: LibraryParameterDefinition.Update
      parameters:
      - description: ID of the LibraryParameterDefinition.
        in: path
        name: library_parameter_definition_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLibraryParameterDefinitionInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LibraryParameterDefinition'
          description: OK
        '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: Update LibraryParameterDefinition
      tags:
      - LibraryParameterDefinition
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /library-parameter-definition:batch-create:
    post:
      description: Batch create LibraryParameterDefinition synchronously in one transaction.
        Maximum 25 items per request.
      operationId: LibraryParameterDefinition.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateLibraryParameterDefinitionInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/LibraryParameterDefinition'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create LibraryParameterDefinition
      tags:
      - LibraryParameterDefinition
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /library-parameter-definition:batch-update:
    patch:
      description: Batch update LibraryParameterDefinition synchronously in one transaction.
        Maximum 25 items per request.
      operationId: LibraryParameterDefinition.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateLibraryParameterDefinitionInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/LibraryParameterDefinition'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update LibraryParameterDefinition
      tags:
      - LibraryParameterDefinition
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /library-parameter-definition:bulk-create:
    post:
      description: 'Bulk create library parameter definitions asynchronously. Returns
        an async task link — poll the task to retrieve created object IDs.


        Each item in the request array follows the same field requirements as the
        single-create endpoint. Partial failures are reported per-item in the task
        result.


        See `POST /benchling/library-parameter-definition` for field details and constraints.'
      operationId: LibraryParameterDefinition.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create LibraryParameterDefinition
      tags:
      - LibraryParameterDefinition
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /library-parameter-definition:bulk-update:
    patch:
      description: 'Bulk update library parameter definitions asynchronously. Returns
        an async task link — poll the task to check status.


        Each item in the request array follows the same field requirements as the
        single-update endpoint. Partial failures are reported per-item in the task
        result.


        See `PATCH /benchling/library-parameter-definition/{library_parameter_definition_id}`
        for field details and constraints.'
      operationId: LibraryParameterDefinition.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update LibraryParameterDefinition
      tags:
      - LibraryParameterDefinition
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /limits:
    get:
      description: 'Retrieve the approximate request count limits for tiers 1 through
        5. These limits are subject to further throttling based on actual system load.

        Each tier limit is valid over a specific time frame, the information about
        the time frames can be found in the V3 API documentation.

        '
      operationId: Limits.Get
      parameters:
      - 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:
                properties:
                  tier1-limit:
                    example: 1000
                    type: integer
                  tier2-limit:
                    example: 5000
                    type: integer
                  tier3-limit:
                    example: 10000
                    type: integer
                  tier4-limit:
                    example: 20000
                    type: integer
                  tier5-limit:
                    example: 50000
                    type: integer
                type: object
          description: Request count limits for each tier.
      summary: Get the request count limits for each tier
      tags:
      - limits
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /location:
    post:
      description: Create Location.
      operationId: Location.Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLocationInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Location'
          description: Created
        '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: Create Location
      tags:
      - Location
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /location-schema:
    post:
      description: Create LocationSchema.
      operationId: LocationSchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLocationSchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationSchema'
          description: Created
        '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: Create LocationSchema
      tags:
      - LocationSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /location-schema/items:
    get:
      description: List LocationSchema items.
      operationId: LocationSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationSchemaPaginatedList'
          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 LocationSchema items
      tags:
      - LocationSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /location-schema/{location_schema_id}:
    get:
      description: Get a single LocationSchema by ID.
      operationId: LocationSchema.Get
      parameters:
      - description: ID of the LocationSchema.
        in: path
        name: location_schema_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationSchema'
          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 LocationSchema by ID
      tags:
      - LocationSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update LocationSchema.
      operationId: LocationSchema.Update
      parameters:
      - description: ID of the LocationSchema.
        in: path
        name: location_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLocationSchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationSchema'
          description: OK
        '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: Update LocationSchema
      tags:
      - LocationSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /location-schema/{location_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: LocationSchema.fieldDefinitions.List
      parameters:
      - description: ID of the LocationSchema.
        in: path
        name: location_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - LocationSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /location-schema:batch-create:
    post:
      description: Batch create LocationSchema synchronously in one transaction. Maximum
        25 items per request.
      operationId: LocationSchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateLocationSchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/LocationSchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create LocationSchema
      tags:
      - LocationSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /location-schema:batch-update:
    patch:
      description: Batch update LocationSchema synchronously in one transaction. Maximum
        25 items per request.
      operationId: LocationSchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateLocationSchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/LocationSchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update LocationSchema
      tags:
      - LocationSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /location-schema:bulk-create:
    post:
      description: Bulk create LocationSchema.
      operationId: LocationSchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create LocationSchema
      tags:
      - LocationSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /location-schema:bulk-update:
    patch:
      description: Bulk update LocationSchema.
      operationId: LocationSchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update LocationSchema
      tags:
      - LocationSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /location/items:
    get:
      description: List Location items.
      operationId: Location.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/barcode.anyOf'
      - $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/mentionedIn.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/parentStorage.eq'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/schema.anyOf'
      - $ref: '#/components/parameters/schema.eq'
      - 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationPaginatedList'
          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 Location items
      tags:
      - Location
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /location/{location_id}:
    get:
      description: Get a single Location by ID.
      operationId: Location.Get
      parameters:
      - description: ID of the Location.
        in: path
        name: location_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Location'
          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 Location by ID
      tags:
      - Location
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update Location.
      operationId: Location.Update
      parameters:
      - description: ID of the Location.
        in: path
        name: location_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLocationInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Location'
          description: OK
        '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: Update Location
      tags:
      - Location
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /location:batch-create:
    post:
      description: Batch create Location synchronously in one transaction. Maximum
        25 items per request.
      operationId: Location.BatchCreate
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateLocationInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Location'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create Location
      tags:
      - Location
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /location:batch-update:
    patch:
      description: Batch update Location synchronously in one transaction. Maximum
        25 items per request.
      operationId: Location.BatchUpdate
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateLocationInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Location'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Location
      tags:
      - Location
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /location:bulk-create:
    post:
      description: Bulk create Location.
      operationId: Location.BulkCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create Location
      tags:
      - Location
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /location:bulk-update:
    patch:
      description: Bulk update Location.
      operationId: Location.BulkUpdate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Location
      tags:
      - Location
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /matrix-plate:
    post:
      description: Create MatrixPlate.
      operationId: MatrixPlate.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMatrixPlateInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatrixPlate'
          description: Created
        '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: Create MatrixPlate
      tags:
      - MatrixPlate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /matrix-plate-schema:
    post:
      description: Create MatrixPlateSchema.
      operationId: MatrixPlateSchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMatrixPlateSchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatrixPlateSchema'
          description: Created
        '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: Create MatrixPlateSchema
      tags:
      - MatrixPlateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /matrix-plate-schema/items:
    get:
      description: List MatrixPlateSchema items.
      operationId: MatrixPlateSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatrixPlateSchemaPaginatedList'
          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 MatrixPlateSchema items
      tags:
      - MatrixPlateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /matrix-plate-schema/{matrix_plate_schema_id}:
    get:
      description: Get a single MatrixPlateSchema by ID.
      operationId: MatrixPlateSchema.Get
      parameters:
      - description: ID of the MatrixPlateSchema.
        in: path
        name: matrix_plate_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatrixPlateSchema'
          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 MatrixPlateSchema by ID
      tags:
      - MatrixPlateSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update MatrixPlateSchema.
      operationId: MatrixPlateSchema.Update
      parameters:
      - description: ID of the MatrixPlateSchema.
        in: path
        name: matrix_plate_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMatrixPlateSchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatrixPlateSchema'
          description: OK
        '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: Update MatrixPlateSchema
      tags:
      - MatrixPlateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /matrix-plate-schema/{matrix_plate_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: MatrixPlateSchema.fieldDefinitions.List
      parameters:
      - description: ID of the MatrixPlateSchema.
        in: path
        name: matrix_plate_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - MatrixPlateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /matrix-plate-schema:batch-create:
    post:
      description: Batch create MatrixPlateSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: MatrixPlateSchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateMatrixPlateSchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/MatrixPlateSchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create MatrixPlateSchema
      tags:
      - MatrixPlateSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /matrix-plate-schema:batch-update:
    patch:
      description: Batch update MatrixPlateSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: MatrixPlateSchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateMatrixPlateSchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/MatrixPlateSchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update MatrixPlateSchema
      tags:
      - MatrixPlateSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /matrix-plate-schema:bulk-create:
    post:
      description: Bulk create MatrixPlateSchema.
      operationId: MatrixPlateSchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create MatrixPlateSchema
      tags:
      - MatrixPlateSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /matrix-plate-schema:bulk-update:
    patch:
      description: Bulk update MatrixPlateSchema.
      operationId: MatrixPlateSchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update MatrixPlateSchema
      tags:
      - MatrixPlateSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /matrix-plate/items:
    get:
      description: List MatrixPlate items.
      operationId: MatrixPlate.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/barcode.anyOf'
      - $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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/parentStorage.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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatrixPlatePaginatedList'
          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 MatrixPlate items
      tags:
      - MatrixPlate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /matrix-plate/{matrix_plate_id}:
    get:
      description: Get a single MatrixPlate by ID.
      operationId: MatrixPlate.Get
      parameters:
      - description: ID of the MatrixPlate.
        in: path
        name: matrix_plate_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatrixPlate'
          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 MatrixPlate by ID
      tags:
      - MatrixPlate
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update MatrixPlate.
      operationId: MatrixPlate.Update
      parameters:
      - description: ID of the MatrixPlate.
        in: path
        name: matrix_plate_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMatrixPlateInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatrixPlate'
          description: OK
        '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: Update MatrixPlate
      tags:
      - MatrixPlate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /matrix-plate:batch-create:
    post:
      description: Batch create MatrixPlate synchronously in one transaction. Maximum
        10 items per request.
      operationId: MatrixPlate.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateMatrixPlateInput'
                  maxItems: 10
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/MatrixPlate'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create MatrixPlate
      tags:
      - MatrixPlate
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /matrix-plate:batch-update:
    patch:
      description: Batch update MatrixPlate synchronously in one transaction. Maximum
        10 items per request.
      operationId: MatrixPlate.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateMatrixPlateInputWithPathParams'
                  maxItems: 10
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/MatrixPlate'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update MatrixPlate
      tags:
      - MatrixPlate
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /matrix-plate:bulk-create:
    post:
      description: Bulk create MatrixPlate.
      operationId: MatrixPlate.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create MatrixPlate
      tags:
      - MatrixPlate
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /matrix-plate:bulk-update:
    patch:
      description: Bulk update MatrixPlate.
      operationId: MatrixPlate.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update MatrixPlate
      tags:
      - MatrixPlate
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /mixture-schema:
    post:
      description: Create MixtureSchema.
      operationId: MixtureSchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMixtureSchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MixtureSchema'
          description: Created
        '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: Create MixtureSchema
      tags:
      - MixtureSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /mixture-schema/items:
    get:
      description: List MixtureSchema items.
      operationId: MixtureSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MixtureSchemaPaginatedList'
          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 MixtureSchema items
      tags:
      - MixtureSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /mixture-schema/{mixture_schema_id}:
    get:
      description: Get a single MixtureSchema by ID.
      operationId: MixtureSchema.Get
      parameters:
      - description: ID of the MixtureSchema.
        in: path
        name: mixture_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MixtureSchema'
          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 MixtureSchema by ID
      tags:
      - MixtureSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update MixtureSchema.
      operationId: MixtureSchema.Update
      parameters:
      - description: ID of the MixtureSchema.
        in: path
        name: mixture_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMixtureSchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MixtureSchema'
          description: OK
        '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: Update MixtureSchema
      tags:
      - MixtureSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /mixture-schema/{mixture_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: MixtureSchema.fieldDefinitions.List
      parameters:
      - description: ID of the MixtureSchema.
        in: path
        name: mixture_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - MixtureSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /mixture-schema/{mixture_schema_id}/fieldsets/items:
    get:
      description: List Fieldset items.
      operationId: MixtureSchema.fieldsets.List
      parameters:
      - description: ID of the MixtureSchema.
        in: path
        name: mixture_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsetUnpaginatedList'
          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 Fieldset items
      tags:
      - MixtureSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /mixture-schema/{mixture_schema_id}:apply-fieldset:
    post:
      description: Apply a fieldset to the schema
      operationId: MixtureSchema.ApplyFieldset
      parameters:
      - description: ID of the MixtureSchema.
        in: path
        name: mixture_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitySchemaApplyFieldsetInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Apply a fieldset to the schema
      tags:
      - MixtureSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /mixture-schema/{mixture_schema_id}:set-field-definitions:
    post:
      description: Set field definitions on the schema
      operationId: MixtureSchema.SetFieldDefinitions
      parameters:
      - description: ID of the MixtureSchema.
        in: path
        name: mixture_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MixtureSchemaSetFieldDefinitionsInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Set field definitions on the schema
      tags:
      - MixtureSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /mixture-schema:batch-create:
    post:
      description: Batch create MixtureSchema synchronously in one transaction. Maximum
        25 items per request.
      operationId: MixtureSchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateMixtureSchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/MixtureSchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create MixtureSchema
      tags:
      - MixtureSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /mixture-schema:batch-update:
    patch:
      description: Batch update MixtureSchema synchronously in one transaction. Maximum
        25 items per request.
      operationId: MixtureSchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateMixtureSchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/MixtureSchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update MixtureSchema
      tags:
      - MixtureSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /mixture-schema:bulk-create:
    post:
      description: Bulk create MixtureSchema.
      operationId: MixtureSchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create MixtureSchema
      tags:
      - MixtureSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /mixture-schema:bulk-update:
    patch:
      description: Bulk update MixtureSchema.
      operationId: MixtureSchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update MixtureSchema
      tags:
      - MixtureSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /mixture/items:
    get:
      description: List Mixture items.
      operationId: Mixture.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/authors.anyOf'
      - $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/fieldset.anyOf'
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/mentionedIn.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/project.eq'
      - $ref: '#/components/parameters/registry.eq'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/schema.anyOf'
      - $ref: '#/components/parameters/schema.eq'
      - $ref: '#/components/parameters/systemCategory.anyOf'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MixturePaginatedList'
          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 Mixture items
      tags:
      - Mixture
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /mixture/{mixture_id}:
    get:
      description: Get a single Mixture by ID.
      operationId: Mixture.Get
      parameters:
      - description: ID of the Mixture.
        in: path
        name: mixture_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Mixture'
          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 Mixture by ID
      tags:
      - Mixture
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /mixture/{mixture_id}/authors/items:
    get:
      description: List Principal items.
      operationId: Mixture.authors.List
      parameters:
      - description: ID of the Mixture.
        in: path
        name: mixture_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - Mixture
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /molecule:
    post:
      description: Create Molecule.
      operationId: Molecule.Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMoleculeInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Molecule'
          description: Created
        '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: Create Molecule
      tags:
      - Molecule
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /molecule-schema:
    post:
      description: Create MoleculeSchema.
      operationId: MoleculeSchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMoleculeSchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoleculeSchema'
          description: Created
        '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: Create MoleculeSchema
      tags:
      - MoleculeSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /molecule-schema/items:
    get:
      description: List MoleculeSchema items.
      operationId: MoleculeSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoleculeSchemaPaginatedList'
          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 MoleculeSchema items
      tags:
      - MoleculeSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /molecule-schema/{molecule_schema_id}:
    get:
      description: Get a single MoleculeSchema by ID.
      operationId: MoleculeSchema.Get
      parameters:
      - description: ID of the MoleculeSchema.
        in: path
        name: molecule_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoleculeSchema'
          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 MoleculeSchema by ID
      tags:
      - MoleculeSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update MoleculeSchema.
      operationId: MoleculeSchema.Update
      parameters:
      - description: ID of the MoleculeSchema.
        in: path
        name: molecule_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMoleculeSchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoleculeSchema'
          description: OK
        '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: Update MoleculeSchema
      tags:
      - MoleculeSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /molecule-schema/{molecule_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: MoleculeSchema.fieldDefinitions.List
      parameters:
      - description: ID of the MoleculeSchema.
        in: path
        name: molecule_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - MoleculeSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /molecule-schema/{molecule_schema_id}/fieldsets/items:
    get:
      description: List Fieldset items.
      operationId: MoleculeSchema.fieldsets.List
      parameters:
      - description: ID of the MoleculeSchema.
        in: path
        name: molecule_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsetUnpaginatedList'
          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 Fieldset items
      tags:
      - MoleculeSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /molecule-schema/{molecule_schema_id}:apply-fieldset:
    post:
      description: Apply a fieldset to the schema
      operationId: MoleculeSchema.ApplyFieldset
      parameters:
      - description: ID of the MoleculeSchema.
        in: path
        name: molecule_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitySchemaApplyFieldsetInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Apply a fieldset to the schema
      tags:
      - MoleculeSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /molecule-schema/{molecule_schema_id}:set-field-definitions:
    post:
      description: Set field definitions on the schema
      operationId: MoleculeSchema.SetFieldDefinitions
      parameters:
      - description: ID of the MoleculeSchema.
        in: path
        name: molecule_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MoleculeSchemaSetFieldDefinitionsInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Set field definitions on the schema
      tags:
      - MoleculeSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /molecule-schema:batch-create:
    post:
      description: Batch create MoleculeSchema synchronously in one transaction. Maximum
        25 items per request.
      operationId: MoleculeSchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateMoleculeSchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/MoleculeSchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create MoleculeSchema
      tags:
      - MoleculeSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /molecule-schema:batch-update:
    patch:
      description: Batch update MoleculeSchema synchronously in one transaction. Maximum
        25 items per request.
      operationId: MoleculeSchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateMoleculeSchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/MoleculeSchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update MoleculeSchema
      tags:
      - MoleculeSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /molecule-schema:bulk-create:
    post:
      description: Bulk create MoleculeSchema.
      operationId: MoleculeSchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create MoleculeSchema
      tags:
      - MoleculeSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /molecule-schema:bulk-update:
    patch:
      description: Bulk update MoleculeSchema.
      operationId: MoleculeSchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update MoleculeSchema
      tags:
      - MoleculeSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /molecule/items:
    get:
      description: List Molecule items.
      operationId: Molecule.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/authors.anyOf'
      - $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/fieldset.anyOf'
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/mentionedIn.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/project.eq'
      - $ref: '#/components/parameters/registry.eq'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/schema.anyOf'
      - $ref: '#/components/parameters/schema.eq'
      - $ref: '#/components/parameters/systemCategory.anyOf'
      - 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MoleculePaginatedList'
          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 Molecule items
      tags:
      - Molecule
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /molecule/{molecule_id}:
    get:
      description: Get a single Molecule by ID.
      operationId: Molecule.Get
      parameters:
      - description: ID of the Molecule.
        in: path
        name: molecule_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Molecule'
          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 Molecule by ID
      tags:
      - Molecule
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update Molecule.
      operationId: Molecule.Update
      parameters:
      - description: ID of the Molecule.
        in: path
        name: molecule_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMoleculeInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Molecule'
          description: OK
        '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: Update Molecule
      tags:
      - Molecule
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /molecule/{molecule_id}/authors/items:
    get:
      description: List Principal items.
      operationId: Molecule.authors.List
      parameters:
      - description: ID of the Molecule.
        in: path
        name: molecule_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - Molecule
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /molecule:batch-create:
    post:
      description: Batch create Molecule synchronously in one transaction. Maximum
        25 items per request.
      operationId: Molecule.BatchCreate
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateMoleculeInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Molecule'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create Molecule
      tags:
      - Molecule
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /molecule:batch-update:
    patch:
      description: Batch update Molecule synchronously in one transaction. Maximum
        25 items per request.
      operationId: Molecule.BatchUpdate
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateMoleculeInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Molecule'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Molecule
      tags:
      - Molecule
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /molecule:bulk-create:
    post:
      description: Bulk create Molecule.
      operationId: Molecule.BulkCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create Molecule
      tags:
      - Molecule
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /molecule:bulk-update:
    patch:
      description: Bulk update Molecule.
      operationId: Molecule.BulkUpdate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Molecule
      tags:
      - Molecule
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /nucleotide-alignment/items:
    get:
      description: List NucleotideAlignment items.
      operationId: NucleotideAlignment.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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/sequenceIds.anyOf'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NucleotideAlignmentPaginatedList'
          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 NucleotideAlignment items
      tags:
      - NucleotideAlignment
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /nucleotide-alignment/{nucleotide_alignment_id}:
    delete:
      description: Delete NucleotideAlignment.
      operationId: NucleotideAlignment.Delete
      parameters:
      - description: ID of the NucleotideAlignment.
        in: path
        name: nucleotide_alignment_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: *id001
      responses:
        '204':
          description: No Content
        '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: Delete NucleotideAlignment
      tags:
      - NucleotideAlignment
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
    get:
      description: Get a single NucleotideAlignment by ID.
      operationId: NucleotideAlignment.Get
      parameters:
      - description: ID of the NucleotideAlignment.
        in: path
        name: nucleotide_alignment_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NucleotideAlignment'
          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 NucleotideAlignment by ID
      tags:
      - NucleotideAlignment
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /nucleotide-alignment/{nucleotide_alignment_id}/aligned-nucleotide-sequences/items:
    get:
      description: List AlignedNucleotideSequence items.
      operationId: NucleotideAlignment.alignedNucleotideSequences.List
      parameters:
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/pageSize'
      - description: ID of the NucleotideAlignment.
        in: path
        name: nucleotide_alignment_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlignedNucleotideSequencePaginatedList'
          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 AlignedNucleotideSequence items
      tags:
      - NucleotideAlignment
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /nucleotide-alignment:batch-delete:
    post:
      description: Batch delete NucleotideAlignment synchronously in one transaction.
        Maximum 25 items per request.
      operationId: NucleotideAlignment.BatchDelete
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/DeleteNucleotideAlignmentInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      additionalProperties: false
                      properties:
                        id:
                          type: string
                      required:
                      - id
                      type: object
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch delete NucleotideAlignment
      tags:
      - NucleotideAlignment
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /nucleotide-alignment:create-consensus-alignment:
    post:
      description: Create a consensus nucleotide alignment
      operationId: NucleotideAlignment.CreateConsensusAlignment
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConsensusAlignmentInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Create a consensus nucleotide alignment
      tags:
      - NucleotideAlignment
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /nucleotide-alignment:create-template-alignment:
    post:
      description: Create a template nucleotide alignment
      operationId: NucleotideAlignment.CreateTemplateAlignment
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTemplateAlignmentInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Create a template nucleotide alignment
      tags:
      - NucleotideAlignment
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /nucleotide-monomer/items:
    get:
      description: List NucleotideMonomer items.
      operationId: NucleotideMonomer.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NucleotideMonomerPaginatedList'
          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 NucleotideMonomer items
      tags:
      - NucleotideMonomer
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /nucleotide-monomer/{nucleotide_monomer_id}:
    get:
      description: Get a single NucleotideMonomer by ID.
      operationId: NucleotideMonomer.Get
      parameters:
      - description: ID of the NucleotideMonomer.
        in: path
        name: nucleotide_monomer_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NucleotideMonomer'
          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 NucleotideMonomer by ID
      tags:
      - NucleotideMonomer
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /oauth/token:
    post:
      description: 'Generate a token for usage with authenticating via OAuth2 in subsequent
        API calls.


        Supports the following grant types:

        - `client_credentials` — exchange client ID and secret for an access token.

        - `authorization_code` — exchange an authorization code (from the OAuth2 authorize
        flow) for an access token and refresh token. Requires `code`, `redirect_uri`,
        and optionally `code_verifier` (for PKCE) and `state`.

        - `refresh_token` — exchange a refresh token for a new access token and refresh
        token.


        **Note:** This endpoint is available at the absolute URL `/oauth/token` (not
        relative to the versioned API base path).'
      operationId: generateToken
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                client_id:
                  description: ID of client to request token for. Leave off if client
                    ID and secret are being supplied through Authorization header.
                  type: string
                client_secret:
                  description: Leave off if client ID and secret are being supplied
                    through Authorization header.
                  type: string
                code:
                  description: Authorization code received from the authorize endpoint.
                    Required when grant_type is authorization_code.
                  type: string
                code_verifier:
                  description: PKCE code verifier. Required when grant_type is authorization_code
                    and a code_challenge was sent in the authorization request.
                  type: string
                grant_type:
                  enum:
                  - client_credentials
                  - authorization_code
                  - refresh_token
                  example: client_credentials
                  type: string
                redirect_uri:
                  description: Redirect URI that was used in the authorization request.
                    Required when grant_type is authorization_code.
                  type: string
                refresh_token:
                  description: Refresh token to exchange for a new access token. Required
                    when grant_type is refresh_token.
                  type: string
                state:
                  description: Optional state parameter for the authorization_code
                    grant type.
                  type: string
              required:
              - grant_type
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  access_token:
                    example: eyJ...
                    type: string
                  expires_in:
                    description: Number of seconds that the access token is valid
                      for
                    example: 900
                    type: integer
                  refresh_token:
                    description: Refresh token. Returned when grant_type is authorization_code
                      or refresh_token.
                    example: eyJ...
                    type: string
                  refresh_token_expires_in:
                    description: Number of seconds that the refresh token is valid
                      for. Returned when a refresh_token is included in the response.
                    example: 2592000
                    type: integer
                  token_type:
                    enum:
                    - Bearer
                    example: Bearer
                    type: string
                required:
                - access_token
                - token_type
                - expires_in
                type: object
          description: Generated token
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      security:
      - basicClientIdSecretAuth: []
      summary: Generate a token
      tags:
      - Authentication
    servers:
    - url: ''
  /oligo-conjugate:
    post:
      description: Create OligoConjugate.
      operationId: OligoConjugate.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OligoConjugateCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OligoConjugate'
          description: Created
        '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: Create OligoConjugate
      tags:
      - OligoConjugate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-conjugate-schema:
    post:
      description: Create OligoConjugateSchema.
      operationId: OligoConjugateSchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOligoConjugateSchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OligoConjugateSchema'
          description: Created
        '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: Create OligoConjugateSchema
      tags:
      - OligoConjugateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-conjugate-schema/items:
    get:
      description: List OligoConjugateSchema items.
      operationId: OligoConjugateSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OligoConjugateSchemaPaginatedList'
          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 OligoConjugateSchema items
      tags:
      - OligoConjugateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-conjugate-schema/{oligo_conjugate_schema_id}:
    get:
      description: Get a single OligoConjugateSchema by ID.
      operationId: OligoConjugateSchema.Get
      parameters:
      - description: ID of the OligoConjugateSchema.
        in: path
        name: oligo_conjugate_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OligoConjugateSchema'
          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 OligoConjugateSchema by ID
      tags:
      - OligoConjugateSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update OligoConjugateSchema.
      operationId: OligoConjugateSchema.Update
      parameters:
      - description: ID of the OligoConjugateSchema.
        in: path
        name: oligo_conjugate_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOligoConjugateSchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OligoConjugateSchema'
          description: OK
        '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: Update OligoConjugateSchema
      tags:
      - OligoConjugateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-conjugate-schema/{oligo_conjugate_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: OligoConjugateSchema.fieldDefinitions.List
      parameters:
      - description: ID of the OligoConjugateSchema.
        in: path
        name: oligo_conjugate_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - OligoConjugateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-conjugate-schema/{oligo_conjugate_schema_id}/fieldsets/items:
    get:
      description: List Fieldset items.
      operationId: OligoConjugateSchema.fieldsets.List
      parameters:
      - description: ID of the OligoConjugateSchema.
        in: path
        name: oligo_conjugate_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsetUnpaginatedList'
          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 Fieldset items
      tags:
      - OligoConjugateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-conjugate-schema/{oligo_conjugate_schema_id}:apply-fieldset:
    post:
      description: Apply a fieldset to the schema
      operationId: OligoConjugateSchema.ApplyFieldset
      parameters:
      - description: ID of the OligoConjugateSchema.
        in: path
        name: oligo_conjugate_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitySchemaApplyFieldsetInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Apply a fieldset to the schema
      tags:
      - OligoConjugateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-conjugate-schema/{oligo_conjugate_schema_id}:set-field-definitions:
    post:
      description: Set field definitions on the schema
      operationId: OligoConjugateSchema.SetFieldDefinitions
      parameters:
      - description: ID of the OligoConjugateSchema.
        in: path
        name: oligo_conjugate_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OligoConjugateSchemaSetFieldDefinitionsInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Set field definitions on the schema
      tags:
      - OligoConjugateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-conjugate-schema:batch-create:
    post:
      description: Batch create OligoConjugateSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: OligoConjugateSchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateOligoConjugateSchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/OligoConjugateSchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create OligoConjugateSchema
      tags:
      - OligoConjugateSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /oligo-conjugate-schema:batch-update:
    patch:
      description: Batch update OligoConjugateSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: OligoConjugateSchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateOligoConjugateSchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/OligoConjugateSchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update OligoConjugateSchema
      tags:
      - OligoConjugateSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /oligo-conjugate-schema:bulk-create:
    post:
      description: Bulk create OligoConjugateSchema.
      operationId: OligoConjugateSchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create OligoConjugateSchema
      tags:
      - OligoConjugateSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /oligo-conjugate-schema:bulk-update:
    patch:
      description: Bulk update OligoConjugateSchema.
      operationId: OligoConjugateSchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update OligoConjugateSchema
      tags:
      - OligoConjugateSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /oligo-conjugate/items:
    get:
      description: List OligoConjugate items.
      operationId: OligoConjugate.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/project.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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OligoConjugatePaginatedList'
          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 OligoConjugate items
      tags:
      - OligoConjugate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-conjugate/{oligo_conjugate_id}:
    get:
      description: Get a single OligoConjugate by ID.
      operationId: OligoConjugate.Get
      parameters:
      - description: ID of the OligoConjugate.
        in: path
        name: oligo_conjugate_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OligoConjugate'
          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 OligoConjugate by ID
      tags:
      - OligoConjugate
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update OligoConjugate.
      operationId: OligoConjugate.Update
      parameters:
      - description: ID of the OligoConjugate.
        in: path
        name: oligo_conjugate_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OligoConjugateUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OligoConjugate'
          description: OK
        '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: Update OligoConjugate
      tags:
      - OligoConjugate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-conjugate/{oligo_conjugate_id}/authors/items:
    get:
      description: List Principal items.
      operationId: OligoConjugate.authors.List
      parameters:
      - description: ID of the OligoConjugate.
        in: path
        name: oligo_conjugate_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - OligoConjugate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-conjugate:batch-create:
    post:
      description: Batch create OligoConjugate synchronously in one transaction. Maximum
        25 items per request.
      operationId: OligoConjugate.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/OligoConjugateCreate'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/OligoConjugate'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create OligoConjugate
      tags:
      - OligoConjugate
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /oligo-conjugate:batch-update:
    patch:
      description: Batch update OligoConjugate synchronously in one transaction. Maximum
        25 items per request.
      operationId: OligoConjugate.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/OligoConjugateUpdateWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/OligoConjugate'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update OligoConjugate
      tags:
      - OligoConjugate
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /oligo-conjugate:bulk-create:
    post:
      description: Bulk create OligoConjugate.
      operationId: OligoConjugate.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create OligoConjugate
      tags:
      - OligoConjugate
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /oligo-conjugate:bulk-update:
    patch:
      description: Bulk update OligoConjugate.
      operationId: OligoConjugate.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update OligoConjugate
      tags:
      - OligoConjugate
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /oligo-duplex:
    post:
      description: Create OligoDuplex.
      operationId: OligoDuplex.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OligoDuplexCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OligoDuplex'
          description: Created
        '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: Create OligoDuplex
      tags:
      - OligoDuplex
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-duplex-schema:
    post:
      description: Create OligoDuplexSchema.
      operationId: OligoDuplexSchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOligoDuplexSchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OligoDuplexSchema'
          description: Created
        '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: Create OligoDuplexSchema
      tags:
      - OligoDuplexSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-duplex-schema/items:
    get:
      description: List OligoDuplexSchema items.
      operationId: OligoDuplexSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OligoDuplexSchemaPaginatedList'
          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 OligoDuplexSchema items
      tags:
      - OligoDuplexSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-duplex-schema/{oligo_duplex_schema_id}:
    get:
      description: Get a single OligoDuplexSchema by ID.
      operationId: OligoDuplexSchema.Get
      parameters:
      - description: ID of the OligoDuplexSchema.
        in: path
        name: oligo_duplex_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OligoDuplexSchema'
          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 OligoDuplexSchema by ID
      tags:
      - OligoDuplexSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update OligoDuplexSchema.
      operationId: OligoDuplexSchema.Update
      parameters:
      - description: ID of the OligoDuplexSchema.
        in: path
        name: oligo_duplex_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOligoDuplexSchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OligoDuplexSchema'
          description: OK
        '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: Update OligoDuplexSchema
      tags:
      - OligoDuplexSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-duplex-schema/{oligo_duplex_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: OligoDuplexSchema.fieldDefinitions.List
      parameters:
      - description: ID of the OligoDuplexSchema.
        in: path
        name: oligo_duplex_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - OligoDuplexSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-duplex-schema/{oligo_duplex_schema_id}/fieldsets/items:
    get:
      description: List Fieldset items.
      operationId: OligoDuplexSchema.fieldsets.List
      parameters:
      - description: ID of the OligoDuplexSchema.
        in: path
        name: oligo_duplex_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsetUnpaginatedList'
          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 Fieldset items
      tags:
      - OligoDuplexSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-duplex-schema/{oligo_duplex_schema_id}:apply-fieldset:
    post:
      description: Apply a fieldset to the schema
      operationId: OligoDuplexSchema.ApplyFieldset
      parameters:
      - description: ID of the OligoDuplexSchema.
        in: path
        name: oligo_duplex_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitySchemaApplyFieldsetInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Apply a fieldset to the schema
      tags:
      - OligoDuplexSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-duplex-schema/{oligo_duplex_schema_id}:set-field-definitions:
    post:
      description: Set field definitions on the schema
      operationId: OligoDuplexSchema.SetFieldDefinitions
      parameters:
      - description: ID of the OligoDuplexSchema.
        in: path
        name: oligo_duplex_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OligoDuplexSchemaSetFieldDefinitionsInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Set field definitions on the schema
      tags:
      - OligoDuplexSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-duplex-schema:batch-create:
    post:
      description: Batch create OligoDuplexSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: OligoDuplexSchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateOligoDuplexSchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/OligoDuplexSchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create OligoDuplexSchema
      tags:
      - OligoDuplexSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /oligo-duplex-schema:batch-update:
    patch:
      description: Batch update OligoDuplexSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: OligoDuplexSchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateOligoDuplexSchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/OligoDuplexSchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update OligoDuplexSchema
      tags:
      - OligoDuplexSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /oligo-duplex-schema:bulk-create:
    post:
      description: Bulk create OligoDuplexSchema.
      operationId: OligoDuplexSchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create OligoDuplexSchema
      tags:
      - OligoDuplexSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /oligo-duplex-schema:bulk-update:
    patch:
      description: Bulk update OligoDuplexSchema.
      operationId: OligoDuplexSchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update OligoDuplexSchema
      tags:
      - OligoDuplexSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /oligo-duplex/items:
    get:
      description: List OligoDuplex items.
      operationId: OligoDuplex.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/project.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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OligoDuplexPaginatedList'
          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 OligoDuplex items
      tags:
      - OligoDuplex
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-duplex/{oligo_duplex_id}:
    get:
      description: Get a single OligoDuplex by ID.
      operationId: OligoDuplex.Get
      parameters:
      - description: ID of the OligoDuplex.
        in: path
        name: oligo_duplex_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OligoDuplex'
          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 OligoDuplex by ID
      tags:
      - OligoDuplex
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: 'Update an oligo duplex.


        To update the duplex structure, provide `componentMapping`, `connections`,
        and `forwardOffset` together. To update only non-structural properties, omit
        all three fields.'
      operationId: OligoDuplex.Update
      parameters:
      - description: ID of the OligoDuplex.
        in: path
        name: oligo_duplex_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OligoDuplexUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OligoDuplex'
          description: OK
        '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: Update OligoDuplex
      tags:
      - OligoDuplex
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-duplex/{oligo_duplex_id}/authors/items:
    get:
      description: List Principal items.
      operationId: OligoDuplex.authors.List
      parameters:
      - description: ID of the OligoDuplex.
        in: path
        name: oligo_duplex_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - OligoDuplex
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /oligo-duplex:batch-create:
    post:
      description: Batch create OligoDuplex synchronously in one transaction. Maximum
        25 items per request.
      operationId: OligoDuplex.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/OligoDuplexCreate'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/OligoDuplex'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create OligoDuplex
      tags:
      - OligoDuplex
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /oligo-duplex:batch-update:
    patch:
      description: Batch update OligoDuplex synchronously in one transaction. Maximum
        25 items per request.
      operationId: OligoDuplex.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/OligoDuplexUpdateWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/OligoDuplex'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update OligoDuplex
      tags:
      - OligoDuplex
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /oligo-duplex:bulk-create:
    post:
      description: Bulk create OligoDuplex.
      operationId: OligoDuplex.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create OligoDuplex
      tags:
      - OligoDuplex
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /oligo-duplex:bulk-update:
    patch:
      description: 'Bulk update oligo duplexes asynchronously.


        For each input row, provide `componentMapping`, `connections`, and `forwardOffset`
        together to update the duplex structure. To update only non-structural properties,
        omit all three fields.'
      operationId: OligoDuplex.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update OligoDuplex
      tags:
      - OligoDuplex
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /organization/items:
    get:
      description: List Organization items.
      operationId: Organization.List
      parameters:
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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: 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:
          - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationPaginatedList'
          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 Organization items
      tags:
      - Organization
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /organization/{organization_id}:
    get:
      description: Get a single Organization by ID.
      operationId: Organization.Get
      parameters:
      - description: ID of the Organization.
        in: path
        name: organization_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
          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 Organization by ID
      tags:
      - Organization
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /organization/{organization_id}/memberships/items:
    get:
      description: List GroupMembership items.
      operationId: Organization.memberships.List
      parameters:
      - description: ID of the Organization.
        in: path
        name: organization_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupMembershipUnpaginatedList'
          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 GroupMembership items
      tags:
      - Organization
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /pipeline-step-data/items:
    get:
      description: List PipelineStepData items.
      operationId: PipelineStepData.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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineStepDataPaginatedList'
          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 PipelineStepData items
      tags:
      - PipelineStepData
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /pipeline-step-data/{pipeline_step_data_id}:
    get:
      description: Get a single PipelineStepData by ID.
      operationId: PipelineStepData.Get
      parameters:
      - description: ID of the PipelineStepData.
        in: path
        name: pipeline_step_data_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineStepData'
          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 PipelineStepData by ID
      tags:
      - PipelineStepData
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /pipeline-step/items:
    get:
      description: List PipelineStep items.
      operationId: PipelineStep.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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineStepPaginatedList'
          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 PipelineStep items
      tags:
      - PipelineStep
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /pipeline-step/{pipeline_step_id}:
    get:
      description: Get a single PipelineStep by ID.
      operationId: PipelineStep.Get
      parameters:
      - description: ID of the PipelineStep.
        in: path
        name: pipeline_step_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineStep'
          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 PipelineStep by ID
      tags:
      - PipelineStep
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /pipeline-step/{pipeline_step_id}/input-step-datas/items:
    get:
      description: List PipelineStepData items.
      operationId: PipelineStep.inputStepDatas.List
      parameters:
      - description: ID of the PipelineStep.
        in: path
        name: pipeline_step_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineStepDataUnpaginatedList'
          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 PipelineStepData items
      tags:
      - PipelineStep
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /pipeline-step/{pipeline_step_id}/output-step-datas/items:
    get:
      description: List PipelineStepData items.
      operationId: PipelineStep.outputStepDatas.List
      parameters:
      - description: ID of the PipelineStep.
        in: path
        name: pipeline_step_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineStepDataUnpaginatedList'
          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 PipelineStepData items
      tags:
      - PipelineStep
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /plate-design-template:
    post:
      description: Create PlateDesignTemplate.
      operationId: PlateDesignTemplate.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePlateDesignTemplateInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlateDesignTemplate'
          description: Created
        '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: Create PlateDesignTemplate
      tags:
      - PlateDesignTemplate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /plate-design-template/items:
    get:
      description: List PlateDesignTemplate items.
      operationId: PlateDesignTemplate.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlateDesignTemplatePaginatedList'
          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 PlateDesignTemplate items
      tags:
      - PlateDesignTemplate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /plate-design-template/{plate_design_template_id}:
    get:
      description: Get a single PlateDesignTemplate by ID.
      operationId: PlateDesignTemplate.Get
      parameters:
      - description: ID of the PlateDesignTemplate.
        in: path
        name: plate_design_template_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlateDesignTemplate'
          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 PlateDesignTemplate by ID
      tags:
      - PlateDesignTemplate
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update PlateDesignTemplate.
      operationId: PlateDesignTemplate.Update
      parameters:
      - description: ID of the PlateDesignTemplate.
        in: path
        name: plate_design_template_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePlateDesignTemplateInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlateDesignTemplate'
          description: OK
        '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: Update PlateDesignTemplate
      tags:
      - PlateDesignTemplate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /plate-design-template:batch-create:
    post:
      description: Batch create PlateDesignTemplate synchronously in one transaction.
        Maximum 25 items per request.
      operationId: PlateDesignTemplate.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreatePlateDesignTemplateInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/PlateDesignTemplate'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create PlateDesignTemplate
      tags:
      - PlateDesignTemplate
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /plate-design-template:batch-update:
    patch:
      description: Batch update PlateDesignTemplate synchronously in one transaction.
        Maximum 25 items per request.
      operationId: PlateDesignTemplate.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdatePlateDesignTemplateInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/PlateDesignTemplate'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update PlateDesignTemplate
      tags:
      - PlateDesignTemplate
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /plate-design-template:bulk-create:
    post:
      description: Bulk create PlateDesignTemplate.
      operationId: PlateDesignTemplate.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create PlateDesignTemplate
      tags:
      - PlateDesignTemplate
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /plate-design-template:bulk-update:
    patch:
      description: Bulk update PlateDesignTemplate.
      operationId: PlateDesignTemplate.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update PlateDesignTemplate
      tags:
      - PlateDesignTemplate
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /plate-schema/items:
    get:
      description: List PlateSchema items.
      operationId: PlateSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlateSchemaPaginatedList'
          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 PlateSchema items
      tags:
      - PlateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /plate-schema/{plate_schema_id}:
    get:
      description: Get a single PlateSchema by ID.
      operationId: PlateSchema.Get
      parameters:
      - description: ID of the PlateSchema.
        in: path
        name: plate_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlateSchema'
          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 PlateSchema by ID
      tags:
      - PlateSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /plate-schema/{plate_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: PlateSchema.fieldDefinitions.List
      parameters:
      - description: ID of the PlateSchema.
        in: path
        name: plate_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - PlateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /plate/items:
    get:
      description: List Plate items.
      operationId: Plate.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/barcode.anyOf'
      - $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/mentionedIn.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/parentStorage.eq'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/schema.anyOf'
      - $ref: '#/components/parameters/schema.eq'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatePaginatedList'
          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 Plate items
      tags:
      - Plate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /plate/{plate_id}:
    get:
      description: Get a single Plate by ID.
      operationId: Plate.Get
      parameters:
      - description: ID of the Plate.
        in: path
        name: plate_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Plate'
          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 Plate by ID
      tags:
      - Plate
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /plate/{plate_id}/wells/items:
    get:
      description: List Container items.
      operationId: Plate.wells.List
      parameters:
      - description: ID of the Plate.
        in: path
        name: plate_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerUnpaginatedList'
          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 Container items
      tags:
      - Plate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /policy/items:
    get:
      description: List Policy items.
      operationId: Policy.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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyPaginatedList'
          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 Policy items
      tags:
      - Policy
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /policy/{policy_id}:
    get:
      description: Get a single Policy by ID.
      operationId: Policy.Get
      parameters:
      - description: ID of the Policy.
        in: path
        name: policy_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Policy'
          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 Policy by ID
      tags:
      - Policy
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /prediction-batch:
    post:
      description: Create PredictionBatch.
      operationId: PredictionBatch.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PredictionBatchInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionBatch'
          description: Created
        '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: Create PredictionBatch
      tags:
      - PredictionBatch
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /prediction-batch/items:
    get:
      description: List PredictionBatch items.
      operationId: PredictionBatch.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/model.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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionBatchPaginatedList'
          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 PredictionBatch items
      tags:
      - PredictionBatch
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /prediction-batch/{prediction_batch_id}:
    get:
      description: Get a single PredictionBatch by ID.
      operationId: PredictionBatch.Get
      parameters:
      - description: ID of the PredictionBatch.
        in: path
        name: prediction_batch_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionBatch'
          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 PredictionBatch by ID
      tags:
      - PredictionBatch
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /prediction-batch/{prediction_batch_id}/prediction-jobs/items:
    get:
      description: List PredictionJob items.
      operationId: PredictionBatch.predictionJobs.List
      parameters:
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/pageSize'
      - description: ID of the PredictionBatch.
        in: path
        name: prediction_batch_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionJobPaginatedList'
          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 PredictionJob items
      tags:
      - PredictionBatch
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /prediction-batch:batch-create:
    post:
      description: Batch create PredictionBatch synchronously in one transaction.
        Maximum 25 items per request.
      operationId: PredictionBatch.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/PredictionBatchInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/PredictionBatch'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create PredictionBatch
      tags:
      - PredictionBatch
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /prediction-batch:bulk-create:
    post:
      description: Bulk create PredictionBatch.
      operationId: PredictionBatch.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create PredictionBatch
      tags:
      - PredictionBatch
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /prediction-job/items:
    get:
      description: List PredictionJob items.
      operationId: PredictionJob.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/predictionBatch.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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionJobPaginatedList'
          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 PredictionJob items
      tags:
      - PredictionJob
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /prediction-job/{prediction_job_id}:
    get:
      description: Get a single PredictionJob by ID.
      operationId: PredictionJob.Get
      parameters:
      - description: ID of the PredictionJob.
        in: path
        name: prediction_job_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionJob'
          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 PredictionJob by ID
      tags:
      - PredictionJob
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /printer/items:
    get:
      description: List Printer items.
      operationId: Printer.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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrinterPaginatedList'
          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 Printer items
      tags:
      - Printer
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /printer/{printer_id}:
    get:
      description: Get a single Printer by ID.
      operationId: Printer.Get
      parameters:
      - description: ID of the Printer.
        in: path
        name: printer_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Printer'
          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 Printer by ID
      tags:
      - Printer
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /procedure-flowchart-config-version-proxy/items:
    get:
      description: List ProcedureFlowchartConfigVersionProxy items.
      operationId: ProcedureFlowchartConfigVersionProxy.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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureFlowchartConfigVersionProxyPaginatedList'
          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 ProcedureFlowchartConfigVersionProxy items
      tags:
      - ProcedureFlowchartConfigVersionProxy
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-flowchart-config-version-proxy/{procedure_flowchart_config_version_proxy_id}:
    get:
      description: Get a single ProcedureFlowchartConfigVersionProxy by ID.
      operationId: ProcedureFlowchartConfigVersionProxy.Get
      parameters:
      - description: ID of the ProcedureFlowchartConfigVersionProxy.
        in: path
        name: procedure_flowchart_config_version_proxy_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureFlowchartConfigVersionProxy'
          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 ProcedureFlowchartConfigVersionProxy by ID
      tags:
      - ProcedureFlowchartConfigVersionProxy
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /procedure-flowchart-config-version-proxy/{procedure_flowchart_config_version_proxy_id}/nodes/items:
    get:
      description: List ProcedureMethodDefinitionVersion items.
      operationId: ProcedureFlowchartConfigVersionProxy.nodes.List
      parameters:
      - description: ID of the ProcedureFlowchartConfigVersionProxy.
        in: path
        name: procedure_flowchart_config_version_proxy_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: *id001
      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:
      - ProcedureFlowchartConfigVersionProxy
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-flowchart-version/items:
    get:
      description: List ProcedureFlowchartVersion items.
      operationId: ProcedureFlowchartVersion.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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureFlowchartVersionPaginatedList'
          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 ProcedureFlowchartVersion items
      tags:
      - ProcedureFlowchartVersion
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-flowchart-version/{procedure_flowchart_version_id}:
    get:
      description: Get a single ProcedureFlowchartVersion by ID.
      operationId: ProcedureFlowchartVersion.Get
      parameters:
      - description: ID of the ProcedureFlowchartVersion.
        in: path
        name: procedure_flowchart_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureFlowchartVersion'
          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 ProcedureFlowchartVersion by ID
      tags:
      - ProcedureFlowchartVersion
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /procedure-flowchart-version/{procedure_flowchart_version_id}/nodes/items:
    get:
      description: List ProcedureMethodDefinitionVersion items.
      operationId: ProcedureFlowchartVersion.nodes.List
      parameters:
      - description: ID of the ProcedureFlowchartVersion.
        in: path
        name: procedure_flowchart_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: *id001
      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:
      - ProcedureFlowchartVersion
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-flowchart/items:
    get:
      description: List ProcedureFlowchart items.
      operationId: ProcedureFlowchart.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureFlowchartPaginatedList'
          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 ProcedureFlowchart items
      tags:
      - ProcedureFlowchart
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-flowchart/{procedure_flowchart_id}:
    get:
      description: Get a single ProcedureFlowchart by ID.
      operationId: ProcedureFlowchart.Get
      parameters:
      - description: ID of the ProcedureFlowchart.
        in: path
        name: procedure_flowchart_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureFlowchart'
          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 ProcedureFlowchart by ID
      tags:
      - ProcedureFlowchart
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /procedure-method-definition-version/items:
    get:
      description: List ProcedureMethodDefinitionVersion items.
      operationId: ProcedureMethodDefinitionVersion.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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureMethodDefinitionVersionPaginatedList'
          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:
      - ProcedureMethodDefinitionVersion
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-method-definition-version/{procedure_method_definition_version_id}:
    get:
      description: Get a single ProcedureMethodDefinitionVersion by ID.
      operationId: ProcedureMethodDefinitionVersion.Get
      parameters:
      - description: ID of the ProcedureMethodDefinitionVersion.
        in: path
        name: procedure_method_definition_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureMethodDefinitionVersion'
          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 ProcedureMethodDefinitionVersion by ID
      tags:
      - ProcedureMethodDefinitionVersion
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /procedure-method-execution-instance-association:
    post:
      description: Create ProcedureMethodExecutionInstanceAssociation.
      operationId: ProcedureMethodExecutionInstanceAssociation.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcedureMethodExecutionInstanceAssociationUpsert'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureMethodExecutionInstanceAssociation'
          description: Created
        '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: Create ProcedureMethodExecutionInstanceAssociation
      tags:
      - ProcedureMethodExecutionInstanceAssociation
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-method-execution-instance-association/items:
    get:
      description: List ProcedureMethodExecutionInstanceAssociation items.
      operationId: ProcedureMethodExecutionInstanceAssociation.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureMethodExecutionInstanceAssociationPaginatedList'
          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 ProcedureMethodExecutionInstanceAssociation items
      tags:
      - ProcedureMethodExecutionInstanceAssociation
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-method-execution-instance-association/{procedure_method_execution_instance_association_id}:
    delete:
      description: Delete ProcedureMethodExecutionInstanceAssociation.
      operationId: ProcedureMethodExecutionInstanceAssociation.Delete
      parameters:
      - description: ID of the ProcedureMethodExecutionInstanceAssociation.
        in: path
        name: procedure_method_execution_instance_association_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: *id001
      responses:
        '204':
          description: No Content
        '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: Delete ProcedureMethodExecutionInstanceAssociation
      tags:
      - ProcedureMethodExecutionInstanceAssociation
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
    get:
      description: Get a single ProcedureMethodExecutionInstanceAssociation by ID.
      operationId: ProcedureMethodExecutionInstanceAssociation.Get
      parameters:
      - description: ID of the ProcedureMethodExecutionInstanceAssociation.
        in: path
        name: procedure_method_execution_instance_association_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureMethodExecutionInstanceAssociation'
          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 ProcedureMethodExecutionInstanceAssociation by ID
      tags:
      - ProcedureMethodExecutionInstanceAssociation
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /procedure-method-execution-instance-association:batch-create:
    post:
      description: Batch create ProcedureMethodExecutionInstanceAssociation synchronously
        in one transaction. Maximum 25 items per request.
      operationId: ProcedureMethodExecutionInstanceAssociation.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/ProcedureMethodExecutionInstanceAssociationUpsert'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/ProcedureMethodExecutionInstanceAssociation'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create ProcedureMethodExecutionInstanceAssociation
      tags:
      - ProcedureMethodExecutionInstanceAssociation
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /procedure-method-execution-instance-association:batch-delete:
    post:
      description: Batch delete ProcedureMethodExecutionInstanceAssociation synchronously
        in one transaction. Maximum 25 items per request.
      operationId: ProcedureMethodExecutionInstanceAssociation.BatchDelete
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/DeleteProcedureMethodExecutionInstanceAssociationInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      additionalProperties: false
                      properties:
                        id:
                          type: string
                      required:
                      - id
                      type: object
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch delete ProcedureMethodExecutionInstanceAssociation
      tags:
      - ProcedureMethodExecutionInstanceAssociation
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /procedure-method-execution-instance-association:bulk-create:
    post:
      description: Bulk create ProcedureMethodExecutionInstanceAssociation.
      operationId: ProcedureMethodExecutionInstanceAssociation.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create ProcedureMethodExecutionInstanceAssociation
      tags:
      - ProcedureMethodExecutionInstanceAssociation
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /procedure-method-execution-instance/items:
    get:
      description: List ProcedureMethodExecutionInstance items.
      operationId: ProcedureMethodExecutionInstance.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/procedureRunConditionReplicate.anyOf'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/templateProcedureMethodVersion.eq'
      - $ref: '#/components/parameters/worksheet.anyOf'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureMethodExecutionInstancePaginatedList'
          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 ProcedureMethodExecutionInstance items
      tags:
      - ProcedureMethodExecutionInstance
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-method-execution-instance/{procedure_method_execution_instance_id}:
    get:
      description: Get a single ProcedureMethodExecutionInstance by ID.
      operationId: ProcedureMethodExecutionInstance.Get
      parameters:
      - description: ID of the ProcedureMethodExecutionInstance.
        in: path
        name: procedure_method_execution_instance_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureMethodExecutionInstance'
          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 ProcedureMethodExecutionInstance by ID
      tags:
      - ProcedureMethodExecutionInstance
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /procedure-method-execution-instance/{procedure_method_execution_instance_id}/data-parameter-actual-values/items:
    get:
      description: List ProcedureParameterMeasuredValue items.
      operationId: ProcedureMethodExecutionInstance.dataParameterActualValues.List
      parameters:
      - description: ID of the ProcedureMethodExecutionInstance.
        in: path
        name: procedure_method_execution_instance_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureParameterMeasuredValueUnpaginatedList'
          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 ProcedureParameterMeasuredValue items
      tags:
      - ProcedureMethodExecutionInstance
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-method-execution-instance/{procedure_method_execution_instance_id}/data-parameter-confirmation-values/items:
    get:
      description: List ProcedureParameterConfirmationValue items.
      operationId: ProcedureMethodExecutionInstance.dataParameterConfirmationValues.List
      parameters:
      - description: ID of the ProcedureMethodExecutionInstance.
        in: path
        name: procedure_method_execution_instance_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureParameterConfirmationValueUnpaginatedList'
          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 ProcedureParameterConfirmationValue items
      tags:
      - ProcedureMethodExecutionInstance
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-method-execution-instance/{procedure_method_execution_instance_id}/data-parameter-planned-values/items:
    get:
      description: List ProcedureParameterPlannedValue items.
      operationId: ProcedureMethodExecutionInstance.dataParameterPlannedValues.List
      parameters:
      - description: ID of the ProcedureMethodExecutionInstance.
        in: path
        name: procedure_method_execution_instance_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureParameterPlannedValueUnpaginatedList'
          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:
      - ProcedureMethodExecutionInstance
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-method-execution-instance/{procedure_method_execution_instance_id}/equipment-confirmation-values/items:
    get:
      description: List ProcedureParameterConfirmationValue items.
      operationId: ProcedureMethodExecutionInstance.equipmentConfirmationValues.List
      parameters:
      - description: ID of the ProcedureMethodExecutionInstance.
        in: path
        name: procedure_method_execution_instance_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureParameterConfirmationValueUnpaginatedList'
          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 ProcedureParameterConfirmationValue items
      tags:
      - ProcedureMethodExecutionInstance
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-method-execution-instance/{procedure_method_execution_instance_id}/equipment-planned-values/items:
    get:
      description: List ProcedureParameterPlannedValue items.
      operationId: ProcedureMethodExecutionInstance.equipmentPlannedValues.List
      parameters:
      - description: ID of the ProcedureMethodExecutionInstance.
        in: path
        name: procedure_method_execution_instance_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureParameterPlannedValueUnpaginatedList'
          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:
      - ProcedureMethodExecutionInstance
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-method-execution-instance/{procedure_method_execution_instance_id}/material-input-confirmation-values/items:
    get:
      description: List ProcedureParameterConfirmationValue items.
      operationId: ProcedureMethodExecutionInstance.materialInputConfirmationValues.List
      parameters:
      - description: ID of the ProcedureMethodExecutionInstance.
        in: path
        name: procedure_method_execution_instance_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureParameterConfirmationValueUnpaginatedList'
          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 ProcedureParameterConfirmationValue items
      tags:
      - ProcedureMethodExecutionInstance
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-method-execution-instance/{procedure_method_execution_instance_id}/material-input-planned-values/items:
    get:
      description: List ProcedureParameterPlannedValue items.
      operationId: ProcedureMethodExecutionInstance.materialInputPlannedValues.List
      parameters:
      - description: ID of the ProcedureMethodExecutionInstance.
        in: path
        name: procedure_method_execution_instance_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureParameterPlannedValueUnpaginatedList'
          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:
      - ProcedureMethodExecutionInstance
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-method-execution-instance/{procedure_method_execution_instance_id}/material-output-confirmation-values/items:
    get:
      description: List ProcedureParameterConfirmationValue items.
      operationId: ProcedureMethodExecutionInstance.materialOutputConfirmationValues.List
      parameters:
      - description: ID of the ProcedureMethodExecutionInstance.
        in: path
        name: procedure_method_execution_instance_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureParameterConfirmationValueUnpaginatedList'
          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 ProcedureParameterConfirmationValue items
      tags:
      - ProcedureMethodExecutionInstance
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-parameter-confirmation-value/items:
    get:
      description: List ProcedureParameterConfirmationValue items.
      operationId: ProcedureParameterConfirmationValue.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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureParameterConfirmationValuePaginatedList'
          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 ProcedureParameterConfirmationValue items
      tags:
      - ProcedureParameterConfirmationValue
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-parameter-confirmation-value/{procedure_parameter_confirmation_value_id}:
    get:
      description: Get a single ProcedureParameterConfirmationValue by ID.
      operationId: ProcedureParameterConfirmationValue.Get
      parameters:
      - description: ID of the ProcedureParameterConfirmationValue.
        in: path
        name: procedure_parameter_confirmation_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureParameterConfirmationValue'
          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 ProcedureParameterConfirmationValue by ID
      tags:
      - ProcedureParameterConfirmationValue
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /procedure-parameter-measured-value/items:
    get:
      description: List ProcedureParameterMeasuredValue items.
      operationId: ProcedureParameterMeasuredValue.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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureParameterMeasuredValuePaginatedList'
          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 ProcedureParameterMeasuredValue items
      tags:
      - ProcedureParameterMeasuredValue
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-parameter-measured-value/{procedure_parameter_measured_value_id}:
    get:
      description: Get a single ProcedureParameterMeasuredValue by ID.
      operationId: ProcedureParameterMeasuredValue.Get
      parameters:
      - description: ID of the ProcedureParameterMeasuredValue.
        in: path
        name: procedure_parameter_measured_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureParameterMeasuredValue'
          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 ProcedureParameterMeasuredValue by ID
      tags:
      - ProcedureParameterMeasuredValue
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /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: *id001
      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
      - Tier 4 Rate Limit
      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: *id001
      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
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /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: *id001
      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
      - Tier 4 Rate Limit
      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: *id001
      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
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /procedure-parameter/items:
    get:
      description: List ProcedureParameter items.
      operationId: ProcedureParameter.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/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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureParameterPaginatedList'
          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 ProcedureParameter items
      tags:
      - ProcedureParameter
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-parameter/{procedure_parameter_id}:
    get:
      description: Get a single ProcedureParameter by ID.
      operationId: ProcedureParameter.Get
      parameters:
      - description: ID of the ProcedureParameter.
        in: path
        name: procedure_parameter_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureParameter'
          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 ProcedureParameter by ID
      tags:
      - ProcedureParameter
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /procedure-run-condition-replicate/items:
    get:
      description: List ProcedureRunConditionReplicate items.
      operationId: ProcedureRunConditionReplicate.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/procedureRunCondition.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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureRunConditionReplicatePaginatedList'
          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:
      - ProcedureRunConditionReplicate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-run-condition-replicate/{procedure_run_condition_replicate_id}:
    get:
      description: Get a single ProcedureRunConditionReplicate by ID.
      operationId: ProcedureRunConditionReplicate.Get
      parameters:
      - description: ID of the ProcedureRunConditionReplicate.
        in: path
        name: procedure_run_condition_replicate_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureRunConditionReplicate'
          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 ProcedureRunConditionReplicate by ID
      tags:
      - ProcedureRunConditionReplicate
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /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: *id001
      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
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /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: *id001
      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
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /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
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      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
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-run-plan:
    post:
      description: 'Create a draft recipe or assay run plan (procedure run plan) within
        a study.

        ## Required fields

        | Field | Description |

        | --- | --- |

        | `description` | Human-readable description of the plan |

        | `studyId` | ID of the parent study (`stdy_XXXXXXXX`). Use `GET /benchling/study/items`
        to list studies. |

        | `confirmationMethodByParamVersionId` | Confirmation method overrides per
        parameter (pass `[]` for no overrides) |

        ## Optional fields

        | Field | Default | Description |

        | --- | --- | --- |

        | `dataEntryMode` | `INDIVIDUAL_CONDITION_REPLICATES` | Controls worksheet
        creation upon promotion |

        | `workflowFlowchartConfigVersionId` | `null` | Optional ID of the workflow
        flowchart config version (`wffccv_XXXXXXXX`) defining the procedure structure
        |

        ## Notes

        - The **creator** is automatically set to the authenticated user.

        - `description` must not exceed 255 characters.

        - The study must be of a type that supports run plans (e.g., recipe or assay
        run studies). Assay development studies reject `ALL_CONDITION_REPLICATES_TOGETHER`
        mode.

        - After creating the plan, add conditions using the Create ProcedureRunPlanCondition
        endpoint.

        - When the plan is ready, promote it to an active run using the Promote endpoint.'
      operationId: ProcedureRunPlan.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProcedureRunPlanInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureRunPlan'
          description: Created
        '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: Create ProcedureRunPlan
      tags:
      - ProcedureRunPlan
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-run-plan-condition:
    post:
      description: 'Create a condition within a run plan.


        ## Required fields


        | Field | Description |

        | --- | --- |

        | `name` | Display name (must not be empty) |

        | `description` | Condition description |

        | `procedureRunPlanId` | Parent run plan ID (`prp_XXXXXXXX`) |

        | `templateMethodVersionId` | Method definition version ID (`pcmdv_XXXXXXXX`)
        — must be a method in the run plan''s flowchart |

        | `replicates` | Array of replicates with consecutive `replicateNumber` values
        starting from 1 |

        | `methodParametersPlan` | Pre-filled parameter values, or null for defaults
        |


        ## Constraints


        - `templateMethodVersionId` must reference a method present in the parent
        run plan''s flowchart version.

        - `name` must not be empty, and both `name` and `description` must not exceed
        255 characters.

        - Each condition must have between 1 and 999 replicates with consecutive `replicateNumber`
        values starting from 1.

        - A run plan can contain at most 100 conditions.

        - **Per-PMDV uniformity**: All conditions for the same procedure method definition
        version (PMDV) within a plan must have the same count, names, descriptions,
        and replicate counts across all unit operations.

        - The condition''s `position` (display order) is automatically assigned.'
      operationId: ProcedureRunPlanCondition.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProcedureRunPlanConditionInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureRunPlanCondition'
          description: Created
        '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: Create ProcedureRunPlanCondition
      tags:
      - ProcedureRunPlanCondition
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-run-plan-condition/items:
    get:
      description: List ProcedureRunPlanCondition items.
      operationId: ProcedureRunPlanCondition.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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureRunPlanConditionPaginatedList'
          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 ProcedureRunPlanCondition items
      tags:
      - ProcedureRunPlanCondition
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-run-plan-condition/{procedure_run_plan_condition_id}:
    get:
      description: Get a single ProcedureRunPlanCondition by ID.
      operationId: ProcedureRunPlanCondition.Get
      parameters:
      - description: ID of the ProcedureRunPlanCondition.
        in: path
        name: procedure_run_plan_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureRunPlanCondition'
          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 ProcedureRunPlanCondition by ID
      tags:
      - ProcedureRunPlanCondition
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: 'Update an existing condition within a draft procedure run plan.


        ## Constraints


        - If `templateMethodVersionId` is changed, the new value must reference a
        method present in the parent run plan''s flowchart version.

        - **Per-PMDV uniformity**: After the update, all conditions for each procedure
        method definition version (PMDV) within the plan must still have the same
        count, names, descriptions, and replicate counts across all unit operations.

        - If `name` is provided, it must not be empty. `name` and `description` must
        not exceed 255 characters.

        - If `replicates` is provided, it must contain between 1 and 999 replicates
        with consecutive `replicateNumber` values starting from 1.'
      operationId: ProcedureRunPlanCondition.Update
      parameters:
      - description: ID of the ProcedureRunPlanCondition.
        in: path
        name: procedure_run_plan_condition_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProcedureRunPlanConditionInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureRunPlanCondition'
          description: OK
        '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: Update ProcedureRunPlanCondition
      tags:
      - ProcedureRunPlanCondition
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-run-plan-condition:batch-create:
    post:
      description: Batch create ProcedureRunPlanCondition synchronously in one transaction.
        Maximum 25 items per request.
      operationId: ProcedureRunPlanCondition.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateProcedureRunPlanConditionInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/ProcedureRunPlanCondition'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create ProcedureRunPlanCondition
      tags:
      - ProcedureRunPlanCondition
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /procedure-run-plan-condition:batch-update:
    patch:
      description: Batch update ProcedureRunPlanCondition synchronously in one transaction.
        Maximum 25 items per request.
      operationId: ProcedureRunPlanCondition.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateProcedureRunPlanConditionInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/ProcedureRunPlanCondition'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update ProcedureRunPlanCondition
      tags:
      - ProcedureRunPlanCondition
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /procedure-run-plan-condition:bulk-create:
    post:
      description: Bulk create up to 25 run plan conditions. Returns an async task
        link — poll the task to retrieve created object IDs. Each item follows the
        same field requirements and constraints as the single-create endpoint.
      operationId: ProcedureRunPlanCondition.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create ProcedureRunPlanCondition
      tags:
      - ProcedureRunPlanCondition
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /procedure-run-plan-condition:bulk-update:
    patch:
      description: Bulk update up to 25 run plan conditions. Returns an async task
        link — poll the task to retrieve results. Each item follows the same constraints
        as the single-update endpoint.
      operationId: ProcedureRunPlanCondition.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update ProcedureRunPlanCondition
      tags:
      - ProcedureRunPlanCondition
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /procedure-run-plan/items:
    get:
      description: List ProcedureRunPlan items.
      operationId: ProcedureRunPlan.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/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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureRunPlanPaginatedList'
          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 ProcedureRunPlan items
      tags:
      - ProcedureRunPlan
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-run-plan/{procedure_run_plan_id}:
    get:
      description: Get a single ProcedureRunPlan by ID.
      operationId: ProcedureRunPlan.Get
      parameters:
      - description: ID of the ProcedureRunPlan.
        in: path
        name: procedure_run_plan_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureRunPlan'
          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 ProcedureRunPlan by ID
      tags:
      - ProcedureRunPlan
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: 'Update a run plan.

        ## Constraints

        - **Cannot update a plan that has been turned into a run.** Once a plan has
        been turned into a run, it is immutable.

        - `dataEntryMode` set to `ALL_CONDITION_REPLICATES_TOGETHER` is rejected for
        assay development study plans.


        ## Reordering conditions

        Use `conditionOrder` to reorder existing conditions within a procedure method
        definition version (PMDV). Each entry specifies a `templateMethodVersionId`
        and an ordered list of `conditionIds`. The list must include **every** existing
        condition ID for that PMDV — no duplicates, no omissions, and no IDs from
        other PMDVs or plans.'
      operationId: ProcedureRunPlan.Update
      parameters:
      - description: ID of the ProcedureRunPlan.
        in: path
        name: procedure_run_plan_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProcedureRunPlanInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureRunPlan'
          description: OK
        '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: Update ProcedureRunPlan
      tags:
      - ProcedureRunPlan
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-run-plan/{procedure_run_plan_id}/procedure-run-plan-conditions/items:
    get:
      description: List ProcedureRunPlanCondition items.
      operationId: ProcedureRunPlan.procedureRunPlanConditions.List
      parameters:
      - description: ID of the ProcedureRunPlan.
        in: path
        name: procedure_run_plan_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureRunPlanConditionUnpaginatedList'
          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 ProcedureRunPlanCondition items
      tags:
      - ProcedureRunPlan
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-run-plan:batch-create:
    post:
      description: Batch create ProcedureRunPlan synchronously in one transaction.
        Maximum 25 items per request.
      operationId: ProcedureRunPlan.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateProcedureRunPlanInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/ProcedureRunPlan'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create ProcedureRunPlan
      tags:
      - ProcedureRunPlan
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /procedure-run-plan:batch-update:
    patch:
      description: Batch update ProcedureRunPlan synchronously in one transaction.
        Maximum 25 items per request.
      operationId: ProcedureRunPlan.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateProcedureRunPlanInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/ProcedureRunPlan'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update ProcedureRunPlan
      tags:
      - ProcedureRunPlan
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /procedure-run-plan:bulk-create:
    post:
      description: Bulk create up to 25 run plans. Returns an async task link — poll
        the task to retrieve created object IDs. Each item follows the same field
        requirements as the single-create endpoint.
      operationId: ProcedureRunPlan.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create ProcedureRunPlan
      tags:
      - ProcedureRunPlan
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /procedure-run-plan:bulk-update:
    patch:
      description: Bulk update up to 25 run plans. Returns an async task link — poll
        the task to retrieve results. Each item follows the same constraints as the
        single-update endpoint.
      operationId: ProcedureRunPlan.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update ProcedureRunPlan
      tags:
      - ProcedureRunPlan
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /procedure-run-plan:promote:
    post:
      description: Turn procedure run plans into active procedure runs. Plans must
        not already be converted. Returns an async task — poll the task endpoint for
        completion and the created procedure run IDs
      operationId: ProcedureRunPlan.Promote
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromoteProcedureRunPlanInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Turn procedure run plans into active procedure runs. Plans must not
        already be converted. Returns an async task — poll the task endpoint for completion
        and the created procedure run IDs
      tags:
      - ProcedureRunPlan
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-run/items:
    get:
      description: List ProcedureRun items.
      operationId: ProcedureRun.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/returning'
      - $ref: '#/components/parameters/study.eq'
      - $ref: '#/components/parameters/templateProcedureFlowchartVersion.anyOf'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureRunPaginatedList'
          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 ProcedureRun items
      tags:
      - ProcedureRun
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-run/{procedure_run_id}:
    get:
      description: Get a single ProcedureRun by ID.
      operationId: ProcedureRun.Get
      parameters:
      - description: ID of the ProcedureRun.
        in: path
        name: procedure_run_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureRun'
          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 ProcedureRun by ID
      tags:
      - ProcedureRun
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /procedure-run/{procedure_run_id}/conditions/items:
    get:
      description: List ProcedureRunCondition items.
      operationId: ProcedureRun.conditions.List
      parameters:
      - description: ID of the ProcedureRun.
        in: path
        name: procedure_run_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureRunConditionUnpaginatedList'
          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:
      - ProcedureRun
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-run/{procedure_run_id}/method-execution-instances/items:
    get:
      description: List ProcedureMethodExecutionInstance items.
      operationId: ProcedureRun.methodExecutionInstances.List
      parameters:
      - description: ID of the ProcedureRun.
        in: path
        name: procedure_run_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureMethodExecutionInstanceUnpaginatedList'
          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 ProcedureMethodExecutionInstance items
      tags:
      - ProcedureRun
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-step-definition-version/items:
    get:
      description: List ProcedureStepDefinitionVersion items.
      operationId: ProcedureStepDefinitionVersion.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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureStepDefinitionVersionPaginatedList'
          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 ProcedureStepDefinitionVersion items
      tags:
      - ProcedureStepDefinitionVersion
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-step-definition-version/{procedure_step_definition_version_id}:
    get:
      description: Get a single ProcedureStepDefinitionVersion by ID.
      operationId: ProcedureStepDefinitionVersion.Get
      parameters:
      - description: ID of the ProcedureStepDefinitionVersion.
        in: path
        name: procedure_step_definition_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureStepDefinitionVersion'
          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 ProcedureStepDefinitionVersion by ID
      tags:
      - ProcedureStepDefinitionVersion
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /procedure-step-execution-instance/items:
    get:
      description: List ProcedureStepExecutionInstance items.
      operationId: ProcedureStepExecutionInstance.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureStepExecutionInstancePaginatedList'
          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 ProcedureStepExecutionInstance items
      tags:
      - ProcedureStepExecutionInstance
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure-step-execution-instance/{procedure_step_execution_instance_id}:
    get:
      description: Get a single ProcedureStepExecutionInstance by ID.
      operationId: ProcedureStepExecutionInstance.Get
      parameters:
      - description: ID of the ProcedureStepExecutionInstance.
        in: path
        name: procedure_step_execution_instance_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedureStepExecutionInstance'
          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 ProcedureStepExecutionInstance by ID
      tags:
      - ProcedureStepExecutionInstance
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /procedure/items:
    get:
      description: List Procedure items.
      operationId: Procedure.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcedurePaginatedList'
          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 Procedure items
      tags:
      - Procedure
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /procedure/{procedure_id}:
    get:
      description: Get a single Procedure by ID.
      operationId: Procedure.Get
      parameters:
      - description: ID of the Procedure.
        in: path
        name: procedure_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Procedure'
          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 Procedure by ID
      tags:
      - Procedure
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /project:
    post:
      description: Create Project.
      operationId: Project.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProjectInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
          description: Created
        '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: Create Project
      tags:
      - Project
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /project/items:
    get:
      description: List Project items.
      operationId: Project.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/reviewProcess.eq'
      - description: 'Method by which to order results. Valid sorts are: 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:
          - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectPaginatedList'
          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 Project items
      tags:
      - Project
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /project/{project_id}:
    get:
      description: Get a single Project by ID.
      operationId: Project.Get
      parameters:
      - description: ID of the Project.
        in: path
        name: project_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
          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 Project by ID
      tags:
      - Project
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update Project.
      operationId: Project.Update
      parameters:
      - description: ID of the Project.
        in: path
        name: project_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProjectInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
          description: OK
        '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: Update Project
      tags:
      - Project
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /project/{project_id}/collaborations/items:
    get:
      description: List Collaboration items.
      operationId: Project.collaborations.List
      parameters:
      - description: ID of the Project.
        in: path
        name: project_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollaborationUnpaginatedList'
          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 Collaboration items
      tags:
      - Project
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /project/{project_id}/review-processes/items:
    get:
      description: List ReviewProcess items.
      operationId: Project.reviewProcesses.List
      parameters:
      - description: ID of the Project.
        in: path
        name: project_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewProcessUnpaginatedList'
          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 ReviewProcess items
      tags:
      - Project
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /project:batch-create:
    post:
      description: Batch create Project synchronously in one transaction. Maximum
        25 items per request.
      operationId: Project.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateProjectInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Project'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create Project
      tags:
      - Project
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /project:batch-update:
    patch:
      description: Batch update Project synchronously in one transaction. Maximum
        25 items per request.
      operationId: Project.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateProjectInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Project'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Project
      tags:
      - Project
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /project:bulk-create:
    post:
      description: Bulk create Project.
      operationId: Project.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create Project
      tags:
      - Project
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /project:bulk-update:
    patch:
      description: Bulk update Project.
      operationId: Project.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Project
      tags:
      - Project
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /protein:
    post:
      description: Create Protein.
      operationId: Protein.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProteinInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Protein'
          description: Created
        '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: Create Protein
      tags:
      - Protein
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein-format:
    post:
      description: Create ProteinFormat.
      operationId: ProteinFormat.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProteinFormatInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProteinFormat'
          description: Created
        '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: Create ProteinFormat
      tags:
      - ProteinFormat
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein-format/items:
    get:
      description: List ProteinFormat items.
      operationId: ProteinFormat.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProteinFormatPaginatedList'
          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 ProteinFormat items
      tags:
      - ProteinFormat
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein-format/{protein_format_id}:
    get:
      description: Get a single ProteinFormat by ID.
      operationId: ProteinFormat.Get
      parameters:
      - description: ID of the ProteinFormat.
        in: path
        name: protein_format_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProteinFormat'
          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 ProteinFormat by ID
      tags:
      - ProteinFormat
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update ProteinFormat.
      operationId: ProteinFormat.Update
      parameters:
      - description: ID of the ProteinFormat.
        in: path
        name: protein_format_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProteinFormatInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProteinFormat'
          description: OK
        '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: Update ProteinFormat
      tags:
      - ProteinFormat
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein-format:batch-create:
    post:
      description: Batch create ProteinFormat synchronously in one transaction. Maximum
        25 items per request.
      operationId: ProteinFormat.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateProteinFormatInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/ProteinFormat'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create ProteinFormat
      tags:
      - ProteinFormat
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /protein-format:batch-update:
    patch:
      description: Batch update ProteinFormat synchronously in one transaction. Maximum
        25 items per request.
      operationId: ProteinFormat.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateProteinFormatInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/ProteinFormat'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update ProteinFormat
      tags:
      - ProteinFormat
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /protein-format:bulk-create:
    post:
      description: Bulk create ProteinFormat.
      operationId: ProteinFormat.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create ProteinFormat
      tags:
      - ProteinFormat
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /protein-format:bulk-update:
    patch:
      description: Bulk update ProteinFormat.
      operationId: ProteinFormat.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update ProteinFormat
      tags:
      - ProteinFormat
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /protein-schema:
    post:
      description: Create ProteinSchema.
      operationId: ProteinSchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAntibodySchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProteinSchema'
          description: Created
        '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: Create ProteinSchema
      tags:
      - ProteinSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein-schema/items:
    get:
      description: List ProteinSchema items.
      operationId: ProteinSchema.List
      parameters:
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/returning'
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProteinSchemaPaginatedList'
          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 ProteinSchema items
      tags:
      - ProteinSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein-schema/{protein_schema_id}:
    get:
      description: Get a single ProteinSchema by ID.
      operationId: ProteinSchema.Get
      parameters:
      - description: ID of the ProteinSchema.
        in: path
        name: protein_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProteinSchema'
          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 ProteinSchema by ID
      tags:
      - ProteinSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update ProteinSchema.
      operationId: ProteinSchema.Update
      parameters:
      - description: ID of the ProteinSchema.
        in: path
        name: protein_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAntibodySchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProteinSchema'
          description: OK
        '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: Update ProteinSchema
      tags:
      - ProteinSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein-schema/{protein_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: ProteinSchema.fieldDefinitions.List
      parameters:
      - description: ID of the ProteinSchema.
        in: path
        name: protein_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - ProteinSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein-schema/{protein_schema_id}/fieldsets/items:
    get:
      description: List Fieldset items.
      operationId: ProteinSchema.fieldsets.List
      parameters:
      - description: ID of the ProteinSchema.
        in: path
        name: protein_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsetUnpaginatedList'
          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 Fieldset items
      tags:
      - ProteinSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein-schema/{protein_schema_id}:apply-fieldset:
    post:
      description: Apply a fieldset to the schema
      operationId: ProteinSchema.ApplyFieldset
      parameters:
      - description: ID of the ProteinSchema.
        in: path
        name: protein_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitySchemaApplyFieldsetInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Apply a fieldset to the schema
      tags:
      - ProteinSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein-schema/{protein_schema_id}:set-field-definitions:
    post:
      description: Set field definitions on the schema
      operationId: ProteinSchema.SetFieldDefinitions
      parameters:
      - description: ID of the ProteinSchema.
        in: path
        name: protein_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AntibodySchemaSetFieldDefinitionsInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Set field definitions on the schema
      tags:
      - ProteinSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein-schema:batch-create:
    post:
      description: Batch create ProteinSchema synchronously in one transaction. Maximum
        25 items per request.
      operationId: ProteinSchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateAntibodySchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/ProteinSchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create ProteinSchema
      tags:
      - ProteinSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /protein-schema:batch-update:
    patch:
      description: Batch update ProteinSchema synchronously in one transaction. Maximum
        25 items per request.
      operationId: ProteinSchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateAntibodySchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/ProteinSchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update ProteinSchema
      tags:
      - ProteinSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /protein-schema:bulk-create:
    post:
      description: Bulk create ProteinSchema.
      operationId: ProteinSchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create ProteinSchema
      tags:
      - ProteinSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /protein-schema:bulk-update:
    patch:
      description: Bulk update ProteinSchema.
      operationId: ProteinSchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update ProteinSchema
      tags:
      - ProteinSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /protein-version/items:
    get:
      description: List ProteinVersion items.
      operationId: ProteinVersion.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/proteinFullHistory.eq'
      - $ref: '#/components/parameters/proteinHistory.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:asc.'
        in: query
        name: sort
        schema:
          default: createdAt:asc
          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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProteinVersionPaginatedList'
          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 ProteinVersion items
      tags:
      - ProteinVersion
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein-version/{protein_version_id}:
    get:
      description: Get a single ProteinVersion by ID.
      operationId: ProteinVersion.Get
      parameters:
      - description: ID of the ProteinVersion.
        in: path
        name: protein_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProteinVersion'
          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 ProteinVersion by ID
      tags:
      - ProteinVersion
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /protein/items:
    get:
      description: List Protein items.
      operationId: Protein.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/authors.anyOf'
      - $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/fieldset.anyOf'
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/mentionedIn.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/project.eq'
      - $ref: '#/components/parameters/registry.eq'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/schema.anyOf'
      - $ref: '#/components/parameters/schema.eq'
      - $ref: '#/components/parameters/systemCategory.anyOf'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProteinPaginatedList'
          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 Protein items
      tags:
      - Protein
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein/{protein_id}:
    get:
      description: Get a single Protein by ID.
      operationId: Protein.Get
      parameters:
      - description: ID of the Protein.
        in: path
        name: protein_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Protein'
          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 Protein by ID
      tags:
      - Protein
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update Protein.
      operationId: Protein.Update
      parameters:
      - description: ID of the Protein.
        in: path
        name: protein_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProteinInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Protein'
          description: OK
        '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: Update Protein
      tags:
      - Protein
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein/{protein_id}/authors/items:
    get:
      description: List Principal items.
      operationId: Protein.authors.List
      parameters:
      - description: ID of the Protein.
        in: path
        name: protein_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - Protein
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein/{protein_id}/full-history/items:
    get:
      description: List ProteinVersion items.
      operationId: Protein.fullHistory.List
      parameters:
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/pageSize'
      - description: ID of the Protein.
        in: path
        name: protein_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProteinVersionPaginatedList'
          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 ProteinVersion items
      tags:
      - Protein
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein/{protein_id}/history/items:
    get:
      description: List ProteinVersion items.
      operationId: Protein.history.List
      parameters:
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/pageSize'
      - description: ID of the Protein.
        in: path
        name: protein_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProteinVersionPaginatedList'
          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 ProteinVersion items
      tags:
      - Protein
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /protein:batch-create:
    post:
      description: Batch create Protein synchronously in one transaction. Maximum
        25 items per request.
      operationId: Protein.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateProteinInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Protein'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create Protein
      tags:
      - Protein
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /protein:batch-update:
    patch:
      description: Batch update Protein synchronously in one transaction. Maximum
        25 items per request.
      operationId: Protein.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateProteinInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Protein'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Protein
      tags:
      - Protein
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /protein:bulk-create:
    post:
      description: Bulk create Protein.
      operationId: Protein.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create Protein
      tags:
      - Protein
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /protein:bulk-update:
    patch:
      description: Bulk update Protein.
      operationId: Protein.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Protein
      tags:
      - Protein
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /proteins:bulk-create-and-register-proteins-and-components:
    post:
      description: Create and register proteins and their component parts (domains,
        chains, and variable pairs)
      operationId: ProteinsAndComponents.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                entryId:
                  description: 'The ID of the notebook entry into which the creation
                    results will be embedded upon completion.

                    If omitted, no results are written to a notebook entry.

                    '
                  example: etr_8eTVGFUm2T
                  type: string
                folderId:
                  description: The ID of the folder in which the new entities should
                    be created.
                  example: lib_lKsxK6
                  type: string
                germlineConfigs:
                  description: 'A list of germline configs indicating the germline
                    with which to annotate each domain key.

                    This applies to all rows in the request.

                    '
                  items:
                    additionalProperties: false
                    properties:
                      domainKey:
                        additionalProperties: false
                        properties:
                          label:
                            description: The domain label (e.g., "VH", "VL").
                            example: VH
                            type: string
                        required:
                        - label
                        type: object
                      germlineId:
                        description: API ID of the germline to use for this domain.
                        example: grmln_abc123
                        type: string
                    required:
                    - domainKey
                    - germlineId
                    type: object
                  nullable: true
                  type: array
                newComponentConfig:
                  additionalProperties: false
                  description: 'Schema IDs for new component entities created during
                    this request.

                    Applies to all rows in the request.

                    '
                  properties:
                    aaPairSchemaId:
                      description: 'Schema ID for creating Amino Acid variable pair
                        entities for this request.

                        '
                      example: ts_aapair012
                      type: string
                    dnaChainSchemaId:
                      description: 'Schema ID for DNA chain sequences created for
                        this request.

                        Required if there are DNA inputs.

                        '
                      example: ts_dnachain456
                      nullable: true
                      type: string
                    dnaDomainSchemaId:
                      description: 'Schema ID for DNA domain sequences created for
                        this request.

                        Required if there are DNA inputs.

                        '
                      example: ts_dnadomain123
                      nullable: true
                      type: string
                    dnaPairSchemaId:
                      description: 'Schema ID for creating DNA variable pair entities
                        for this request.

                        Required if there are DNA inputs.

                        '
                      example: ts_dnapair789
                      nullable: true
                      type: string
                  required:
                  - aaPairSchemaId
                  type: object
                proteinCreateInputs:
                  items:
                    additionalProperties: false
                    anyOf:
                    - required:
                      - domains
                    - required:
                      - chains
                    description: 'Describes one complete protein and optionally some
                      of the DNA that encodes for it.


                      The input does not necessarily need to contain every domain
                      and every chain

                      defined in the associated proteinSchema, and users of this API
                      are welcome to leave

                      many of them out as long as they meet the following constraint:


                      For every amino acid chain type defined in the proteinSchema,
                      either

                      a) it must occur in the chains array

                      or

                      b) each of its constituent domain types must occur in the domains
                      array, or occur as a component

                      of one of the provided variablePairs.


                      Chains that are not provided will be derived from their constituent
                      domains.

                      Domains that are not provided will be annotated and decomposed
                      based on an analysis of the sequence of the

                      chains containing them.

                      '
                    properties:
                      chains:
                        items:
                          additionalProperties: false
                          anyOf:
                          - required:
                            - chainKey
                            - dnaComponent
                          - required:
                            - chainKey
                            - aaComponent
                          description: 'Defines an entity to represent the amino acid
                            residues for one amino acid chain of the protein.

                            Optionally also defines one entity to represent the associated
                            DNA.

                            If only dnaComponent is provided, the amino acid residues
                            will be derived from it by translation.

                            If both dnaComponent and aaComponent are provided, the
                            DNA bases must translate to the Amino Acid residues.

                            '
                          properties:
                            aaComponent:
                              anyOf:
                              - additionalProperties: false
                                properties:
                                  aaSequenceId:
                                    description: API ID of an existing AA sequence.
                                    example: prtn_uIKU1o
                                    type: string
                                  type:
                                    enum:
                                    - EXISTING
                                    example: EXISTING
                                    type: string
                                required:
                                - type
                                - aaSequenceId
                                type: object
                              - additionalProperties: false
                                properties:
                                  residues:
                                    description: The amino acid residues for the new
                                      sequence to be created.
                                    example: MEVQLVESGGGLVQPGGSLRLSCAASGF
                                    type: string
                                  type:
                                    enum:
                                    - NEW
                                    example: NEW
                                    type: string
                                required:
                                - type
                                - residues
                                type: object
                            chainKey:
                              additionalProperties: false
                              properties:
                                label:
                                  example: Heavy
                                  type: string
                              required:
                              - label
                              type: object
                            dnaComponent:
                              anyOf:
                              - additionalProperties: false
                                properties:
                                  dnaSequenceId:
                                    description: API ID of an existing DNA sequence.
                                    example: seq_sX1bVB
                                    type: string
                                  type:
                                    enum:
                                    - EXISTING
                                    example: EXISTING
                                    type: string
                                required:
                                - type
                                - dnaSequenceId
                                type: object
                              - additionalProperties: false
                                properties:
                                  bases:
                                    description: The DNA bases for the new sequence
                                      to be created.
                                    example: ATGCATGC
                                    type: string
                                  type:
                                    enum:
                                    - NEW
                                    example: NEW
                                    type: string
                                required:
                                - type
                                - bases
                                type: object
                          type: object
                        type: array
                      domains:
                        items:
                          additionalProperties: false
                          anyOf:
                          - required:
                            - domainKey
                            - dnaComponent
                          - required:
                            - domainKey
                            - aaComponent
                          description: 'Defines an entity to represent the amino acid
                            residues for one domain of the protein.

                            Optionally also defines one entity to represent the associated
                            DNA.

                            If only dnaComponent is provided, the amino acid residues
                            will be derived from it by translation.

                            If both dnaComponent and aaComponent are provided, the
                            DNA bases must translate to the Amino Acid residues.

                            '
                          properties:
                            aaComponent:
                              anyOf:
                              - additionalProperties: false
                                properties:
                                  aaSequenceId:
                                    description: API ID of an existing AA sequence
                                      entity.
                                    example: prtn_uIKU1o
                                    type: string
                                  type:
                                    enum:
                                    - EXISTING
                                    example: EXISTING
                                    type: string
                                required:
                                - type
                                - aaSequenceId
                                type: object
                              - additionalProperties: false
                                properties:
                                  residues:
                                    description: The amino acid residues to use for
                                      the new Amino Acid sequence entity.
                                    example: MEVQLVESGGGLVQPGGSLRLSCAASGF
                                    type: string
                                  type:
                                    enum:
                                    - NEW
                                    example: NEW
                                    type: string
                                required:
                                - type
                                - residues
                                type: object
                            dnaComponent:
                              anyOf:
                              - additionalProperties: false
                                properties:
                                  dnaSequenceId:
                                    description: API ID of an existing DNA sequence
                                      entity.
                                    example: seq_sX1bVB
                                    type: string
                                  type:
                                    enum:
                                    - EXISTING
                                    example: EXISTING
                                    type: string
                                required:
                                - type
                                - dnaSequenceId
                                type: object
                              - additionalProperties: false
                                properties:
                                  bases:
                                    description: The DNA bases to use for the new
                                      DNA sequence entity.
                                    example: ATGCATGCC
                                    type: string
                                  type:
                                    enum:
                                    - NEW
                                    example: NEW
                                    type: string
                                required:
                                - type
                                - bases
                                type: object
                            domainKey:
                              additionalProperties: false
                              properties:
                                label:
                                  description: The domain label (e.g., "VH", "CH1(Heavy)",
                                    "VLkappa").
                                  example: CH1(Heavy)
                                  type: string
                              required:
                              - label
                              type: object
                          type: object
                        type: array
                      variablePairs:
                        description: 'A list of variable domain pair inputs (e.g.,
                          VH+VL for antibodies, VA+VB for TCRs).

                          Each pair is identified by its two constituent domain keys.

                          '
                        items:
                          additionalProperties: false
                          anyOf:
                          - required:
                            - pairKey
                            - dnaPairId
                          - required:
                            - pairKey
                            - aaPairId
                          properties:
                            aaPairId:
                              description: API ID of an existing AA variable pair
                                entity.
                              example: bfi_def456
                              type: string
                            dnaPairId:
                              description: API ID of an existing DNA variable pair
                                entity.
                              example: bfi_abc123
                              type: string
                            pairKey:
                              additionalProperties: false
                              description: 'Identifies the variable domain pair by
                                its two constituent domain keys.

                                ''vhVaVg'' covers VH (antibody), VA (TCR alpha/delta),
                                or VG (TCR gamma) domains.

                                ''vlVbVd'' covers VL (antibody), VB (TCR beta), or
                                VD (TCR delta) domains.

                                '
                              properties:
                                vhVaVg:
                                  additionalProperties: false
                                  properties:
                                    label:
                                      description: The domain label of the VH, VA,
                                        or VG domain in this pair.
                                      example: VH
                                      type: string
                                  required:
                                  - label
                                  type: object
                                vlVbVd:
                                  additionalProperties: false
                                  properties:
                                    label:
                                      description: The domain label of the VL, VB,
                                        or VD domain in this pair.
                                      example: VL
                                      type: string
                                  required:
                                  - label
                                  type: object
                              required:
                              - vhVaVg
                              - vlVbVd
                              type: object
                          type: object
                        nullable: true
                        type: array
                    type: object
                  minItems: 1
                  type: array
                proteinSchemaId:
                  description: The schema ID for the protein entity type.
                  example: ts_XEUrLw
                  type: string
                translationParameters:
                  additionalProperties: false
                  description: 'The translation parameters to use when creating AA
                    sequences.

                    Required if the request contains DNA sequences.

                    May be omitted if the request contains only AA sequences.

                    '
                  properties:
                    geneticCode:
                      description: The codon table to use to translate DNA sequences
                        to AA sequences.
                      enum:
                      - STANDARD
                      - VERTEBRATE_MITOCHONDRIAL
                      - YEAST_MITOCHONDRIAL
                      - MOLD_MITOCHONDRIAL
                      - INVERTEBRATE_MITOCHONDRIAL
                      - CILIATE_NUCLEAR
                      - ECHINODERM_MITOCHONDRIAL
                      - EUPLOTID_NUCLEAR
                      - BACTERIAL_ARCHAEAL
                      - ALTERNATIVE_YEAST_NUCLEAR
                      - ASCIDIAN_MITOCHONDRIAL
                      - ALTERNATIVE_FLATWORM_MITOCHONDRIAL
                      - BLEPHARISMA_NUCLEAR
                      - CHLOROPHYCEAN_MITOCHONDRIAL
                      - TREMATODE_MITOCHONDRIAL
                      - SCENEDESMUS_OBLIQUUS_MITOCHONDRIAL
                      - THRAUSTOCHYTRIUM_MITOCHONDRIAL
                      - PTEROBRANCHIA_MITOCHONDRIAL
                      - CANDIDATE_DIVISION_SR1
                      type: string
                  required:
                  - geneticCode
                  type: object
              required:
              - folderId
              - proteinSchemaId
              - newComponentConfig
              - proteinCreateInputs
              type: object
        description: 'Create and register proteins along with their component domains,
          chains, and variable pairs.


          Does not create plasmids.


          **Optional/Required Inputs**


          Any components that are not provided in the input will be derived

          from other input components when possible.

          For example, AA domains are not necessary if DNA domains are provided.

          See the documentation on the proteinCreateInputs parameter for more detail.

          Here are some example ways to provide the inputs:

          - provide all domains as DNA

          - provide all domains as AA

          - provide constant domains as AA and variable domains using variable pairs


          **Scale**


          A single call to this API may include up to:

          - 1,000 antibodies

          - 4,000 AA chains

          - 4,000 DNA chains

          - 14,000 AA domains

          - 14,000 DNA domains

          - 2,000 DNA pairs

          - 2,000 AA pairs


          **Large requests may take several hours to complete.**

          When results are ready, they''ll be aggregated into a Benchling.Dataset
          object,

          and added to the folder and entry referenced in the input.


          **Error Handling and Partial Success**


          All inputs are validated before any registrations begin.

          If any input fails validation, no proteins are registered.

          In rare cases (e.g. concurrent manual data changes during a running task),

          a partial success is possible.

          '
      responses:
        '202':
          content:
            application/json:
              schema:
                properties:
                  pollingUri:
                    description: A URL to poll for the status of the task.
                    example: https://tenant.com/api/v3/tasks/bulk-create-and-register-proteins-and-components/cprotjob:ana_fhlbqd
                    format: uri
                    type: string
                  taskId:
                    example: cprotjob:ana_fhlbqd
                    type: string
                required:
                - taskId
                - pollingUri
                type: object
          description: Job status details
        '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: Create and register proteins and components
      tags:
      - Protein
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /reaction/items:
    get:
      description: List Reaction items.
      operationId: Reaction.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReactionPaginatedList'
          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 Reaction items
      tags:
      - Reaction
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /reaction/{reaction_id}:
    get:
      description: Get a single Reaction by ID.
      operationId: Reaction.Get
      parameters:
      - description: ID of the Reaction.
        in: path
        name: reaction_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reaction'
          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 Reaction by ID
      tags:
      - Reaction
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: 'Archive or unarchive a reaction.


        Set `archived` to `true` (with an optional `archiveReason`) to archive a reaction,
        or `false` to unarchive it. Editing a submitted reaction''s name, components,
        or folder is not supported through the API.'
      operationId: Reaction.Update
      parameters:
      - description: ID of the Reaction.
        in: path
        name: reaction_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateReactionInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reaction'
          description: OK
        '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: Update Reaction
      tags:
      - Reaction
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /reaction/{reaction_id}/authors/items:
    get:
      description: List Principal items.
      operationId: Reaction.authors.List
      parameters:
      - description: ID of the Reaction.
        in: path
        name: reaction_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - Reaction
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /reaction:batch-update:
    patch:
      description: Batch update Reaction synchronously in one transaction. Maximum
        25 items per request.
      operationId: Reaction.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateReactionInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Reaction'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Reaction
      tags:
      - Reaction
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /reaction:bulk-update:
    patch:
      description: Bulk update Reaction.
      operationId: Reaction.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Reaction
      tags:
      - Reaction
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /registry/items:
    get:
      description: List Registry items.
      operationId: Registry.List
      parameters:
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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: 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:
          - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistryPaginatedList'
          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 Registry items
      tags:
      - Registry
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /registry/{registry_id}:
    get:
      description: Get a single Registry by ID.
      operationId: Registry.Get
      parameters:
      - description: ID of the Registry.
        in: path
        name: registry_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Registry'
          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 Registry by ID
      tags:
      - Registry
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /request-v2-definition:
    post:
      description: Create RequestV2Definition.
      operationId: RequestV2Definition.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRequestV2DefinitionInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestV2Definition'
          description: Created
        '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: Create RequestV2Definition
      tags:
      - RequestV2Definition
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /request-v2-definition/items:
    get:
      description: List RequestV2Definition items.
      operationId: RequestV2Definition.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestV2DefinitionPaginatedList'
          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 RequestV2Definition items
      tags:
      - RequestV2Definition
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /request-v2-definition/{request_v2_definition_id}:
    get:
      description: Get a single RequestV2Definition by ID.
      operationId: RequestV2Definition.Get
      parameters:
      - description: ID of the RequestV2Definition.
        in: path
        name: request_v2_definition_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestV2Definition'
          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 RequestV2Definition by ID
      tags:
      - RequestV2Definition
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update RequestV2Definition.
      operationId: RequestV2Definition.Update
      parameters:
      - description: ID of the RequestV2Definition.
        in: path
        name: request_v2_definition_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRequestV2DefinitionInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestV2Definition'
          description: OK
        '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: Update RequestV2Definition
      tags:
      - RequestV2Definition
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /request-v2-definition:batch-create:
    post:
      description: Batch create RequestV2Definition synchronously in one transaction.
        Maximum 25 items per request.
      operationId: RequestV2Definition.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateRequestV2DefinitionInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/RequestV2Definition'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create RequestV2Definition
      tags:
      - RequestV2Definition
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /request-v2-definition:batch-update:
    patch:
      description: Batch update RequestV2Definition synchronously in one transaction.
        Maximum 25 items per request.
      operationId: RequestV2Definition.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateRequestV2DefinitionInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/RequestV2Definition'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update RequestV2Definition
      tags:
      - RequestV2Definition
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /request-v2-definition:bulk-create:
    post:
      description: Bulk create RequestV2Definition.
      operationId: RequestV2Definition.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create RequestV2Definition
      tags:
      - RequestV2Definition
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /request-v2-definition:bulk-update:
    patch:
      description: Bulk update RequestV2Definition.
      operationId: RequestV2Definition.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update RequestV2Definition
      tags:
      - RequestV2Definition
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /request-v2-submission/items:
    get:
      description: List RequestV2Submission items.
      operationId: RequestV2Submission.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestV2SubmissionPaginatedList'
          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 RequestV2Submission items
      tags:
      - RequestV2Submission
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /request-v2-submission/{request_v2_submission_id}:
    get:
      description: Get a single RequestV2Submission by ID.
      operationId: RequestV2Submission.Get
      parameters:
      - description: ID of the RequestV2Submission.
        in: path
        name: request_v2_submission_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestV2Submission'
          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 RequestV2Submission by ID
      tags:
      - RequestV2Submission
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /request-v2-submission/{request_v2_submission_id}/authors/items:
    get:
      description: List Principal items.
      operationId: RequestV2Submission.authors.List
      parameters:
      - description: ID of the RequestV2Submission.
        in: path
        name: request_v2_submission_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - RequestV2Submission
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /result:
    post:
      description: Create Result.
      operationId: Result.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateResultInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
          description: Created
        '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: Create Result
      tags:
      - Result
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /result-schema/items:
    get:
      description: List ResultSchema items.
      operationId: ResultSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultSchemaPaginatedList'
          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 ResultSchema items
      tags:
      - ResultSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /result-schema/{result_schema_id}:
    get:
      description: Get a single ResultSchema by ID.
      operationId: ResultSchema.Get
      parameters:
      - description: ID of the ResultSchema.
        in: path
        name: result_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultSchema'
          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 ResultSchema by ID
      tags:
      - ResultSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /result-schema/{result_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: ResultSchema.fieldDefinitions.List
      parameters:
      - description: ID of the ResultSchema.
        in: path
        name: result_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - ResultSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /result/items:
    get:
      description: List Result items.
      operationId: Result.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/entry.anyOf'
      - $ref: '#/components/parameters/entry.eq'
      - $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/project.eq'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/schema.anyOf'
      - $ref: '#/components/parameters/schema.eq'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultPaginatedList'
          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 Result items
      tags:
      - Result
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /result/{result_id}:
    get:
      description: Get a single Result by ID.
      operationId: Result.Get
      parameters:
      - description: ID of the Result.
        in: path
        name: result_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
          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 Result by ID
      tags:
      - Result
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update Result.
      operationId: Result.Update
      parameters:
      - description: ID of the Result.
        in: path
        name: result_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateResultInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Result'
          description: OK
        '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: Update Result
      tags:
      - Result
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /result:batch-create:
    post:
      description: Batch create Result synchronously in one transaction. Maximum 25
        items per request.
      operationId: Result.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateResultInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Result'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create Result
      tags:
      - Result
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /result:batch-update:
    patch:
      description: Batch update Result synchronously in one transaction. Maximum 25
        items per request.
      operationId: Result.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateResultInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Result'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Result
      tags:
      - Result
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /result:bulk-create:
    post:
      description: Bulk create Result.
      operationId: Result.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create Result
      tags:
      - Result
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /result:bulk-update:
    patch:
      description: Bulk update Result.
      operationId: Result.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Result
      tags:
      - Result
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /review-change/items:
    get:
      description: List ReviewChange items.
      operationId: ReviewChange.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'
      - $ref: '#/components/parameters/review.eq'
      - $ref: '#/components/parameters/reviewId.anyOf'
      - $ref: '#/components/parameters/reviewableId.anyOf'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewChangePaginatedList'
          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 ReviewChange items
      tags:
      - ReviewChange
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /review-change/{review_change_id}:
    get:
      description: Get a single ReviewChange by ID.
      operationId: ReviewChange.Get
      parameters:
      - description: ID of the ReviewChange.
        in: path
        name: review_change_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewChange'
          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 ReviewChange by ID
      tags:
      - ReviewChange
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /review-process-stage/items:
    get:
      description: List ReviewProcessStage items.
      operationId: ReviewProcessStage.List
      parameters:
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/returning'
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewProcessStagePaginatedList'
          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 ReviewProcessStage items
      tags:
      - ReviewProcessStage
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /review-process-stage/{review_process_stage_id}:
    get:
      description: Get a single ReviewProcessStage by ID.
      operationId: ReviewProcessStage.Get
      parameters:
      - description: ID of the ReviewProcessStage.
        in: path
        name: review_process_stage_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewProcessStage'
          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 ReviewProcessStage by ID
      tags:
      - ReviewProcessStage
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /review-process/items:
    get:
      description: List ReviewProcess items.
      operationId: ReviewProcess.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewProcessPaginatedList'
          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 ReviewProcess items
      tags:
      - ReviewProcess
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /review-process/{review_process_id}:
    get:
      description: Get a single ReviewProcess by ID.
      operationId: ReviewProcess.Get
      parameters:
      - description: ID of the ReviewProcess.
        in: path
        name: review_process_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewProcess'
          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 ReviewProcess by ID
      tags:
      - ReviewProcess
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /review-process/{review_process_id}/projects/items:
    get:
      description: List Project items.
      operationId: ReviewProcess.projects.List
      parameters:
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/pageSize'
      - description: ID of the ReviewProcess.
        in: path
        name: review_process_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectPaginatedList'
          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 Project items
      tags:
      - ReviewProcess
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /review/items:
    get:
      description: List Review items.
      operationId: Review.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'
      - $ref: '#/components/parameters/reviewableId.anyOf'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewPaginatedList'
          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 Review items
      tags:
      - Review
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /review/{review_id}:
    get:
      description: Get a single Review by ID.
      operationId: Review.Get
      parameters:
      - description: ID of the Review.
        in: path
        name: review_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Review'
          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 Review by ID
      tags:
      - Review
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /review/{review_id}/review-history/items:
    get:
      description: List ReviewChange items.
      operationId: Review.reviewHistory.List
      parameters:
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/pageSize'
      - description: ID of the Review.
        in: path
        name: review_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewChangePaginatedList'
          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 ReviewChange items
      tags:
      - Review
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-oligo:
    post:
      description: Create RnaOligo.
      operationId: RnaOligo.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRnaOligoInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaOligo'
          description: Created
        '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: Create RnaOligo
      tags:
      - RnaOligo
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-oligo-schema:
    post:
      description: Create RnaOligoSchema.
      operationId: RnaOligoSchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRnaOligoSchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaOligoSchema'
          description: Created
        '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: Create RnaOligoSchema
      tags:
      - RnaOligoSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-oligo-schema/items:
    get:
      description: List RnaOligoSchema items.
      operationId: RnaOligoSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaOligoSchemaPaginatedList'
          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 RnaOligoSchema items
      tags:
      - RnaOligoSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-oligo-schema/{rna_oligo_schema_id}:
    get:
      description: Get a single RnaOligoSchema by ID.
      operationId: RnaOligoSchema.Get
      parameters:
      - description: ID of the RnaOligoSchema.
        in: path
        name: rna_oligo_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaOligoSchema'
          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 RnaOligoSchema by ID
      tags:
      - RnaOligoSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update RnaOligoSchema.
      operationId: RnaOligoSchema.Update
      parameters:
      - description: ID of the RnaOligoSchema.
        in: path
        name: rna_oligo_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRnaOligoSchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaOligoSchema'
          description: OK
        '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: Update RnaOligoSchema
      tags:
      - RnaOligoSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-oligo-schema/{rna_oligo_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: RnaOligoSchema.fieldDefinitions.List
      parameters:
      - description: ID of the RnaOligoSchema.
        in: path
        name: rna_oligo_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - RnaOligoSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-oligo-schema/{rna_oligo_schema_id}/fieldsets/items:
    get:
      description: List Fieldset items.
      operationId: RnaOligoSchema.fieldsets.List
      parameters:
      - description: ID of the RnaOligoSchema.
        in: path
        name: rna_oligo_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsetUnpaginatedList'
          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 Fieldset items
      tags:
      - RnaOligoSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-oligo-schema/{rna_oligo_schema_id}:apply-fieldset:
    post:
      description: Apply a fieldset to the schema
      operationId: RnaOligoSchema.ApplyFieldset
      parameters:
      - description: ID of the RnaOligoSchema.
        in: path
        name: rna_oligo_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitySchemaApplyFieldsetInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Apply a fieldset to the schema
      tags:
      - RnaOligoSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-oligo-schema/{rna_oligo_schema_id}:set-field-definitions:
    post:
      description: Set field definitions on the schema
      operationId: RnaOligoSchema.SetFieldDefinitions
      parameters:
      - description: ID of the RnaOligoSchema.
        in: path
        name: rna_oligo_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RnaOligoSchemaSetFieldDefinitionsInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Set field definitions on the schema
      tags:
      - RnaOligoSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-oligo-schema:batch-create:
    post:
      description: Batch create RnaOligoSchema synchronously in one transaction. Maximum
        25 items per request.
      operationId: RnaOligoSchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateRnaOligoSchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/RnaOligoSchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create RnaOligoSchema
      tags:
      - RnaOligoSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /rna-oligo-schema:batch-update:
    patch:
      description: Batch update RnaOligoSchema synchronously in one transaction. Maximum
        25 items per request.
      operationId: RnaOligoSchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateRnaOligoSchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/RnaOligoSchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update RnaOligoSchema
      tags:
      - RnaOligoSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /rna-oligo-schema:bulk-create:
    post:
      description: Bulk create RnaOligoSchema.
      operationId: RnaOligoSchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create RnaOligoSchema
      tags:
      - RnaOligoSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /rna-oligo-schema:bulk-update:
    patch:
      description: Bulk update RnaOligoSchema.
      operationId: RnaOligoSchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update RnaOligoSchema
      tags:
      - RnaOligoSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /rna-oligo/items:
    get:
      description: List RnaOligo items.
      operationId: RnaOligo.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/authors.anyOf'
      - $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/fieldset.anyOf'
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/mentionedIn.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/project.eq'
      - $ref: '#/components/parameters/registry.eq'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/schema.anyOf'
      - $ref: '#/components/parameters/schema.eq'
      - $ref: '#/components/parameters/systemCategory.anyOf'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaOligoPaginatedList'
          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 RnaOligo items
      tags:
      - RnaOligo
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-oligo/{rna_oligo_id}:
    get:
      description: Get a single RnaOligo by ID.
      operationId: RnaOligo.Get
      parameters:
      - description: ID of the RnaOligo.
        in: path
        name: rna_oligo_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaOligo'
          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 RnaOligo by ID
      tags:
      - RnaOligo
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update RnaOligo.
      operationId: RnaOligo.Update
      parameters:
      - description: ID of the RnaOligo.
        in: path
        name: rna_oligo_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRnaOligoInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaOligo'
          description: OK
        '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: Update RnaOligo
      tags:
      - RnaOligo
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-oligo/{rna_oligo_id}/authors/items:
    get:
      description: List Principal items.
      operationId: RnaOligo.authors.List
      parameters:
      - description: ID of the RnaOligo.
        in: path
        name: rna_oligo_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - RnaOligo
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-oligo/{rna_oligo_id}/modified-nucleotides/items:
    get:
      description: List ModifiedNucleotide items.
      operationId: RnaOligo.modifiedNucleotides.List
      parameters:
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/pageSize'
      - description: ID of the RnaOligo.
        in: path
        name: rna_oligo_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifiedNucleotidePaginatedList'
          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 ModifiedNucleotide items
      tags:
      - RnaOligo
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-oligo:batch-create:
    post:
      description: Batch create RnaOligo synchronously in one transaction. Maximum
        25 items per request.
      operationId: RnaOligo.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateRnaOligoInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/RnaOligo'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create RnaOligo
      tags:
      - RnaOligo
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /rna-oligo:batch-update:
    patch:
      description: Batch update RnaOligo synchronously in one transaction. Maximum
        25 items per request.
      operationId: RnaOligo.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateRnaOligoInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/RnaOligo'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update RnaOligo
      tags:
      - RnaOligo
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /rna-oligo:bulk-create:
    post:
      description: Bulk create RnaOligo.
      operationId: RnaOligo.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create RnaOligo
      tags:
      - RnaOligo
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /rna-oligo:bulk-update:
    patch:
      description: Bulk update RnaOligo.
      operationId: RnaOligo.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update RnaOligo
      tags:
      - RnaOligo
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /rna-sequence:
    post:
      description: Create RnaSequence.
      operationId: RnaSequence.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRnaSequenceInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaSequence'
          description: Created
        '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: Create RnaSequence
      tags:
      - RnaSequence
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-sequence-schema:
    post:
      description: Create RnaSequenceSchema.
      operationId: RnaSequenceSchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRnaSequenceSchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaSequenceSchema'
          description: Created
        '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: Create RnaSequenceSchema
      tags:
      - RnaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-sequence-schema/items:
    get:
      description: List RnaSequenceSchema items.
      operationId: RnaSequenceSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaSequenceSchemaPaginatedList'
          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 RnaSequenceSchema items
      tags:
      - RnaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-sequence-schema/{rna_sequence_schema_id}:
    get:
      description: Get a single RnaSequenceSchema by ID.
      operationId: RnaSequenceSchema.Get
      parameters:
      - description: ID of the RnaSequenceSchema.
        in: path
        name: rna_sequence_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaSequenceSchema'
          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 RnaSequenceSchema by ID
      tags:
      - RnaSequenceSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update RnaSequenceSchema.
      operationId: RnaSequenceSchema.Update
      parameters:
      - description: ID of the RnaSequenceSchema.
        in: path
        name: rna_sequence_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRnaSequenceSchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaSequenceSchema'
          description: OK
        '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: Update RnaSequenceSchema
      tags:
      - RnaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-sequence-schema/{rna_sequence_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: RnaSequenceSchema.fieldDefinitions.List
      parameters:
      - description: ID of the RnaSequenceSchema.
        in: path
        name: rna_sequence_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - RnaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-sequence-schema/{rna_sequence_schema_id}/fieldsets/items:
    get:
      description: List Fieldset items.
      operationId: RnaSequenceSchema.fieldsets.List
      parameters:
      - description: ID of the RnaSequenceSchema.
        in: path
        name: rna_sequence_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsetUnpaginatedList'
          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 Fieldset items
      tags:
      - RnaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-sequence-schema/{rna_sequence_schema_id}:apply-fieldset:
    post:
      description: Apply a fieldset to the schema
      operationId: RnaSequenceSchema.ApplyFieldset
      parameters:
      - description: ID of the RnaSequenceSchema.
        in: path
        name: rna_sequence_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitySchemaApplyFieldsetInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Apply a fieldset to the schema
      tags:
      - RnaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-sequence-schema/{rna_sequence_schema_id}:set-field-definitions:
    post:
      description: Set field definitions on the schema
      operationId: RnaSequenceSchema.SetFieldDefinitions
      parameters:
      - description: ID of the RnaSequenceSchema.
        in: path
        name: rna_sequence_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RnaSequenceSchemaSetFieldDefinitionsInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Set field definitions on the schema
      tags:
      - RnaSequenceSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-sequence-schema:batch-create:
    post:
      description: Batch create RnaSequenceSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: RnaSequenceSchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateRnaSequenceSchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/RnaSequenceSchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create RnaSequenceSchema
      tags:
      - RnaSequenceSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /rna-sequence-schema:batch-update:
    patch:
      description: Batch update RnaSequenceSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: RnaSequenceSchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateRnaSequenceSchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/RnaSequenceSchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update RnaSequenceSchema
      tags:
      - RnaSequenceSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /rna-sequence-schema:bulk-create:
    post:
      description: Bulk create RnaSequenceSchema.
      operationId: RnaSequenceSchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create RnaSequenceSchema
      tags:
      - RnaSequenceSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /rna-sequence-schema:bulk-update:
    patch:
      description: Bulk update RnaSequenceSchema.
      operationId: RnaSequenceSchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update RnaSequenceSchema
      tags:
      - RnaSequenceSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /rna-sequence/items:
    get:
      description: List RnaSequence items.
      operationId: RnaSequence.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/authors.anyOf'
      - $ref: '#/components/parameters/bases.anyOf'
      - $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/fieldset.anyOf'
      - $ref: '#/components/parameters/id.anyOf'
      - $ref: '#/components/parameters/mentionedIn.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/project.eq'
      - $ref: '#/components/parameters/registry.eq'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/schema.anyOf'
      - $ref: '#/components/parameters/schema.eq'
      - $ref: '#/components/parameters/systemCategory.anyOf'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaSequencePaginatedList'
          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 RnaSequence items
      tags:
      - RnaSequence
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-sequence/{rna_sequence_id}:
    get:
      description: Get a single RnaSequence by ID.
      operationId: RnaSequence.Get
      parameters:
      - description: ID of the RnaSequence.
        in: path
        name: rna_sequence_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaSequence'
          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 RnaSequence by ID
      tags:
      - RnaSequence
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update RnaSequence.
      operationId: RnaSequence.Update
      parameters:
      - description: ID of the RnaSequence.
        in: path
        name: rna_sequence_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRnaSequenceInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaSequence'
          description: OK
        '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: Update RnaSequence
      tags:
      - RnaSequence
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-sequence/{rna_sequence_id}/authors/items:
    get:
      description: List Principal items.
      operationId: RnaSequence.authors.List
      parameters:
      - description: ID of the RnaSequence.
        in: path
        name: rna_sequence_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - RnaSequence
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-sequence/{rna_sequence_id}/modified-nucleotides/items:
    get:
      description: List ModifiedNucleotide items.
      operationId: RnaSequence.modifiedNucleotides.List
      parameters:
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/pageSize'
      - description: ID of the RnaSequence.
        in: path
        name: rna_sequence_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifiedNucleotidePaginatedList'
          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 ModifiedNucleotide items
      tags:
      - RnaSequence
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-sequence/{rna_sequence_id}/parts/items:
    get:
      description: List RnaPart items.
      operationId: RnaSequence.parts.List
      parameters:
      - description: ID of the RnaSequence.
        in: path
        name: rna_sequence_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RnaPartUnpaginatedList'
          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 RnaPart items
      tags:
      - RnaSequence
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /rna-sequence:batch-create:
    post:
      description: Batch create RnaSequence synchronously in one transaction. Maximum
        25 items per request.
      operationId: RnaSequence.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateRnaSequenceInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/RnaSequence'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create RnaSequence
      tags:
      - RnaSequence
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /rna-sequence:batch-update:
    patch:
      description: Batch update RnaSequence synchronously in one transaction. Maximum
        25 items per request.
      operationId: RnaSequence.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateRnaSequenceInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/RnaSequence'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update RnaSequence
      tags:
      - RnaSequence
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /rna-sequence:bulk-create:
    post:
      description: Bulk create RnaSequence.
      operationId: RnaSequence.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create RnaSequence
      tags:
      - RnaSequence
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /rna-sequence:bulk-update:
    patch:
      description: Bulk update RnaSequence.
      operationId: RnaSequence.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update RnaSequence
      tags:
      - RnaSequence
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /run-schema/items:
    get:
      description: List RunSchema items.
      operationId: RunSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunSchemaPaginatedList'
          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 RunSchema items
      tags:
      - RunSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /run-schema/{run_schema_id}:
    get:
      description: Get a single RunSchema by ID.
      operationId: RunSchema.Get
      parameters:
      - description: ID of the RunSchema.
        in: path
        name: run_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunSchema'
          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 RunSchema by ID
      tags:
      - RunSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /run-schema/{run_schema_id}/automation-input-file-configs/items:
    get:
      description: List AutomationInputFileConfig items.
      operationId: RunSchema.automationInputFileConfigs.List
      parameters:
      - description: ID of the RunSchema.
        in: path
        name: run_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationInputFileConfigUnpaginatedList'
          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 AutomationInputFileConfig items
      tags:
      - RunSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /run-schema/{run_schema_id}/automation-output-file-configs/items:
    get:
      description: List AutomationOutputFileConfig items.
      operationId: RunSchema.automationOutputFileConfigs.List
      parameters:
      - description: ID of the RunSchema.
        in: path
        name: run_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationOutputFileConfigUnpaginatedList'
          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 AutomationOutputFileConfig items
      tags:
      - RunSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /run-schema/{run_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: RunSchema.fieldDefinitions.List
      parameters:
      - description: ID of the RunSchema.
        in: path
        name: run_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - RunSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /run/items:
    get:
      description: List Run items.
      operationId: Run.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/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/returning'
      - $ref: '#/components/parameters/schema.anyOf'
      - $ref: '#/components/parameters/schema.eq'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunPaginatedList'
          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 Run items
      tags:
      - Run
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /run/{run_id}:
    get:
      description: Get a single Run by ID.
      operationId: Run.Get
      parameters:
      - description: ID of the Run.
        in: path
        name: run_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Run'
          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 Run by ID
      tags:
      - Run
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /scratch-file:
    post:
      description: Create ScratchFile.
      operationId: ScratchFile.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateScratchFileInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScratchFile'
          description: Created
        '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: Create ScratchFile
      tags:
      - ScratchFile
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /scratch-file/items:
    get:
      description: List ScratchFile items.
      operationId: ScratchFile.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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScratchFilePaginatedList'
          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 ScratchFile items
      tags:
      - ScratchFile
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /scratch-file/{scratch_file_id}:
    get:
      description: Get a single ScratchFile by ID.
      operationId: ScratchFile.Get
      parameters:
      - description: ID of the ScratchFile.
        in: path
        name: scratch_file_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScratchFile'
          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 ScratchFile by ID
      tags:
      - ScratchFile
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update ScratchFile.
      operationId: ScratchFile.Update
      parameters:
      - description: ID of the ScratchFile.
        in: path
        name: scratch_file_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateScratchFileInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScratchFile'
          description: OK
        '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: Update ScratchFile
      tags:
      - ScratchFile
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /scratch-file:batch-create:
    post:
      description: Batch create ScratchFile synchronously in one transaction. Maximum
        25 items per request.
      operationId: ScratchFile.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateScratchFileInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/ScratchFile'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create ScratchFile
      tags:
      - ScratchFile
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /scratch-file:batch-update:
    patch:
      description: Batch update ScratchFile synchronously in one transaction. Maximum
        25 items per request.
      operationId: ScratchFile.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateScratchFileInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/ScratchFile'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update ScratchFile
      tags:
      - ScratchFile
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /scratch-file:bulk-create:
    post:
      description: Bulk create ScratchFile.
      operationId: ScratchFile.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create ScratchFile
      tags:
      - ScratchFile
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /scratch-file:bulk-update:
    patch:
      description: Bulk update ScratchFile.
      operationId: ScratchFile.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update ScratchFile
      tags:
      - ScratchFile
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /scratch-file:create-and-upload:
    post:
      description: Create a ScratchFile from either uploaded contents or an existing
        S3 location. Provide exactly one of `contents` (with a `filename`, up to 10
        MiB of UTF-8 sent as an `application/json` body) or `s3Location` (the filename
        is derived from the location when omitted).
      operationId: ScratchFile.CreateAndUpload
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAndUploadScratchFileInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScratchFile'
          description: OK
        '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: Create a ScratchFile from either uploaded contents or an existing S3
        location. Provide exactly one of `contents` (with a `filename`, up to 10 MiB
        of UTF-8 sent as an `application/json` body) or `s3Location` (the filename
        is derived from the location when omitted).
      tags:
      - ScratchFile
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /scratch-plate:
    post:
      description: 'Create one or more ScratchPlates. Three creation modes are supported:


        **From scratch**: Provide `name`, `height`, `width`, and any layer fields
        (`wells`, `concentrationLayers`, `metadataLayers`, etc.).


        **From a design template**: Provide `plateDesignTemplateId` to clone a plate
        design. `height` and `width` default to the design''s dimensions. Omitting
        a layer field preserves the design''s layer; supplying an explicit empty list
        removes it.'
      operationId: ScratchPlate.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateScratchPlateInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScratchPlate'
          description: Created
        '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: Create ScratchPlate
      tags:
      - ScratchPlate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /scratch-plate/items:
    get:
      description: List ScratchPlate items.
      operationId: ScratchPlate.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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScratchPlatePaginatedList'
          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 ScratchPlate items
      tags:
      - ScratchPlate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /scratch-plate/{scratch_plate_id}:
    get:
      description: Get a single ScratchPlate by ID.
      operationId: ScratchPlate.Get
      parameters:
      - description: ID of the ScratchPlate.
        in: path
        name: scratch_plate_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScratchPlate'
          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 ScratchPlate by ID
      tags:
      - ScratchPlate
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update ScratchPlate.
      operationId: ScratchPlate.Update
      parameters:
      - description: ID of the ScratchPlate.
        in: path
        name: scratch_plate_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateScratchPlateInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScratchPlate'
          description: OK
        '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: Update ScratchPlate
      tags:
      - ScratchPlate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /scratch-plate:batch-create:
    post:
      description: Batch create ScratchPlate synchronously in one transaction. Maximum
        25 items per request.
      operationId: ScratchPlate.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateScratchPlateInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/ScratchPlate'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create ScratchPlate
      tags:
      - ScratchPlate
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /scratch-plate:batch-update:
    patch:
      description: Batch update ScratchPlate synchronously in one transaction. Maximum
        25 items per request.
      operationId: ScratchPlate.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateScratchPlateInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/ScratchPlate'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update ScratchPlate
      tags:
      - ScratchPlate
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /scratch-plate:bulk-create:
    post:
      description: 'Bulk create ScratchPlates asynchronously from an uploaded JSONL
        file.


        Rows use the same field requirements as single create. Semantic/reference
        validation is row-isolated via connector validation, but two caveats apply:

        - `vendorFile` / `plateReaderAsm` parse failures occur during create execution
        and can fail the whole chunk (up to batch size), not just one row.

        - Malformed input rows fail at parse/deserialization time before connector
        row validation.'
      operationId: ScratchPlate.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create ScratchPlate
      tags:
      - ScratchPlate
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /scratch-plate:bulk-put-in-inventory:
    post:
      description: 'Create a registry plate from each scratch plate, populating wells
        from the scratch plate''s label and content layers and any column mappings.
        Each item targets a plate schema (explicit or inherited from the scratch plate),
        an inventory location, and an optional project. The new plates are added to
        inventory and the original scratch plates are left unchanged.


        The scratch file must be a JSONL file where each line is a JSON object with
        the following structure:


        {"request_id": "unique-id-per-row", "input_object": {}}


        The input_object fields (all camelCase) are:

        - scratchPlateId (required): ID of the scratch plate to convert.

        - plateSchemaId: ID of the plate schema for the new inventory plate. If omitted,
        resolved from the scratch plate''s own plateSchemaId; fails if neither is
        set.

        - name: Name for the new inventory plate. Defaults to the scratch plate''s
        name.

        - barcode: Barcode assignment. Either {"barcodeMode": "USE_NAME", "useNameAsBarcode":
        true} or {"barcodeMode": "SPECIFY_BARCODE", "barcode": "barcode-value"}.

        - sourceId: API ID of the source entity to associate with the new plate.

        - parentStorableId: API ID of the storage location to place the new plate
        into.

        - columnMappings: List of {layerName, columnName, schemaFieldName} objects
        mapping scratch plate layer columns onto container-schema fields.

        - studyIds: List of study IDs to associate with the new plate.'
      operationId: ScratchPlate.BulkPutInInventory
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: 'Create a registry plate from each scratch plate, populating wells
        from the scratch plate''s label and content layers and any column mappings.
        Each item targets a plate schema (explicit or inherited from the scratch plate),
        an inventory location, and an optional project. The new plates are added to
        inventory and the original scratch plates are left unchanged.


        The scratch file must be a JSONL file where each line is a JSON object with
        the following structure:


        {"request_id": "unique-id-per-row", "input_object": {}}


        The input_object fields (all camelCase) are:

        - scratchPlateId (required): ID of the scratch plate to convert.

        - plateSchemaId: ID of the plate schema for the new inventory plate. If omitted,
        resolved from the scratch plate''s own plateSchemaId; fails if neither is
        set.

        - name: Name for the new inventory plate. Defaults to the scratch plate''s
        name.

        - barcode: Barcode assignment. Either {"barcodeMode": "USE_NAME", "useNameAsBarcode":
        true} or {"barcodeMode": "SPECIFY_BARCODE", "barcode": "barcode-value"}.

        - sourceId: API ID of the source entity to associate with the new plate.

        - parentStorableId: API ID of the storage location to place the new plate
        into.

        - columnMappings: List of {layerName, columnName, schemaFieldName} objects
        mapping scratch plate layer columns onto container-schema fields.

        - studyIds: List of study IDs to associate with the new plate.'
      tags:
      - ScratchPlate
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /scratch-plate:bulk-update:
    patch:
      description: Bulk update ScratchPlate.
      operationId: ScratchPlate.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update ScratchPlate
      tags:
      - ScratchPlate
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /scratch-plate:transfer:
    post:
      description: Create destination scratch plate(s) by transferring content out
        of existing source plates. Each move is recorded as a destination_transfer
        on the child and a source_transfer on the source. The source plates are historical
        records and are never rewritten; instead the result also carries a copy of
        each source holding what remained after the transfer, which is empty when
        any drawn-from well could not say how much it had left.
      operationId: ScratchPlate.Transfer
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScratchPlateTransferRequestInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferScratchPlatesResult'
          description: OK
        '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: Create destination scratch plate(s) by transferring content out of
        existing source plates. Each move is recorded as a destination_transfer on
        the child and a source_transfer on the source. The source plates are historical
        records and are never rewritten; instead the result also carries a copy of
        each source holding what remained after the transfer, which is empty when
        any drawn-from well could not say how much it had left.
      tags:
      - ScratchPlate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /scratch-plate:transfer-async:
    post:
      description: Asynchronously create destination scratch plate(s) by transferring
        content out of existing source plates, alongside a copy of each source holding
        what remained.
      operationId: ScratchPlate.TransferAsync
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScratchPlateTransferRequestInput'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Asynchronously create destination scratch plate(s) by transferring
        content out of existing source plates, alongside a copy of each source holding
        what remained.
      tags:
      - ScratchPlate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /search:
    post:
      description: 'Search across Benchling objects that the caller has permission
        to view. Results can span multiple object types, and each hit includes the
        object''s V3 representation in `source`.

        ## Consistency

        Search result matching is eventually consistent: queries and filters are evaluated
        against an asynchronously updated search index, so recent changes may not
        immediately affect which objects match.

        After identifying matches from the index, the endpoint loads their current
        V3 representations into `source`. This provides up-to-date object details,
        although recently changed fields may differ from the indexed values used for
        matching. Objects that have since been deleted or become inaccessible because
        of permission changes are omitted.'
      operationId: Search.Search.SyncCustom
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            examples:
              global_free_text_search:
                summary: Global text search, sorted by relevance
                value:
                  query: expression plasmid
              global_free_text_search_with_returning:
                summary: Global text search with selected fields
                value:
                  query: expression plasmid
                  returning:
                  - name
                  - createdAt
                  - modifiedAt
                  - creator
                  - folder
              schema_field_search:
                summary: Filter by schema-defined fields
                value:
                  filters:
                    schemaFields:
                      tsf_abc123:
                        eq: Active
                      tsf_def456:
                        gte: 10
                        lt: 20
                  objectTypes:
                  - CustomEntity
              targeted_search:
                summary: Scoped search with filters
                value:
                  filters:
                    createdAt:
                      gte: '2026-01-01T00:00:00Z'
                    creator:
                      anyOf:
                      - usr_abc123
                  objectTypes:
                  - Entry
                  - DnaSequence
                  - Protein
                  pageSize: 20
                  query: expression plasmid
                  sort: modifiedAt:desc
            schema:
              additionalProperties: false
              properties:
                filters:
                  additionalProperties: false
                  description: 'Structured filters applied to narrow the matching
                    result set. Field names match the query parameters on per-entity
                    List endpoints, and each field maps to an object of operators.
                    Each standard filter key''s description lists the objectTypes
                    that support it.

                    The special `schemaFields` key filters by schema-defined field
                    values, see the field''s description for more information.

                    All filters are implicitly ANDed together. Archived objects are
                    excluded unless an `archived` filter is provided.'
                  example:
                    createdAt:
                      gte: '2025-09-15T05:22:30Z'
                    schemaFields:
                      tsf_abc123:
                        eq: PD-L1
                  properties:
                    aminoAcids:
                      additionalProperties: false
                      description: 'Supported objectTypes: AaSequence.'
                      minProperties: 1
                      properties:
                        anyOf:
                          description: Restricts results to those whose sequence exactly
                            matches any of the specified amino acid sequences (case-insensitive).
                          items:
                            type: string
                          maxItems: 100
                          type: array
                      type: object
                    archived:
                      additionalProperties: false
                      description: 'Supported objectTypes: AaSequence, Analysis, AnalysisTemplate,
                        Assembly, Box, Container, CustomEntity, DnaOligo, DnaSequence,
                        Entry, File, Folder, Location, MatrixPlate, OligoConjugate,
                        OligoDuplex, PlateDesignTemplate, Procedure, Protein, RequestV2Definition,
                        RequestV2Submission, RnaOligo, RnaSequence, Study, TestDefinition,
                        WellPlate, WorkflowTaskGroup, Worksheet.'
                      minProperties: 1
                      properties:
                        anyOf:
                          description: If true, returns archived items. If false,
                            returns unarchived items. If both true and false, returns
                            archived and unarchived items.
                          items:
                            type: boolean
                          maxItems: 2
                          type: array
                      type: object
                    authors:
                      additionalProperties: false
                      description: 'Supported objectTypes: AaSequence, CustomEntity,
                        DnaOligo, DnaSequence, Entry, Protein, RnaOligo, RnaSequence.'
                      minProperties: 1
                      properties:
                        anyOf:
                          description: Restricts results to those whose author matches
                            any of the specified user or author IDs.
                          items:
                            type: string
                          maxItems: 100
                          type: array
                      type: object
                    barcode:
                      additionalProperties: false
                      description: 'Supported objectTypes: Box, Container, Location,
                        MatrixPlate, WellPlate.'
                      minProperties: 1
                      properties:
                        anyOf:
                          description: Restricts results to those matching any of
                            the specified barcodes. Fails and reports any invalid
                            barcodes.
                          items:
                            type: string
                          maxItems: 100
                          type: array
                      type: object
                    bases:
                      additionalProperties: false
                      description: 'Supported objectTypes: DnaSequence, RnaSequence.'
                      minProperties: 1
                      properties:
                        anyOf:
                          description: Restricts results to those whose sequence exactly
                            matches any of the specified DNA base sequences (case-insensitive,
                            accounting for circular and reverse complement).
                          items:
                            type: string
                          maxItems: 100
                          type: array
                      type: object
                    createdAt:
                      additionalProperties: false
                      description: 'Supported objectTypes: AaSequence, Analysis, AnalysisTemplate,
                        AppSession, Assembly, Box, Container, CustomEntity, DnaOligo,
                        DnaSequence, Entry, FeatureLibrary, File, Location, MatrixPlate,
                        NucleotideAlignment, OligoConjugate, OligoDuplex, PlateDesignTemplate,
                        Procedure, Protein, RequestV2Definition, RequestV2Submission,
                        RnaOligo, RnaSequence, Study, Team, TestDefinition, WellPlate,
                        WorkflowTaskGroup, Worklist, Worksheet.'
                      minProperties: 1
                      properties:
                        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.
                          format: datetime
                          type: string
                        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.
                          format: datetime
                          type: string
                        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.
                          format: datetime
                          type: string
                        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.
                          format: datetime
                          type: string
                      type: object
                    creator:
                      additionalProperties: false
                      description: 'Supported objectTypes: AaSequence, AnalysisTemplate,
                        Box, Container, CustomEntity, DnaOligo, DnaSequence, Entry,
                        Location, MatrixPlate, OligoConjugate, OligoDuplex, Procedure,
                        Protein, RnaOligo, RnaSequence, TestDefinition, WellPlate,
                        Worksheet.'
                      minProperties: 1
                      properties:
                        anyOf:
                          description: Restricts results to those created by any of
                            the specified user IDs.
                          items:
                            type: string
                          maxItems: 100
                          type: array
                      type: object
                    fieldset:
                      additionalProperties: false
                      description: 'Supported objectTypes: AaSequence, CustomEntity,
                        DnaOligo, DnaSequence, Protein, RnaOligo, RnaSequence.'
                      minProperties: 1
                      properties:
                        anyOf:
                          description: Restricts results to those whose schema implements
                            any of the specified fieldset API IDs (custom schema interfaces).
                          items:
                            type: string
                          maxItems: 100
                          type: array
                      type: object
                    id:
                      additionalProperties: false
                      description: 'Supported objectTypes: AaSequence, Analysis, AnalysisTemplate,
                        AppSession, Assembly, Box, Container, CustomEntity, DnaOligo,
                        DnaSequence, Entry, FeatureLibrary, File, Folder, Location,
                        MatrixPlate, NucleotideAlignment, OligoConjugate, OligoDuplex,
                        PlateDesignTemplate, Procedure, Protein, RequestV2Definition,
                        RequestV2Submission, RnaOligo, RnaSequence, Study, Team, TestDefinition,
                        User, WellPlate, WorkflowTaskGroup, Worklist, Worksheet.'
                      minProperties: 1
                      properties:
                        anyOf:
                          description: Restricts results to those matching any of
                            the specified IDs.
                          items:
                            type: string
                          maxItems: 100
                          type: array
                      type: object
                    mentionedIn:
                      additionalProperties: false
                      description: 'Supported objectTypes: AaSequence, Box, Container,
                        CustomEntity, DnaOligo, DnaSequence, Entry, Location, Protein,
                        RnaOligo, RnaSequence.'
                      minProperties: 1
                      properties:
                        anyOf:
                          description: Restricts results to items mentioned in entries
                            matching any of the specified entry IDs.
                          items:
                            type: string
                          maxItems: 100
                          type: array
                      type: object
                    modifiedAt:
                      additionalProperties: false
                      description: 'Supported objectTypes: AaSequence, Analysis, AnalysisTemplate,
                        AppSession, Assembly, Box, Container, CustomEntity, DnaOligo,
                        DnaSequence, Entry, FeatureLibrary, File, Folder, Location,
                        MatrixPlate, NucleotideAlignment, OligoConjugate, OligoDuplex,
                        PlateDesignTemplate, Procedure, Protein, RequestV2Definition,
                        RequestV2Submission, RnaOligo, RnaSequence, Study, Team, TestDefinition,
                        User, WellPlate, WorkflowTaskGroup, Worklist, Worksheet.'
                      minProperties: 1
                      properties:
                        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.
                          format: datetime
                          type: string
                        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.
                          format: datetime
                          type: string
                        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.
                          format: datetime
                          type: string
                        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.
                          format: datetime
                          type: string
                      type: object
                    name:
                      additionalProperties: false
                      description: 'Supported objectTypes: AaSequence, Analysis, AnalysisTemplate,
                        Assembly, Box, Container, CustomEntity, DnaOligo, DnaSequence,
                        Entry, File, Folder, Location, MatrixPlate, NucleotideAlignment,
                        OligoConjugate, OligoDuplex, Procedure, Protein, RequestV2Definition,
                        RequestV2Submission, RnaOligo, RnaSequence, Study, Team, TestDefinition,
                        User, WellPlate, Worklist, Worksheet.'
                      minProperties: 1
                      properties:
                        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.
                          items:
                            type: string
                          maxItems: 100
                          type: array
                        caseSensitive:
                          default: false
                          description: Restricts results to those that match any of
                            the specified names. Case sensitive. Ensure only one name
                            filter is used at a time.
                          type: boolean
                      type: object
                    parent:
                      additionalProperties: false
                      description: 'Supported objectTypes: Folder.'
                      minProperties: 1
                      properties:
                        eq:
                          description: ID of a folder. Restricts results to its direct
                            children.
                          type: string
                      type: object
                    parentStorage:
                      additionalProperties: false
                      description: 'Supported objectTypes: Box, Container, Location,
                        MatrixPlate, WellPlate.'
                      minProperties: 1
                      properties:
                        eq:
                          description: ID of a location. Restricts results to those
                            located in the specified inventory.
                          type: string
                      type: object
                    project:
                      additionalProperties: false
                      description: 'Supported objectTypes: AaSequence, CustomEntity,
                        DnaOligo, DnaSequence, Folder, OligoConjugate, OligoDuplex,
                        Protein, RnaOligo, RnaSequence.'
                      minProperties: 1
                      properties:
                        eq:
                          description: ID of a project. Restricts results to those
                            in the project.
                          type: string
                      type: object
                    registry:
                      additionalProperties: false
                      description: 'Supported objectTypes: AaSequence, CustomEntity,
                        DnaOligo, DnaSequence, Protein, RnaOligo, RnaSequence.'
                      minProperties: 1
                      properties:
                        eq:
                          description: ID of a registry. Restricts results to those
                            registered in this registry. Specifying "null" returns
                            unregistered items.
                          type: string
                      type: object
                    schema:
                      additionalProperties: false
                      description: 'Supported objectTypes: AaSequence, Box, CustomEntity,
                        DnaOligo, DnaSequence, Entry, Location, Protein, RnaOligo,
                        RnaSequence.'
                      minProperties: 1
                      properties:
                        anyOf:
                          description: Restricts results to those that match any of
                            the specified schema IDs. Use only one `schema` filter
                            arg at a time.
                          items:
                            type: string
                          maxItems: 100
                          type: array
                        eq:
                          description: Single schema ID. Restricts results to those
                            that match the specified schema exactly. Use only one
                            `schema` filter arg at a time.
                          type: string
                      type: object
                    schemaFields:
                      additionalProperties:
                        anyOf:
                        - additionalProperties: true
                          description: Operators supported by text and long text schema
                            fields. Matching is case-insensitive.
                          example:
                            eq: PD-L1
                          minProperties: 1
                          properties:
                            anyOf:
                              description: Match any of the specified values.
                              oneOf:
                              - type: string
                              - items:
                                  type: string
                                minItems: 1
                                type: array
                            eq:
                              description: Match the value exactly.
                              type: string
                            excludes:
                              description: Exclude values containing any of the specified
                                text.
                              oneOf:
                              - type: string
                              - items:
                                  type: string
                                minItems: 1
                                type: array
                            includes:
                              description: Match values containing any of the specified
                                text.
                              oneOf:
                              - type: string
                              - items:
                                  type: string
                                minItems: 1
                                type: array
                            isEmpty:
                              const: true
                              description: Match fields with no value. The operand
                                must be `true`.
                              type: boolean
                            isNotEmpty:
                              const: true
                              description: Match fields with a value. The operand
                                must be `true`.
                              type: boolean
                            noneOf:
                              description: Exclude all of the specified values.
                              oneOf:
                              - type: string
                              - items:
                                  type: string
                                minItems: 1
                                type: array
                            not:
                              description: Exclude an exact value.
                              type: string
                            startsWith:
                              description: Match values beginning with any of the
                                specified text.
                              oneOf:
                              - type: string
                              - items:
                                  type: string
                                minItems: 1
                                type: array
                          title: Text or long text field
                          type: object
                        - additionalProperties: true
                          description: Operators supported by integer schema fields.
                          example:
                            gte: 1
                            lt: 10
                          minProperties: 1
                          properties:
                            anyOf:
                              description: Match any of the specified values.
                              items:
                                type: integer
                              minItems: 1
                              type: array
                            eq:
                              description: Match the specified value.
                              type: integer
                            gt:
                              description: Match values greater than the operand.
                              type: integer
                            gte:
                              description: Match values greater than or equal to the
                                operand.
                              type: integer
                            isEmpty:
                              const: true
                              description: Match fields with no value. The operand
                                must be `true`.
                              type: boolean
                            isNotEmpty:
                              const: true
                              description: Match fields with a value. The operand
                                must be `true`.
                              type: boolean
                            lt:
                              description: Match values less than the operand.
                              type: integer
                            lte:
                              description: Match values less than or equal to the
                                operand.
                              type: integer
                            noneOf:
                              description: Exclude all of the specified values.
                              items:
                                type: integer
                              minItems: 1
                              type: array
                          title: Integer field
                          type: object
                        - additionalProperties: true
                          description: Operators supported by decimal schema fields.
                            Numeric strings are accepted to preserve decimal precision.
                          example:
                            gte: 0.1
                            lt: 1.0
                          minProperties: 1
                          properties:
                            anyOf:
                              description: Match any of the specified values.
                              items:
                                oneOf:
                                - type: number
                                - type: string
                              minItems: 1
                              type: array
                            eq:
                              description: Match the specified value.
                              oneOf:
                              - type: number
                              - type: string
                            gt:
                              description: Match values greater than the operand.
                              oneOf:
                              - type: number
                              - type: string
                            gte:
                              description: Match values greater than or equal to the
                                operand.
                              oneOf:
                              - type: number
                              - type: string
                            isEmpty:
                              const: true
                              description: Match fields with no value. The operand
                                must be `true`.
                              type: boolean
                            isNotEmpty:
                              const: true
                              description: Match fields with a value. The operand
                                must be `true`.
                              type: boolean
                            lt:
                              description: Match values less than the operand.
                              oneOf:
                              - type: number
                              - type: string
                            lte:
                              description: Match values less than or equal to the
                                operand.
                              oneOf:
                              - type: number
                              - type: string
                            noneOf:
                              description: Exclude all of the specified values.
                              items:
                                oneOf:
                                - type: number
                                - type: string
                              minItems: 1
                              type: array
                          title: Decimal field
                          type: object
                        - additionalProperties: true
                          description: Operators supported by date schema fields.
                            Dates use RFC 3339 full-date format (`YYYY-MM-DD`).
                          example:
                            gte: '2026-01-01'
                            lt: '2026-02-01'
                          minProperties: 1
                          properties:
                            anyOf:
                              description: Match any of the specified dates.
                              items:
                                format: date
                                type: string
                              minItems: 1
                              type: array
                            eq:
                              description: Match the specified date.
                              format: date
                              type: string
                            gt:
                              description: Match dates after the operand.
                              format: date
                              type: string
                            gte:
                              description: Match dates on or after the operand.
                              format: date
                              type: string
                            isEmpty:
                              const: true
                              description: Match fields with no value. The operand
                                must be `true`.
                              type: boolean
                            isNotEmpty:
                              const: true
                              description: Match fields with a value. The operand
                                must be `true`.
                              type: boolean
                            lt:
                              description: Match dates before the operand.
                              format: date
                              type: string
                            lte:
                              description: Match dates on or before the operand.
                              format: date
                              type: string
                            noneOf:
                              description: Exclude all of the specified dates.
                              items:
                                format: date
                                type: string
                              minItems: 1
                              type: array
                          title: Date field
                          type: object
                        - additionalProperties: true
                          description: Operators supported by datetime schema fields.
                            Datetimes use RFC 3339 format; a datetime without an offset
                            is interpreted as UTC.
                          example:
                            gte: '2026-01-01T00:00:00Z'
                          minProperties: 1
                          properties:
                            anyOf:
                              description: Match any of the specified datetimes.
                              items:
                                format: date-time
                                type: string
                              minItems: 1
                              type: array
                            eq:
                              description: Match the specified datetime.
                              format: date-time
                              type: string
                            gt:
                              description: Match datetimes after the operand.
                              format: date-time
                              type: string
                            gte:
                              description: Match datetimes on or after the operand.
                              format: date-time
                              type: string
                            isEmpty:
                              const: true
                              description: Match fields with no value. The operand
                                must be `true`.
                              type: boolean
                            isNotEmpty:
                              const: true
                              description: Match fields with a value. The operand
                                must be `true`.
                              type: boolean
                            lt:
                              description: Match datetimes before the operand.
                              format: date-time
                              type: string
                            lte:
                              description: Match datetimes on or before the operand.
                              format: date-time
                              type: string
                            noneOf:
                              description: Exclude all of the specified datetimes.
                              items:
                                format: date-time
                                type: string
                              minItems: 1
                              type: array
                          title: Datetime field
                          type: object
                        - additionalProperties: true
                          description: Operators supported by boolean schema fields.
                          example:
                            eq: true
                          minProperties: 1
                          properties:
                            eq:
                              description: Match fields equal to the operand.
                              type: boolean
                            isEmpty:
                              const: true
                              description: Match fields with no value. The operand
                                must be `true`.
                              type: boolean
                            isNotEmpty:
                              const: true
                              description: Match fields with a value. The operand
                                must be `true`.
                              type: boolean
                          title: Boolean field
                          type: object
                        - additionalProperties: true
                          description: Operators supported by link and dropdown schema
                            fields. Operands are API IDs of linked objects or dropdown
                            options.
                          example:
                            anyOf:
                            - bfi_abc123
                            - bfi_def456
                          minProperties: 1
                          properties:
                            allOf:
                              description: Match fields containing all of the specified
                                IDs.
                              items:
                                type: string
                              minItems: 1
                              type: array
                            anyOf:
                              description: Match fields containing any of the specified
                                IDs.
                              items:
                                type: string
                              minItems: 1
                              type: array
                            isEmpty:
                              const: true
                              description: Match fields with no value. The operand
                                must be `true`.
                              type: boolean
                            isNotEmpty:
                              const: true
                              description: Match fields with a value. The operand
                                must be `true`.
                              type: boolean
                            noneOf:
                              description: Match fields containing none of the specified
                                IDs.
                              items:
                                type: string
                              minItems: 1
                              type: array
                          title: Link or dropdown field
                          type: object
                      description: 'Filter by schema-defined field values. Keys are
                        schema field API IDs (`tsf_...`), and values are objects mapping
                        operators to operands. The supported operators and operand
                        types depend on the schema field''s type. Multiple operators
                        on the same field are implicitly ANDed.

                        Find schema field IDs in the owning schema''s `fieldDefinitions`.
                        All field IDs in one request must belong to the same schema,
                        and that schema must map to a searchable object type. If `objectTypes`
                        is omitted, the search is automatically restricted to that
                        object type. If `objectTypes` is provided, requesting any
                        other type returns a 400. Invalid or inaccessible field IDs
                        also return a 400.'
                      propertyNames:
                        pattern: ^tsf_
                      type: object
                    sequenceIds:
                      additionalProperties: false
                      description: 'Supported objectTypes: NucleotideAlignment.'
                      minProperties: 1
                      properties:
                        anyOf:
                          description: Restricts results to Nucleotide Alignments
                            owned by any of the specified sequence IDs (i.e. sequences
                            used as the template in a Template Alignment or created
                            as the consensus sequence from a Consensus Alignment).
                            Fails and reports any invalid IDs.
                          items:
                            type: string
                          maxItems: 100
                          type: array
                      type: object
                    systemCategory:
                      additionalProperties: false
                      description: 'Supported objectTypes: AaSequence, CustomEntity,
                        DnaOligo, DnaSequence, Protein, RnaOligo, RnaSequence.'
                      minProperties: 1
                      properties:
                        anyOf:
                          description: Restricts results to those whose schema implements
                            any of the specified system category API IDs (non-exclusive
                            static schema interfaces).
                          items:
                            type: string
                          maxItems: 100
                          type: array
                      type: object
                  type: object
                nextToken:
                  description: Opaque pagination token returned by the previous response.
                    Use it with otherwise identical request parameters.
                  type: string
                objectTypes:
                  description: 'Restrict results to one or more object types, using
                    PascalCase names.

                    If omitted or empty, the search includes every searchable object
                    type compatible with all provided filters. A `schemaFields` filter
                    restricts the search to the object type associated with the fields''
                    schema. The request is rejected with a 400 if no searchable type
                    supports the complete filter combination.

                    When a non-empty list is provided, every requested type must be
                    compatible with every provided filter; otherwise the request is
                    rejected with a 400. When `schemaFields` is provided, only the
                    object type associated with the fields'' schema can be requested.

                    Whether explicitly provided or automatically determined, the set
                    of types that were searched is returned in the `searchedObjectTypes`
                    field of the response.'
                  example:
                  - AaSequence
                  - Entry
                  items:
                    enum:
                    - AaSequence
                    - Analysis
                    - AnalysisTemplate
                    - AppSession
                    - Assembly
                    - Box
                    - Container
                    - CustomEntity
                    - DnaOligo
                    - DnaSequence
                    - Entry
                    - FeatureLibrary
                    - File
                    - Folder
                    - Location
                    - MatrixPlate
                    - NucleotideAlignment
                    - OligoConjugate
                    - OligoDuplex
                    - PlateDesignTemplate
                    - Procedure
                    - Protein
                    - RequestV2Definition
                    - RequestV2Submission
                    - RnaOligo
                    - RnaSequence
                    - Study
                    - Team
                    - TestDefinition
                    - User
                    - WellPlate
                    - WorkflowTaskGroup
                    - Worklist
                    - Worksheet
                    type: string
                  type: array
                omit:
                  description: 'Top-level fields to omit from each hit''s `source`.
                    Use the same public field names as V3 Get/List responses. Cannot
                    overlap with `returning`.

                    Because search results can span multiple object types, a field
                    is accepted if it exists on at least one searched type. Omitting
                    a field that does not exist on a given hit''s type has no effect
                    on that hit.'
                  example:
                  - createdAt
                  - modifiedAt
                  items:
                    type: string
                  type: array
                pageSize:
                  default: 50
                  description: Number of results per page. Defaults to 50, max 100.
                  maximum: 100
                  minimum: 1
                  type: integer
                query:
                  description: 'Free-text query matched against indexed object names,
                    schema and custom field values, and searchable textual content.
                    Extracted attachment text is included where supported and available.
                    Searchable content varies by object type, and not every field
                    returned in `source` is searchable.

                    All whitespace-separated terms must match. Enclose multiple words
                    in double quotes to search for them as a phrase. Boolean operators,
                    wildcards, and field-qualified terms are not supported.

                    If omitted, returns all accessible items matching the provided
                    filters.'
                  example: expression plasmid
                  type: string
                returning:
                  description: 'Top-level fields to include in each hit''s `source`.
                    Use the same public field names as V3 Get/List responses. Cannot
                    overlap with `omit`.

                    Because search results can span multiple object types, a field
                    is accepted if it exists on at least one searched type. Each hit
                    only includes the selected fields that exist on its own type;
                    selected fields that belong only to other searched types are absent
                    from that hit''s `source`. `id` and `__typename` are always included,
                    matching V3 List/Get.'
                  example:
                  - id
                  - name
                  items:
                    type: string
                  type: array
                sort:
                  description: Sort order for results, in `field:direction` format
                    (same as V3 List endpoint sort params). When omitted, defaults
                    to most-relevant-first if `query` is non-empty, otherwise `modifiedAt:desc`.
                    Providing `sort` overrides relevance ordering.
                  enum:
                  - createdAt:asc
                  - createdAt:desc
                  - modifiedAt:asc
                  - modifiedAt:desc
                  - name:asc
                  - name:desc
                  type: string
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  hits:
                    description: Matching items in the requested or default order.
                    items:
                      properties:
                        apiUrl:
                          description: Absolute URL of the V3 Get endpoint for this
                            item, e.g. `https://{tenant}.benchling.com/api/v3/aa-sequence/prtn_Xk9mP2vQ`.
                          format: uri
                          type: string
                        id:
                          description: ID of the matched item. Same format as the
                            id field on the corresponding V3 entity (e.g. seq_Xk9mP2vQ,
                            mol_Rv3nT8wL).
                          type: string
                        objectType:
                          description: Type of the matched object (e.g. AaSequence,
                            Entry).
                          type: string
                        source:
                          additionalProperties: true
                          description: Current V3 representation of the matched entity.
                            By default this has the same shape as the corresponding
                            V3 Get response. When `returning` or `omit` is provided,
                            only the selected top-level fields for this hit's object
                            type are included, plus `id` and `__typename`. The exact
                            set of fields varies by object type and API version.
                          properties:
                            __typename:
                              type: string
                            id:
                              type: string
                          required:
                          - id
                          - __typename
                          type: object
                      required:
                      - id
                      - objectType
                      - apiUrl
                      - source
                      type: object
                    type: array
                  metadata:
                    properties:
                      queryId:
                        description: Unique identifier for this search request. Include
                          it when contacting Benchling Support about a search.
                        type: string
                      searchedObjectTypes:
                        description: The set of types that were searched, whether
                          explicitly provided in `objectTypes` or automatically determined
                          based on the requested filters.
                        example:
                        - AaSequence
                        - Entry
                        items:
                          type: string
                        type: array
                      totalHits:
                        description: 'Total number of hits matching the query and
                          filters. Returned only on the first

                          page and omitted from responses to requests with a pagination
                          `nextToken`.

                          '
                        properties:
                          relation:
                            description: '`eq` means the count is exact. `gte` means
                              the count is a lower bound because exact counting was
                              skipped for performance.'
                            enum:
                            - eq
                            - gte
                            type: string
                          value:
                            description: Exact count or lower bound, as indicated
                              by `relation`. This can exceed the number of returned
                              hits if an item becomes deleted or inaccessible before
                              its `source` is loaded.
                            type: integer
                        required:
                        - value
                        - relation
                        type: object
                    required:
                    - queryId
                    - searchedObjectTypes
                    type: object
                  nextToken:
                    description: Opaque cursor for fetching the next page. Empty string
                      when there are no more results.
                    type: string
                required:
                - metadata
                - hits
                - nextToken
                type: object
          description: OK
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Search across Benchling objects
      tags:
      - Search
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /service-principal/items:
    get:
      description: List ServicePrincipal items.
      operationId: ServicePrincipal.List
      parameters:
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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: 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:
          - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServicePrincipalPaginatedList'
          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 ServicePrincipal items
      tags:
      - ServicePrincipal
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /service-principal/{service_principal_id}:
    get:
      description: Get a single ServicePrincipal by ID.
      operationId: ServicePrincipal.Get
      parameters:
      - description: ID of the ServicePrincipal.
        in: path
        name: service_principal_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServicePrincipal'
          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 ServicePrincipal by ID
      tags:
      - ServicePrincipal
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /sql-dashboard-block/items:
    get:
      description: List SqlDashboardBlock items.
      operationId: SqlDashboardBlock.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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SqlDashboardBlockPaginatedList'
          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 SqlDashboardBlock items
      tags:
      - SqlDashboardBlock
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /sql-dashboard-block/{sql_dashboard_block_id}:
    get:
      description: Get a single SqlDashboardBlock by ID.
      operationId: SqlDashboardBlock.Get
      parameters:
      - description: ID of the SqlDashboardBlock.
        in: path
        name: sql_dashboard_block_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SqlDashboardBlock'
          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 SqlDashboardBlock by ID
      tags:
      - SqlDashboardBlock
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update SqlDashboardBlock.
      operationId: SqlDashboardBlock.Update
      parameters:
      - description: ID of the SqlDashboardBlock.
        in: path
        name: sql_dashboard_block_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSqlDashboardBlockInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SqlDashboardBlock'
          description: OK
        '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: Update SqlDashboardBlock
      tags:
      - SqlDashboardBlock
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /sql-dashboard-block:batch-update:
    patch:
      description: Batch update SqlDashboardBlock synchronously in one transaction.
        Maximum 25 items per request.
      operationId: SqlDashboardBlock.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateSqlDashboardBlockInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/SqlDashboardBlock'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update SqlDashboardBlock
      tags:
      - SqlDashboardBlock
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /sql-dashboard-block:bulk-update:
    patch:
      description: Bulk update SqlDashboardBlock.
      operationId: SqlDashboardBlock.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update SqlDashboardBlock
      tags:
      - SqlDashboardBlock
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /sql-dashboard/items:
    get:
      description: List SqlDashboard items.
      operationId: SqlDashboard.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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SqlDashboardPaginatedList'
          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 SqlDashboard items
      tags:
      - SqlDashboard
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /sql-dashboard/{sql_dashboard_id}:
    get:
      description: Get a single SqlDashboard by ID.
      operationId: SqlDashboard.Get
      parameters:
      - description: ID of the SqlDashboard.
        in: path
        name: sql_dashboard_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SqlDashboard'
          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 SqlDashboard by ID
      tags:
      - SqlDashboard
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /sql-dashboard/{sql_dashboard_id}/blocks/items:
    get:
      description: List SqlDashboardBlock items.
      operationId: SqlDashboard.blocks.List
      parameters:
      - description: ID of the SqlDashboard.
        in: path
        name: sql_dashboard_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SqlDashboardBlockUnpaginatedList'
          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 SqlDashboardBlock items
      tags:
      - SqlDashboard
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /stage-entry/items:
    get:
      description: List StageEntry items.
      operationId: StageEntry.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/authors.anyOf'
      - $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/mentionedIn.anyOf'
      - $ref: '#/components/parameters/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/returning'
      - $ref: '#/components/parameters/schema.anyOf'
      - $ref: '#/components/parameters/schema.eq'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StageEntryPaginatedList'
          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 StageEntry items
      tags:
      - StageEntry
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /stage-entry/{stage_entry_id}:
    get:
      description: Get a single StageEntry by ID.
      operationId: StageEntry.Get
      parameters:
      - description: ID of the StageEntry.
        in: path
        name: stage_entry_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StageEntry'
          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 StageEntry by ID
      tags:
      - StageEntry
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /stage-entry/{stage_entry_id}/applicable-review-processes/items:
    get:
      description: List ReviewProcess items.
      operationId: StageEntry.applicableReviewProcesses.List
      parameters:
      - description: ID of the StageEntry.
        in: path
        name: stage_entry_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewProcessUnpaginatedList'
          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 ReviewProcess items
      tags:
      - StageEntry
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /stage-entry/{stage_entry_id}/authors/items:
    get:
      description: List Principal items.
      operationId: StageEntry.authors.List
      parameters:
      - description: ID of the StageEntry.
        in: path
        name: stage_entry_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - StageEntry
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /study:
    post:
      description: Create a study. If authorIds is omitted, the study authors default
        to the creator. If authorIds is provided, it must be an array of user or app
        IDs and replaces the default author list for the new study. Passing an empty
        array creates the study without authors. Passing null for authorIds is invalid.
      operationId: Study.Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateStudyInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Study'
          description: Created
        '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: Create Study
      tags:
      - Study
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /study-item-association:
    post:
      description: Create StudyItemAssociation.
      operationId: StudyItemAssociation.Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateStudyItemAssociationInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudyItemAssociation'
          description: Created
        '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: Create StudyItemAssociation
      tags:
      - StudyItemAssociation
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /study-item-association/items:
    get:
      description: List StudyItemAssociation items.
      operationId: StudyItemAssociation.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/item.anyOf'
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/omit'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/study.anyOf'
      - 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudyItemAssociationPaginatedList'
          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 StudyItemAssociation items
      tags:
      - StudyItemAssociation
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /study-item-association/{study_item_association_id}:
    delete:
      description: Delete StudyItemAssociation.
      operationId: StudyItemAssociation.Delete
      parameters:
      - description: ID of the StudyItemAssociation.
        in: path
        name: study_item_association_id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '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: Delete StudyItemAssociation
      tags:
      - StudyItemAssociation
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
    get:
      description: Get a single StudyItemAssociation by ID.
      operationId: StudyItemAssociation.Get
      parameters:
      - description: ID of the StudyItemAssociation.
        in: path
        name: study_item_association_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudyItemAssociation'
          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 StudyItemAssociation by ID
      tags:
      - StudyItemAssociation
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /study-item-association:batch-create:
    post:
      description: Batch create StudyItemAssociation synchronously in one transaction.
        Maximum 25 items per request.
      operationId: StudyItemAssociation.BatchCreate
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateStudyItemAssociationInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/StudyItemAssociation'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create StudyItemAssociation
      tags:
      - StudyItemAssociation
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /study-item-association:batch-delete:
    post:
      description: Batch delete StudyItemAssociation synchronously in one transaction.
        Maximum 25 items per request.
      operationId: StudyItemAssociation.BatchDelete
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/DeleteStudyItemAssociationInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      additionalProperties: false
                      properties:
                        id:
                          type: string
                      required:
                      - id
                      type: object
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch delete StudyItemAssociation
      tags:
      - StudyItemAssociation
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /study-item-association:bulk-create:
    post:
      description: Bulk create StudyItemAssociation.
      operationId: StudyItemAssociation.BulkCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create StudyItemAssociation
      tags:
      - StudyItemAssociation
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /study-schema:
    post:
      description: Create StudySchema.
      operationId: StudySchema.Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateStudySchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudySchema'
          description: Created
        '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: Create StudySchema
      tags:
      - StudySchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /study-schema/items:
    get:
      description: List StudySchema items.
      operationId: StudySchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudySchemaPaginatedList'
          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 StudySchema items
      tags:
      - StudySchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /study-schema/{study_schema_id}:
    get:
      description: Get a single StudySchema by ID.
      operationId: StudySchema.Get
      parameters:
      - description: ID of the StudySchema.
        in: path
        name: study_schema_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudySchema'
          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 StudySchema by ID
      tags:
      - StudySchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update StudySchema.
      operationId: StudySchema.Update
      parameters:
      - description: ID of the StudySchema.
        in: path
        name: study_schema_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateStudySchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudySchema'
          description: OK
        '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: Update StudySchema
      tags:
      - StudySchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /study-schema/{study_schema_id}/entry-templates/items:
    get:
      description: List EntryTemplate items.
      operationId: StudySchema.entryTemplates.List
      parameters:
      - description: ID of the StudySchema.
        in: path
        name: study_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntryTemplateUnpaginatedList'
          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 EntryTemplate items
      tags:
      - StudySchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /study-schema/{study_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: StudySchema.fieldDefinitions.List
      parameters:
      - description: ID of the StudySchema.
        in: path
        name: study_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - StudySchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /study-schema:batch-create:
    post:
      description: Batch create StudySchema synchronously in one transaction. Maximum
        25 items per request.
      operationId: StudySchema.BatchCreate
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateStudySchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/StudySchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create StudySchema
      tags:
      - StudySchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /study-schema:batch-update:
    patch:
      description: Batch update StudySchema synchronously in one transaction. Maximum
        25 items per request.
      operationId: StudySchema.BatchUpdate
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateStudySchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/StudySchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update StudySchema
      tags:
      - StudySchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /study-schema:bulk-create:
    post:
      description: Bulk create StudySchema.
      operationId: StudySchema.BulkCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create StudySchema
      tags:
      - StudySchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /study-schema:bulk-update:
    patch:
      description: Bulk update StudySchema.
      operationId: StudySchema.BulkUpdate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update StudySchema
      tags:
      - StudySchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /study/items:
    get:
      description: List Study items.
      operationId: Study.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudyPaginatedList'
          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 Study items
      tags:
      - Study
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /study/{study_id}:
    get:
      description: Get a single Study by ID.
      operationId: Study.Get
      parameters:
      - description: ID of the Study.
        in: path
        name: study_id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/returning'
      - $ref: '#/components/parameters/omit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Study'
          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 Study by ID
      tags:
      - Study
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update a study. If authorIds is omitted, existing study authors
        are unchanged. If authorIds is provided, it must be an array of user or app
        IDs and replaces the study's current author list. Passing an empty array clears
        all authors. Passing null for authorIds is invalid.
      operationId: Study.Update
      parameters:
      - description: ID of the Study.
        in: path
        name: study_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateStudyInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Study'
          description: OK
        '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: Update Study
      tags:
      - Study
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /study/{study_id}/authors/items:
    get:
      description: List Principal items.
      operationId: Study.authors.List
      parameters:
      - description: ID of the Study.
        in: path
        name: study_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - Study
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /study:batch-create:
    post:
      description: Batch create Study synchronously in one transaction. Maximum 25
        items per request.
      operationId: Study.BatchCreate
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateStudyInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Study'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create Study
      tags:
      - Study
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /study:batch-update:
    patch:
      description: Batch update Study synchronously in one transaction. Maximum 25
        items per request.
      operationId: Study.BatchUpdate
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateStudyInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Study'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Study
      tags:
      - Study
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /study:bulk-create:
    post:
      description: Bulk create Study.
      operationId: Study.BulkCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create Study
      tags:
      - Study
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /study:bulk-update:
    patch:
      description: Bulk update Study.
      operationId: Study.BulkUpdate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Study
      tags:
      - Study
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /tasks/aa-sequence-schema/apply-fieldset/{task_id}:
    get:
      description: Poll status for Apply a fieldset to the schema.
      operationId: AaSequenceSchema.ApplyFieldset.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/EntitySchemaApplyFieldsetOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - AaSequenceSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/aa-sequence-schema/set-field-definitions/{task_id}:
    get:
      description: Poll status for Set field definitions on the schema.
      operationId: AaSequenceSchema.SetFieldDefinitions.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/SchemaSetFieldDefinitionsOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - AaSequenceSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/agents/{task_id}:
    get:
      description: Get an agent task
      operationId: AgentTask.Get
      parameters:
      - in: path
        name: task_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:
              example:
                agent: benchling_deep_research_v1
                artifacts:
                - downloadUrl: https://example.s3.amazonaws.com/result.png?signature=...
                  filename: result.png
                  id: efl_1234
                  mediaType: image/png
                  type: file
                chatId: chtsess_1234
                content:
                - content_type: text/markdown
                  text: These are the findings...
                status: COMPLETED
                taskId: atsk_1234
              schema:
                additionalProperties: false
                properties:
                  agent:
                    description: Present when the task was created with an explicit
                      legacy agent. Omitted for the default unified-agent path.
                    enum:
                    - benchling_deep_research_v1
                    - benchling_ask_v1
                    - benchling_ai_v1
                    type: string
                  artifacts:
                    description: 'Generated image files represented by file blocks
                      in a completed agent

                      response. Omitted while the task is in progress or when the
                      response has no

                      available generated images. Files that are missing or unavailable
                      because of

                      antivirus scanning are omitted.

                      '
                    items:
                      additionalProperties: false
                      properties:
                        downloadUrl:
                          description: 'Short-lived presigned URL valid for at most
                            60 seconds after generation,

                            Request the agent task status again to obtain a fresh
                            URL.

                            '
                          format: uri
                          type: string
                        filename:
                          type: string
                        id:
                          type: string
                        mediaType:
                          type: string
                        type:
                          enum:
                          - file
                          type: string
                      required:
                      - type
                      - id
                      - filename
                      - mediaType
                      - downloadUrl
                      type: object
                    type: array
                  chatId:
                    type: string
                  content:
                    items:
                      oneOf:
                      - additionalProperties: false
                        properties:
                          content_type:
                            description: MIME type of the content.
                            enum:
                            - text/markdown
                            type: string
                          text:
                            type: string
                        required:
                        - text
                        - content_type
                        type: object
                    type: array
                  status:
                    description: Current task status.
                    enum:
                    - NOT_STARTED
                    - ACTIVE
                    - COMPLETED
                    - FAILED
                    type: string
                  taskId:
                    type: string
                required:
                - taskId
                - chatId
                - status
                - content
                type: object
          description: Task status and contents
        '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 an agent task
      tags:
      - Tasks
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/audit-log/export/{task_id}:
    get:
      description: Poll status for Export the full audit log for an object as a CSV
        or PDF file.
      operationId: AuditLog.Export.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/AuditLogExportOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - AuditLog
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/bulk-create-and-register-proteins-and-components/{task_id}:
    get:
      description: 'Get the current status of a bulk-create-and-register-proteins-and-components
        task.

        When a job reaches a `COMPLETED` status, you can call the

        `GET /tasks/bulk-create-and-register-proteins-and-components/{task_id}/results`

        endpoint to fetch task results and errors.


        Task IDs for this endpoint remain queryable for 14 days after the

        job is created.

        After that TTL expires, this endpoint returns 404. Retrieve any status

        and results you need before the task ID expires.

        '
      operationId: BulkCreateAndRegisterProteinsAndComponentsTask.Get
      parameters:
      - in: path
        name: task_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:
                properties:
                  result:
                    properties:
                      hasErrors:
                        example: false
                        type: boolean
                      hasSuccess:
                        example: true
                        type: boolean
                    required:
                    - hasSuccess
                    - hasErrors
                    type: object
                  status:
                    description: "The current status of the task.\n- NOT_STARTED:
                      Task has been created but not yet started.\n- IN_PROGRESS: Task
                      is currently running.\n- COMPLETED: Task finished. Check 'result.hasErrors'
                      to determine if there were validation errors.\n- FAILED: Task
                      encountered an internal error (system failure). This is distinct
                      from user-facing validation errors,\n  which result in a COMPLETED
                      status with hasErrors=true.\n"
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    example: IN_PROGRESS
                    type: string
                  taskId:
                    example: cprotjob:ana_fhlbqd
                    type: string
                required:
                - taskId
                - status
                - result
                type: object
          description: Job status details
        '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 bulk-create-and-register-proteins-and-components task status
      tags:
      - Protein
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/bulk-create-and-register-proteins-and-components/{task_id}/results:
    get:
      description: "Get the results of a completed bulk-create-and-register-proteins-and-components
        task.\n\nThis endpoint returns an identifier for the output dataset, plus
        an optional\npre-signed URL to download the errors file if any inputs failed
        validation.\n\nTask IDs for this endpoint remain queryable for 14 days after
        the\njob is created.\nAfter that TTL expires, this endpoint returns 404. Retrieve
        the dataset\nID and any errors file URL you need before the task ID expires.\n\n**Partial
        Success**: A job can complete with both successful and failed inputs. Always
        check\n`errorsFileUrl` even when `datasetId` is present, since some inputs
        may have been rejected\nwhile others were created successfully.\n\nBehavior:\n-
        Returns 400 unless the task has a COMPLETED status. While a task is running\n
        \ you can poll the\n  `GET /tasks/bulk-create-and-register-proteins-and-components/{task_id}`\n
        \ endpoint first and only call this endpoint once\n  `status == \"COMPLETED\"`.
        If the status becomes FAILED, this endpoint\n  will always return 400.\n-
        If the task is in a COMPLETED status, returns parameters you can\n  use to
        fetch output and error data.  See the descriptions of the output\n  parameters
        for more detail.\n"
      operationId: BulkCreateAndRegisterProteinsAndComponentsResults.Get
      parameters:
      - in: path
        name: task_id
        required: true
        schema:
          example: cprotjob:ana_fhlbqd
          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:
                properties:
                  datasetId:
                    description: "If no proteins were registered, this parameter is
                      absent.\nOtherwise, `datasetId` identifies a Dataset object
                      with the results data.\n\nUse this id with the Datasets API
                      to look up the dataset and fetch\nits rows.  This dataset will
                      be the same one displayed in the Benchling UI\nand referenced
                      in emails about this task.\n\nDataset Columns\n- The results
                      dataset will have an `input` column giving the index\n  of the
                      input protein data associated to this results row.\n- It will
                      have a `protein` column giving the api id\n  of the protein
                      that was registered for that input.\n- It will have a `{label}_aa`
                      and optionally a `{label}_dna` column\n  for each domain label
                      in the format.  The DNA column will only be\n  present if the
                      job registered DNA sequence entities for that format.\n- It
                      will have similar `{label}_dna` and `{label}_aa` columns for\n
                      \ chains that it registered.\n- It will also have `{label1}_{label2}_pair_dna`
                      and\n  `{label1}_{label2}_pair_aa` columns for any registered
                      DNA and AA pairs.\n"
                    example: dataset_abc123
                    type: string
                  errorsFileUrl:
                    description: 'If all inputs were registered successfully, this
                      parameter is absent.

                      Otherwise, it''s a pre-signed S3 URL for downloading the errors
                      CSV.


                      This CSV will have an `Input #` column giving the index of the
                      input

                      to the job associated with one particular protein that failed
                      to

                      be registered. The `Error Message` column gives a description
                      of the

                      error.


                      This file may also contain additional columns for any sequence
                      data

                      that the job attempted to use when it failed to register this

                      particular protein. Those columns will follow the same naming

                      scheme as described above for the Dataset output.

                      '
                    example: https://bucket.s3.amazonaws.com/atsk_123/download?X-Amz-Signature=abc123
                    format: uri
                    type: string
                  taskId:
                    example: cprotjob:ana_fhlbqd
                    type: string
                required:
                - taskId
                type: object
          description: Task results
        '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 bulk-create-and-register-proteins-and-components task results
      tags:
      - Protein
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/bulk-export/{task_id}:
    get:
      description: 'Get the current status of a bulk export task. The response includes
        information about the task''s progress

        and when it completes, provides a URL to download the exported data file.

        '
      operationId: BulkExport.Get
      parameters:
      - in: path
        name: task_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:
                properties:
                  status:
                    enum:
                    - SUCCESS
                    - FAILED
                    - IN_PROGRESS
                    example: SUCCESS
                    type: string
                  statusByModel:
                    additionalProperties:
                      properties:
                        failureReason:
                          example: INTERNAL_ERROR
                          nullable: true
                          type: string
                        status:
                          enum:
                          - SUCCESS
                          - FAILED
                          - IN_PROGRESS
                          example: SUCCESS
                          type: string
                        totalRecordsExported:
                          example: 123
                          nullable: true
                          type: integer
                      required:
                      - status
                      type: object
                    type: object
                  taskId:
                    example: atsk_123
                    type: string
                required:
                - taskId
                - status
                - statusByModel
                type: object
          description: Job status details
        '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 bulk export task status
      tags:
      - Tasks
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/bulk-export/{task_id}/successful-results:
    get:
      description: 'Get the successful results of a completed bulk export task. The
        response includes a URL to download the exported data file.

        '
      operationId: BulkExportResults.Get
      parameters:
      - in: path
        name: task_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:
                properties:
                  manifestFilePreSignedUrls:
                    additionalProperties:
                      example: https://s3.amazonaws.com/bucket/modelA?signature=...
                      format: uri
                      type: string
                    type: object
                  taskId:
                    example: atsk_123
                    type: string
                required:
                - taskId
                - manifestFilePreSignedUrls
                type: object
          description: Job run result
        '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 bulk export task result
      tags:
      - Tasks
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/bulk/{task_id}:
    get:
      description: 'Get the current status of a bulk task. The response includes information
        about the task''s progress

        and status. On SUCCESS, you can retrieve the successful payload for the bulk
        task from

        /tasks/bulk/{task_id}/successful-results. On FAILED, you can additionally
        retrieve

        errors from /tasks/bulk/{task_id}/errors.

        '
      operationId: BulkTask.Get
      parameters:
      - in: path
        name: task_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:
                properties:
                  progress:
                    properties:
                      numberProcessed:
                        example: 4000
                        type: integer
                      totalRecords:
                        example: 10000
                        type: integer
                    required:
                    - totalRecords
                    - numberProcessed
                    type: object
                  result:
                    properties:
                      errorCount:
                        example: 0
                        type: integer
                      successCount:
                        example: 0
                        type: integer
                    required:
                    - successCount
                    - errorCount
                    type: object
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    example: COMPLETED
                    type: string
                  taskId:
                    example: atsk_123
                    type: string
                required:
                - taskId
                - status
                - progress
                - result
                type: object
          description: Job status details
        '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 bulk task status
      tags:
      - Tasks
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/bulk/{task_id}/errors:
    get:
      description: 'Get information about objects with errors of a bulk task. The
        response will include the

        request id, error message, and error code associated with each input object
        in jsonl format.

        '
      operationId: BulkErrors.Get
      parameters:
      - in: path
        name: task_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:
                properties:
                  errors:
                    description: A pre-signed S3 URL for downloading the errors. Null
                      if no errors or if errors are still processing.
                    example: https://bucket.s3.amazonaws.com/atsk_123/download?X-Amz-Signature=abc123
                    oneOf:
                    - type: 'null'
                    - format: uri
                      type: string
                  message:
                    description: A message providing additional context when errors
                      is null.
                    example: No errors found for this bulk task.
                    type: string
                  taskId:
                    example: atsk_123
                    type: string
                required:
                - taskId
                - errors
                type: object
          description: Errors details
        '202':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                required:
                - message
                type: object
          description: Still in progress
        '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 bulk task errors
      tags:
      - Tasks
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/bulk/{task_id}/successful-results:
    get:
      description: 'Get a temporary url to a file containing the result of each bulk
        task. The file will contain at minimum the

        respective request id for each result. The file is in jsonl format.

        '
      operationId: BulkSuccessfulResults.Get
      parameters:
      - in: path
        name: task_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:
                properties:
                  items:
                    description: 'A pre-signed S3 URL for downloading the IDs. The
                      file is a csv with

                      the headers "request_id, id".

                      '
                    example: https://bucket.s3.amazonaws.com/atsk_123/download?X-Amz-Signature=abc123
                    format: uri
                    type: string
                  listingUri:
                    description: A URL linking to the listing endpoint for the downloaded
                      item type.
                    example: https://tenant.com/api/v3/custom-entity/items
                    format: uri
                    type: string
                  taskId:
                    example: atsk_123
                    type: string
                required:
                - taskId
                - items
                - listingUri
                type: object
          description: Successful results details
        '202':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                required:
                - message
                type: object
          description: Still in progress
        '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 bulk task results
      tags:
      - Tasks
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/container/transfer/{task_id}:
    get:
      description: Poll status for Transfer contents from sources into destination
        containers. Each row specifies a destination container and exactly one source
        (container or entity), the quantity to transfer, an optional final quantity
        to dilute the destination to, and an optional source concentration override..
      operationId: Container.Transfer.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/TransferOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - Container
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/custom-entity-schema/apply-fieldset/{task_id}:
    get:
      description: Poll status for Apply a fieldset to the schema.
      operationId: CustomEntitySchema.ApplyFieldset.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/EntitySchemaApplyFieldsetOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - CustomEntitySchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/custom-entity-schema/set-field-definitions/{task_id}:
    get:
      description: Poll status for Set field definitions on the schema.
      operationId: CustomEntitySchema.SetFieldDefinitions.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/SchemaSetFieldDefinitionsOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - CustomEntitySchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/dna-oligo-schema/apply-fieldset/{task_id}:
    get:
      description: Poll status for Apply a fieldset to the schema.
      operationId: DnaOligoSchema.ApplyFieldset.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/EntitySchemaApplyFieldsetOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - DnaOligoSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/dna-oligo-schema/set-field-definitions/{task_id}:
    get:
      description: Poll status for Set field definitions on the schema.
      operationId: DnaOligoSchema.SetFieldDefinitions.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/SchemaSetFieldDefinitionsOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - DnaOligoSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/dna-sequence-schema/apply-fieldset/{task_id}:
    get:
      description: Poll status for Apply a fieldset to the schema.
      operationId: DnaSequenceSchema.ApplyFieldset.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/EntitySchemaApplyFieldsetOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - DnaSequenceSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/dna-sequence-schema/set-field-definitions/{task_id}:
    get:
      description: Poll status for Set field definitions on the schema.
      operationId: DnaSequenceSchema.SetFieldDefinitions.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/SchemaSetFieldDefinitionsOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - DnaSequenceSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/document-export/{task_id}:
    get:
      description: 'Get the current status of a single-item document export task.
        When the export completes

        successfully, the response populates a `downloadUrl` where the result can
        be downloaded.

        The download URL is usable for a limited time after completion.

        '
      operationId: DocumentExport.Get
      parameters:
      - in: path
        name: task_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:
                properties:
                  downloadUrl:
                    description: 'Link to download the exported file. Populated only
                      when `status` is

                      `COMPLETED`; `null` otherwise.

                      '
                    example: https://example.benchling.com/api/v3/tasks/document-export/3f152353-7593-48bc-8049-962890d1be84/download
                    type:
                    - string
                    - 'null'
                  message:
                    example: Export completed successfully
                    type: string
                  status:
                    description: '- NOT_STARTED: Task has been created but not yet
                      started.

                      - IN_PROGRESS: Task is currently running.

                      - COMPLETED: Export finished successfully; `downloadUrl` is
                      populated.

                      - FAILED: Export encountered an error.

                      '
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    example: COMPLETED
                    type: string
                required:
                - status
                - message
                type: object
          description: Export task status
        '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 document export task status
      tags:
      - DocumentExport
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/document-export/{task_id}/download:
    get:
      description: 'Redirects (303) to a presigned URL to download the exported file.
        Returns 404 if no

        completed export is available for the task.

        '
      operationId: DocumentExportDownload.Get
      parameters:
      - in: path
        name: task_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:
        '303':
          content:
            application/json: {}
          description: 'Redirect to a short-lived presigned download URL via the `Location`
            header. The

            response body is empty.

            '
          headers:
            Location:
              description: The presigned URL to download the exported file from.
              schema:
                type: string
        '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: Download a completed document export
      tags:
      - DocumentExport
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/equipment-schema/apply-fieldset/{task_id}:
    get:
      description: Poll status for Apply a fieldset to the schema.
      operationId: EquipmentSchema.ApplyFieldset.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/EntitySchemaApplyFieldsetOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - EquipmentSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/equipment-schema/set-field-definitions/{task_id}:
    get:
      description: Poll status for Set field definitions on the schema.
      operationId: EquipmentSchema.SetFieldDefinitions.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/SchemaSetFieldDefinitionsOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - EquipmentSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/fieldset/set-field-definitions/{task_id}:
    get:
      description: Poll status for Set field definitions on the fieldset.
      operationId: Fieldset.SetFieldDefinitions.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/SchemaSetFieldDefinitionsOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - Fieldset
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/mixture-schema/apply-fieldset/{task_id}:
    get:
      description: Poll status for Apply a fieldset to the schema.
      operationId: MixtureSchema.ApplyFieldset.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/EntitySchemaApplyFieldsetOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - MixtureSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/mixture-schema/set-field-definitions/{task_id}:
    get:
      description: Poll status for Set field definitions on the schema.
      operationId: MixtureSchema.SetFieldDefinitions.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/SchemaSetFieldDefinitionsOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - MixtureSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/molecule-schema/apply-fieldset/{task_id}:
    get:
      description: Poll status for Apply a fieldset to the schema.
      operationId: MoleculeSchema.ApplyFieldset.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/EntitySchemaApplyFieldsetOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - MoleculeSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/molecule-schema/set-field-definitions/{task_id}:
    get:
      description: Poll status for Set field definitions on the schema.
      operationId: MoleculeSchema.SetFieldDefinitions.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/SchemaSetFieldDefinitionsOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - MoleculeSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/nucleotide-alignment/create-consensus-alignment/{task_id}:
    get:
      description: Poll status for Create a consensus nucleotide alignment.
      operationId: NucleotideAlignment.CreateConsensusAlignment.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/NucleotideAlignment'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - NucleotideAlignment
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/nucleotide-alignment/create-template-alignment/{task_id}:
    get:
      description: Poll status for Create a template nucleotide alignment.
      operationId: NucleotideAlignment.CreateTemplateAlignment.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/NucleotideAlignment'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - NucleotideAlignment
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/oligo-conjugate-schema/apply-fieldset/{task_id}:
    get:
      description: Poll status for Apply a fieldset to the schema.
      operationId: OligoConjugateSchema.ApplyFieldset.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/EntitySchemaApplyFieldsetOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - OligoConjugateSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/oligo-conjugate-schema/set-field-definitions/{task_id}:
    get:
      description: Poll status for Set field definitions on the schema.
      operationId: OligoConjugateSchema.SetFieldDefinitions.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/SchemaSetFieldDefinitionsOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - OligoConjugateSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/oligo-duplex-schema/apply-fieldset/{task_id}:
    get:
      description: Poll status for Apply a fieldset to the schema.
      operationId: OligoDuplexSchema.ApplyFieldset.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/EntitySchemaApplyFieldsetOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - OligoDuplexSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/oligo-duplex-schema/set-field-definitions/{task_id}:
    get:
      description: Poll status for Set field definitions on the schema.
      operationId: OligoDuplexSchema.SetFieldDefinitions.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/SchemaSetFieldDefinitionsOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - OligoDuplexSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/procedure-run-plan/promote/{task_id}:
    get:
      description: Poll status for Turn procedure run plans into active procedure
        runs. Plans must not already be converted. Returns an async task — poll the
        task endpoint for completion and the created procedure run IDs.
      operationId: ProcedureRunPlan.Promote.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/PromoteProcedureRunPlanOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - ProcedureRunPlan
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/protein-schema/apply-fieldset/{task_id}:
    get:
      description: Poll status for Apply a fieldset to the schema.
      operationId: ProteinSchema.ApplyFieldset.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/EntitySchemaApplyFieldsetOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - ProteinSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/protein-schema/set-field-definitions/{task_id}:
    get:
      description: Poll status for Set field definitions on the schema.
      operationId: ProteinSchema.SetFieldDefinitions.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/SchemaSetFieldDefinitionsOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - ProteinSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/rna-oligo-schema/apply-fieldset/{task_id}:
    get:
      description: Poll status for Apply a fieldset to the schema.
      operationId: RnaOligoSchema.ApplyFieldset.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/EntitySchemaApplyFieldsetOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - RnaOligoSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/rna-oligo-schema/set-field-definitions/{task_id}:
    get:
      description: Poll status for Set field definitions on the schema.
      operationId: RnaOligoSchema.SetFieldDefinitions.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/SchemaSetFieldDefinitionsOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - RnaOligoSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/rna-sequence-schema/apply-fieldset/{task_id}:
    get:
      description: Poll status for Apply a fieldset to the schema.
      operationId: RnaSequenceSchema.ApplyFieldset.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/EntitySchemaApplyFieldsetOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - RnaSequenceSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/rna-sequence-schema/set-field-definitions/{task_id}:
    get:
      description: Poll status for Set field definitions on the schema.
      operationId: RnaSequenceSchema.SetFieldDefinitions.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/SchemaSetFieldDefinitionsOutput'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - RnaSequenceSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /tasks/scratch-plate/transfer-async/{task_id}:
    get:
      description: Poll status for Asynchronously create destination scratch plate(s)
        by transferring content out of existing source plates, alongside a copy of
        each source holding what remained..
      operationId: ScratchPlate.TransferAsync.Get
      parameters:
      - description: ID of the asynchronous task to poll.
        in: path
        name: task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  result:
                    oneOf:
                    - $ref: '#/components/schemas/TransferScratchPlatesResult'
                    - type: 'null'
                  status:
                    enum:
                    - NOT_STARTED
                    - IN_PROGRESS
                    - COMPLETED
                    - FAILED
                    type: string
                type: object
          description: OK
        '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: Poll async task status
      tags:
      - ScratchPlate
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /team/items:
    get:
      description: List Team items.
      operationId: Team.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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TeamPaginatedList'
          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 Team items
      tags:
      - Team
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /team/{team_id}:
    get:
      description: Get a single Team by ID.
      operationId: Team.Get
      parameters:
      - description: ID of the Team.
        in: path
        name: team_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Team'
          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 Team by ID
      tags:
      - Team
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /team/{team_id}/memberships/items:
    get:
      description: List GroupMembership items.
      operationId: Team.memberships.List
      parameters:
      - description: ID of the Team.
        in: path
        name: team_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupMembershipUnpaginatedList'
          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 GroupMembership items
      tags:
      - Team
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /template-collection/items:
    get:
      description: List TemplateCollection items.
      operationId: TemplateCollection.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateCollectionPaginatedList'
          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 TemplateCollection items
      tags:
      - TemplateCollection
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /template-collection/{template_collection_id}:
    get:
      description: Get a single TemplateCollection by ID.
      operationId: TemplateCollection.Get
      parameters:
      - description: ID of the TemplateCollection.
        in: path
        name: template_collection_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateCollection'
          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 TemplateCollection by ID
      tags:
      - TemplateCollection
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /template-collection/{template_collection_id}/items/items:
    get:
      description: List TemplateCollectible items.
      operationId: TemplateCollection.items.List
      parameters:
      - description: ID of the TemplateCollection.
        in: path
        name: template_collection_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateCollectibleUnpaginatedList'
          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 TemplateCollectible items
      tags:
      - TemplateCollection
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /test-definition:
    post:
      description: 'Create a Test Definition that can be referenced by Test Orders
        and assay workflows.


        ## Required fields


        | Field | Description |

        | --- | --- |

        | `name` | Display name. Names are trimmed and must be unique within `organizationId`.
        |

        | `organizationId` | Owning organization. Use `GET /benchling/organization/items`
        to find organization IDs. |

        | `resultSchemaId` | Result schema that defines the measurements captured
        by this test. Use `GET /benchling/result-schema/items` to find result schema
        IDs. |

        | `description` | Human-readable description. Empty strings are allowed. |


        ## Notes


        - The creator is set automatically from the authenticated user or app.

        - The caller must have admin access to the organization and read access to
        the result schema.

        - `name` and `description` must each be at most 255 characters.'
      operationId: TestDefinition.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTestDefinitionInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestDefinition'
          description: Created
        '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: Create TestDefinition
      tags:
      - TestDefinition
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /test-definition/items:
    get:
      description: List TestDefinition items.
      operationId: TestDefinition.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestDefinitionPaginatedList'
          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 TestDefinition items
      tags:
      - TestDefinition
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /test-definition/{test_definition_id}:
    get:
      description: Get a single TestDefinition by ID.
      operationId: TestDefinition.Get
      parameters:
      - description: ID of the TestDefinition.
        in: path
        name: test_definition_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestDefinition'
          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 TestDefinition by ID
      tags:
      - TestDefinition
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: 'Update an existing Test Definition.


        ## Updatable fields


        | Field | Description |

        | --- | --- |

        | `name` | New display name. Names are trimmed and must be unique within the
        organization. |

        | `organizationId` | New owning organization. Use `GET /benchling/organization/items`
        to find organization IDs. |

        | `resultSchemaId` | New result schema. Use `GET /benchling/result-schema/items`
        to find result schema IDs. |

        | `description` | New description. Empty strings are allowed. |

        | `archived`, `archiveReason`, `archiveUserId` | Archive or unarchive the
        test definition. |


        ## Constraints


        - The caller must be able to read the target organization and result schema.

        - `resultSchemaId` cannot be changed after any Test Orders exist for the Test
        Definition.

        - Archiving fails if the Test Definition has pending, in-progress, or blocked
        Test Orders.

        - Archiving also fails while the Test Definition is associated with an unarchived
        assay.

        - `archiveSubtreeId` and `legacyArchiveRecordId` are legacy archival fields
        and should normally be omitted.'
      operationId: TestDefinition.Update
      parameters:
      - description: ID of the TestDefinition.
        in: path
        name: test_definition_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTestDefinitionInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestDefinition'
          description: OK
        '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: Update TestDefinition
      tags:
      - TestDefinition
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /test-definition:batch-create:
    post:
      description: 'Batch create Test Definitions synchronously in one transaction.
        Maximum 25 items per request.


        Each item follows the same field requirements as the single-create endpoint.
        If any item fails validation, the transaction fails and no Test Definitions
        are created.'
      operationId: TestDefinition.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateTestDefinitionInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/TestDefinition'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create TestDefinition
      tags:
      - TestDefinition
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /test-definition:batch-update:
    patch:
      description: 'Batch update Test Definitions synchronously in one transaction.
        Maximum 25 items per request.


        Each item follows the same field requirements and archive constraints as the
        single-update endpoint. If any item fails validation, the transaction fails
        and no Test Definitions are updated.'
      operationId: TestDefinition.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateTestDefinitionInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/TestDefinition'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update TestDefinition
      tags:
      - TestDefinition
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /test-definition:bulk-create:
    post:
      description: 'Bulk create Test Definitions asynchronously from an uploaded file.


        Each row follows the same field requirements as the single-create endpoint.
        The response returns an async task; poll the task to inspect row-level successes
        and validation errors.'
      operationId: TestDefinition.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create TestDefinition
      tags:
      - TestDefinition
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /test-definition:bulk-update:
    patch:
      description: 'Bulk update Test Definitions asynchronously from an uploaded file.


        Each row follows the same field requirements and archive constraints as the
        single-update endpoint. The response returns an async task; poll the task
        to inspect row-level successes and validation errors.'
      operationId: TestDefinition.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update TestDefinition
      tags:
      - TestDefinition
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /test-order/items:
    get:
      description: List TestOrder items.
      operationId: TestOrder.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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestOrderPaginatedList'
          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 TestOrder items
      tags:
      - TestOrder
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /test-order/{test_order_id}:
    get:
      description: Get a single TestOrder by ID.
      operationId: TestOrder.Get
      parameters:
      - description: ID of the TestOrder.
        in: path
        name: test_order_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestOrder'
          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 TestOrder by ID
      tags:
      - TestOrder
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /unit:
    post:
      description: Create Unit.
      operationId: Unit.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUnitInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unit'
          description: Created
        '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: Create Unit
      tags:
      - Unit
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /unit-type:
    post:
      description: Create UnitType.
      operationId: UnitType.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUnitTypeInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnitType'
          description: Created
        '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: Create UnitType
      tags:
      - UnitType
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /unit-type/items:
    get:
      description: List UnitType items.
      operationId: UnitType.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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnitTypePaginatedList'
          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 UnitType items
      tags:
      - UnitType
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /unit-type/{unit_type_id}:
    get:
      description: Get a single UnitType by ID.
      operationId: UnitType.Get
      parameters:
      - description: ID of the UnitType.
        in: path
        name: unit_type_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnitType'
          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 UnitType by ID
      tags:
      - UnitType
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update UnitType.
      operationId: UnitType.Update
      parameters:
      - description: ID of the UnitType.
        in: path
        name: unit_type_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUnitTypeInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnitType'
          description: OK
        '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: Update UnitType
      tags:
      - UnitType
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /unit-type/{unit_type_id}/units/items:
    get:
      description: List Unit items.
      operationId: UnitType.units.List
      parameters:
      - description: ID of the UnitType.
        in: path
        name: unit_type_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnitUnpaginatedList'
          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 Unit items
      tags:
      - UnitType
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /unit-type:batch-create:
    post:
      description: Batch create UnitType synchronously in one transaction. Maximum
        25 items per request.
      operationId: UnitType.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateUnitTypeInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/UnitType'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create UnitType
      tags:
      - UnitType
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /unit-type:batch-update:
    patch:
      description: Batch update UnitType synchronously in one transaction. Maximum
        25 items per request.
      operationId: UnitType.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateUnitTypeInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/UnitType'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update UnitType
      tags:
      - UnitType
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /unit-type:bulk-create:
    post:
      description: Bulk create UnitType.
      operationId: UnitType.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create UnitType
      tags:
      - UnitType
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /unit-type:bulk-update:
    patch:
      description: Bulk update UnitType.
      operationId: UnitType.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update UnitType
      tags:
      - UnitType
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /unit/items:
    get:
      description: List Unit items.
      operationId: Unit.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnitPaginatedList'
          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 Unit items
      tags:
      - Unit
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /unit/{unit_id}:
    get:
      description: Get a single Unit by ID.
      operationId: Unit.Get
      parameters:
      - description: ID of the Unit.
        in: path
        name: unit_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unit'
          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 Unit by ID
      tags:
      - Unit
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update Unit.
      operationId: Unit.Update
      parameters:
      - description: ID of the Unit.
        in: path
        name: unit_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUnitInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unit'
          description: OK
        '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: Update Unit
      tags:
      - Unit
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /unit:batch-create:
    post:
      description: Batch create Unit synchronously in one transaction. Maximum 25
        items per request.
      operationId: Unit.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateUnitInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Unit'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create Unit
      tags:
      - Unit
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /unit:batch-update:
    patch:
      description: Batch update Unit synchronously in one transaction. Maximum 25
        items per request.
      operationId: Unit.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateUnitInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Unit'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Unit
      tags:
      - Unit
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /unit:bulk-create:
    post:
      description: Bulk create Unit.
      operationId: Unit.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create Unit
      tags:
      - Unit
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /unit:bulk-update:
    patch:
      description: Bulk update Unit.
      operationId: Unit.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Unit
      tags:
      - Unit
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /user/items:
    get:
      description: List User items.
      operationId: User.List
      parameters:
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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: 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:
          - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPaginatedList'
          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 User items
      tags:
      - User
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /user/{user_id}:
    get:
      description: Get a single User by ID.
      operationId: User.Get
      parameters:
      - description: ID of the User.
        in: path
        name: user_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          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 User by ID
      tags:
      - User
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /warehouse-credential/items:
    get:
      description: List WarehouseCredential items.
      operationId: WarehouseCredential.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/returning'
      - $ref: '#/components/parameters/userId.anyOf'
      - 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WarehouseCredentialPaginatedList'
          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 WarehouseCredential items
      tags:
      - WarehouseCredential
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /warehouse-credential/{warehouse_credential_id}:
    get:
      description: Get a single WarehouseCredential by ID.
      operationId: WarehouseCredential.Get
      parameters:
      - description: ID of the WarehouseCredential.
        in: path
        name: warehouse_credential_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WarehouseCredential'
          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 WarehouseCredential by ID
      tags:
      - WarehouseCredential
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update WarehouseCredential.
      operationId: WarehouseCredential.Update
      parameters:
      - description: ID of the WarehouseCredential.
        in: path
        name: warehouse_credential_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWarehouseCredentialInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WarehouseCredential'
          description: OK
        '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: Update WarehouseCredential
      tags:
      - WarehouseCredential
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /warehouse-credential:batch-update:
    patch:
      description: Batch update WarehouseCredential synchronously in one transaction.
        Maximum 25 items per request.
      operationId: WarehouseCredential.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateWarehouseCredentialInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/WarehouseCredential'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update WarehouseCredential
      tags:
      - WarehouseCredential
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /warehouse-credential:bulk-update:
    patch:
      description: Bulk update WarehouseCredential.
      operationId: WarehouseCredential.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update WarehouseCredential
      tags:
      - WarehouseCredential
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /warehouse-credential:create-warehouse-credential:
    post:
      description: Create a new WarehouseCredential. Generates a username and password,
        provisions the credential in the warehouse, and returns the one-time password.
      operationId: WarehouseCredential.CreateWarehouseCredential
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWarehouseCredentialCustomMethodInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWarehouseCredentialOutput'
          description: OK
        '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: Create a new WarehouseCredential. Generates a username and password,
        provisions the credential in the warehouse, and returns the one-time password.
      tags:
      - WarehouseCredential
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /warehouse-custom-view/items:
    get:
      description: List WarehouseCustomView items.
      operationId: WarehouseCustomView.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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WarehouseCustomViewPaginatedList'
          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 WarehouseCustomView items
      tags:
      - WarehouseCustomView
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /warehouse-custom-view/{warehouse_custom_view_id}:
    get:
      description: Get a single WarehouseCustomView by ID.
      operationId: WarehouseCustomView.Get
      parameters:
      - description: ID of the WarehouseCustomView.
        in: path
        name: warehouse_custom_view_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WarehouseCustomView'
          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 WarehouseCustomView by ID
      tags:
      - WarehouseCustomView
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /well-plate:
    post:
      description: Create WellPlate.
      operationId: WellPlate.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWellPlateInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WellPlate'
          description: Created
        '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: Create WellPlate
      tags:
      - WellPlate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /well-plate-position/items:
    get:
      description: List WellPlatePosition items.
      operationId: WellPlatePosition.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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WellPlatePositionPaginatedList'
          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 WellPlatePosition items
      tags:
      - WellPlatePosition
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /well-plate-position/{well_plate_position_id}:
    get:
      description: Get a single WellPlatePosition by ID.
      operationId: WellPlatePosition.Get
      parameters:
      - description: ID of the WellPlatePosition.
        in: path
        name: well_plate_position_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WellPlatePosition'
          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 WellPlatePosition by ID
      tags:
      - WellPlatePosition
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /well-plate-schema:
    post:
      description: Create WellPlateSchema.
      operationId: WellPlateSchema.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWellPlateSchemaInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WellPlateSchema'
          description: Created
        '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: Create WellPlateSchema
      tags:
      - WellPlateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /well-plate-schema/items:
    get:
      description: List WellPlateSchema items.
      operationId: WellPlateSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WellPlateSchemaPaginatedList'
          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 WellPlateSchema items
      tags:
      - WellPlateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /well-plate-schema/{well_plate_schema_id}:
    get:
      description: Get a single WellPlateSchema by ID.
      operationId: WellPlateSchema.Get
      parameters:
      - description: ID of the WellPlateSchema.
        in: path
        name: well_plate_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WellPlateSchema'
          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 WellPlateSchema by ID
      tags:
      - WellPlateSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update WellPlateSchema.
      operationId: WellPlateSchema.Update
      parameters:
      - description: ID of the WellPlateSchema.
        in: path
        name: well_plate_schema_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWellPlateSchemaInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WellPlateSchema'
          description: OK
        '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: Update WellPlateSchema
      tags:
      - WellPlateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /well-plate-schema/{well_plate_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: WellPlateSchema.fieldDefinitions.List
      parameters:
      - description: ID of the WellPlateSchema.
        in: path
        name: well_plate_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - WellPlateSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /well-plate-schema:batch-create:
    post:
      description: Batch create WellPlateSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: WellPlateSchema.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateWellPlateSchemaInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/WellPlateSchema'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create WellPlateSchema
      tags:
      - WellPlateSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /well-plate-schema:batch-update:
    patch:
      description: Batch update WellPlateSchema synchronously in one transaction.
        Maximum 25 items per request.
      operationId: WellPlateSchema.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateWellPlateSchemaInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/WellPlateSchema'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update WellPlateSchema
      tags:
      - WellPlateSchema
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /well-plate-schema:bulk-create:
    post:
      description: Bulk create WellPlateSchema.
      operationId: WellPlateSchema.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create WellPlateSchema
      tags:
      - WellPlateSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /well-plate-schema:bulk-update:
    patch:
      description: Bulk update WellPlateSchema.
      operationId: WellPlateSchema.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update WellPlateSchema
      tags:
      - WellPlateSchema
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /well-plate/items:
    get:
      description: List WellPlate items.
      operationId: WellPlate.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $ref: '#/components/parameters/barcode.anyOf'
      - $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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/parentStorage.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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WellPlatePaginatedList'
          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 WellPlate items
      tags:
      - WellPlate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /well-plate/{well_plate_id}:
    get:
      description: Get a single WellPlate by ID.
      operationId: WellPlate.Get
      parameters:
      - description: ID of the WellPlate.
        in: path
        name: well_plate_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WellPlate'
          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 WellPlate by ID
      tags:
      - WellPlate
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update WellPlate.
      operationId: WellPlate.Update
      parameters:
      - description: ID of the WellPlate.
        in: path
        name: well_plate_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWellPlateInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WellPlate'
          description: OK
        '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: Update WellPlate
      tags:
      - WellPlate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /well-plate/{well_plate_id}/positions/items:
    get:
      description: List WellPlatePosition items.
      operationId: WellPlate.positions.List
      parameters:
      - description: ID of the WellPlate.
        in: path
        name: well_plate_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WellPlatePositionUnpaginatedList'
          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 WellPlatePosition items
      tags:
      - WellPlate
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /well-plate:batch-create:
    post:
      description: Batch create WellPlate synchronously in one transaction. Maximum
        10 items per request.
      operationId: WellPlate.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateWellPlateInput'
                  maxItems: 10
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/WellPlate'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create WellPlate
      tags:
      - WellPlate
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /well-plate:batch-update:
    patch:
      description: Batch update WellPlate synchronously in one transaction. Maximum
        10 items per request.
      operationId: WellPlate.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateWellPlateInputWithPathParams'
                  maxItems: 10
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/WellPlate'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update WellPlate
      tags:
      - WellPlate
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /well-plate:bulk-create:
    post:
      description: Bulk create WellPlate.
      operationId: WellPlate.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create WellPlate
      tags:
      - WellPlate
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /well-plate:bulk-update:
    patch:
      description: Bulk update WellPlate.
      operationId: WellPlate.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update WellPlate
      tags:
      - WellPlate
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /workflow-output:
    post:
      description: Create WorkflowOutput.
      operationId: WorkflowOutput.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkflowOutputInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowOutput'
          description: Created
        '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: Create WorkflowOutput
      tags:
      - WorkflowOutput
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-output-schema/items:
    get:
      description: List WorkflowOutputSchema items.
      operationId: WorkflowOutputSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowOutputSchemaPaginatedList'
          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 WorkflowOutputSchema items
      tags:
      - WorkflowOutputSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-output-schema/{workflow_output_schema_id}:
    get:
      description: Get a single WorkflowOutputSchema by ID.
      operationId: WorkflowOutputSchema.Get
      parameters:
      - description: ID of the WorkflowOutputSchema.
        in: path
        name: workflow_output_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowOutputSchema'
          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 WorkflowOutputSchema by ID
      tags:
      - WorkflowOutputSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /workflow-output-schema/{workflow_output_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: WorkflowOutputSchema.fieldDefinitions.List
      parameters:
      - description: ID of the WorkflowOutputSchema.
        in: path
        name: workflow_output_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - WorkflowOutputSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-output/items:
    get:
      description: List WorkflowOutput items.
      operationId: WorkflowOutput.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowOutputPaginatedList'
          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 WorkflowOutput items
      tags:
      - WorkflowOutput
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-output/{workflow_output_id}:
    get:
      description: Get a single WorkflowOutput by ID.
      operationId: WorkflowOutput.Get
      parameters:
      - description: ID of the WorkflowOutput.
        in: path
        name: workflow_output_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowOutput'
          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 WorkflowOutput by ID
      tags:
      - WorkflowOutput
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update WorkflowOutput.
      operationId: WorkflowOutput.Update
      parameters:
      - description: ID of the WorkflowOutput.
        in: path
        name: workflow_output_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkflowOutputInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowOutput'
          description: OK
        '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: Update WorkflowOutput
      tags:
      - WorkflowOutput
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-output:batch-create:
    post:
      description: Batch create WorkflowOutput synchronously in one transaction. Maximum
        25 items per request.
      operationId: WorkflowOutput.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateWorkflowOutputInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/WorkflowOutput'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create WorkflowOutput
      tags:
      - WorkflowOutput
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /workflow-output:batch-update:
    patch:
      description: Batch update WorkflowOutput synchronously in one transaction. Maximum
        25 items per request.
      operationId: WorkflowOutput.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateWorkflowOutputInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/WorkflowOutput'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update WorkflowOutput
      tags:
      - WorkflowOutput
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /workflow-output:bulk-create:
    post:
      description: Bulk create WorkflowOutput.
      operationId: WorkflowOutput.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create WorkflowOutput
      tags:
      - WorkflowOutput
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /workflow-output:bulk-update:
    patch:
      description: Bulk update WorkflowOutput.
      operationId: WorkflowOutput.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update WorkflowOutput
      tags:
      - WorkflowOutput
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /workflow-task:
    post:
      description: Create WorkflowTask.
      operationId: WorkflowTask.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkflowTaskInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTask'
          description: Created
        '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: Create WorkflowTask
      tags:
      - WorkflowTask
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-task-group:
    post:
      description: Create WorkflowTaskGroup.
      operationId: WorkflowTaskGroup.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkflowTaskGroupInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTaskGroup'
          description: Created
        '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: Create WorkflowTaskGroup
      tags:
      - WorkflowTaskGroup
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-task-group/items:
    get:
      description: List WorkflowTaskGroup items.
      operationId: WorkflowTaskGroup.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTaskGroupPaginatedList'
          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 WorkflowTaskGroup items
      tags:
      - WorkflowTaskGroup
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-task-group/{workflow_task_group_id}:
    get:
      description: Get a single WorkflowTaskGroup by ID.
      operationId: WorkflowTaskGroup.Get
      parameters:
      - description: ID of the WorkflowTaskGroup.
        in: path
        name: workflow_task_group_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTaskGroup'
          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 WorkflowTaskGroup by ID
      tags:
      - WorkflowTaskGroup
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update WorkflowTaskGroup.
      operationId: WorkflowTaskGroup.Update
      parameters:
      - description: ID of the WorkflowTaskGroup.
        in: path
        name: workflow_task_group_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkflowTaskGroupInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTaskGroup'
          description: OK
        '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: Update WorkflowTaskGroup
      tags:
      - WorkflowTaskGroup
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-task-group/{workflow_task_group_id}/authors/items:
    get:
      description: List Principal items.
      operationId: WorkflowTaskGroup.authors.List
      parameters:
      - description: ID of the WorkflowTaskGroup.
        in: path
        name: workflow_task_group_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - WorkflowTaskGroup
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-task-group/{workflow_task_group_id}/child-workflow-task-groups/items:
    get:
      description: List WorkflowTaskGroup items.
      operationId: WorkflowTaskGroup.childWorkflowTaskGroups.List
      parameters:
      - $ref: '#/components/parameters/nextToken'
      - $ref: '#/components/parameters/pageSize'
      - description: ID of the WorkflowTaskGroup.
        in: path
        name: workflow_task_group_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTaskGroupPaginatedList'
          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 WorkflowTaskGroup items
      tags:
      - WorkflowTaskGroup
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-task-group:batch-create:
    post:
      description: Batch create WorkflowTaskGroup synchronously in one transaction.
        Maximum 25 items per request.
      operationId: WorkflowTaskGroup.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateWorkflowTaskGroupInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/WorkflowTaskGroup'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create WorkflowTaskGroup
      tags:
      - WorkflowTaskGroup
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /workflow-task-group:batch-update:
    patch:
      description: Batch update WorkflowTaskGroup synchronously in one transaction.
        Maximum 25 items per request.
      operationId: WorkflowTaskGroup.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateWorkflowTaskGroupInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/WorkflowTaskGroup'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update WorkflowTaskGroup
      tags:
      - WorkflowTaskGroup
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /workflow-task-group:bulk-create:
    post:
      description: Bulk create WorkflowTaskGroup.
      operationId: WorkflowTaskGroup.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create WorkflowTaskGroup
      tags:
      - WorkflowTaskGroup
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /workflow-task-group:bulk-update:
    patch:
      description: Bulk update WorkflowTaskGroup.
      operationId: WorkflowTaskGroup.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update WorkflowTaskGroup
      tags:
      - WorkflowTaskGroup
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /workflow-task-schema/items:
    get:
      description: List WorkflowTaskSchema items.
      operationId: WorkflowTaskSchema.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTaskSchemaPaginatedList'
          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 WorkflowTaskSchema items
      tags:
      - WorkflowTaskSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-task-schema/{workflow_task_schema_id}:
    get:
      description: Get a single WorkflowTaskSchema by ID.
      operationId: WorkflowTaskSchema.Get
      parameters:
      - description: ID of the WorkflowTaskSchema.
        in: path
        name: workflow_task_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTaskSchema'
          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 WorkflowTaskSchema by ID
      tags:
      - WorkflowTaskSchema
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /workflow-task-schema/{workflow_task_schema_id}/field-definitions/items:
    get:
      description: List SchemaFieldDefinition items.
      operationId: WorkflowTaskSchema.fieldDefinitions.List
      parameters:
      - description: ID of the WorkflowTaskSchema.
        in: path
        name: workflow_task_schema_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList'
          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 SchemaFieldDefinition items
      tags:
      - WorkflowTaskSchema
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-task/items:
    get:
      description: List WorkflowTask items.
      operationId: WorkflowTask.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTaskPaginatedList'
          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 WorkflowTask items
      tags:
      - WorkflowTask
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-task/{workflow_task_id}:
    get:
      description: Get a single WorkflowTask by ID.
      operationId: WorkflowTask.Get
      parameters:
      - description: ID of the WorkflowTask.
        in: path
        name: workflow_task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTask'
          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 WorkflowTask by ID
      tags:
      - WorkflowTask
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update WorkflowTask.
      operationId: WorkflowTask.Update
      parameters:
      - description: ID of the WorkflowTask.
        in: path
        name: workflow_task_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkflowTaskInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTask'
          description: OK
        '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: Update WorkflowTask
      tags:
      - WorkflowTask
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-task/{workflow_task_id}/child-tasks/items:
    get:
      description: List WorkflowTask items.
      operationId: WorkflowTask.childTasks.List
      parameters:
      - description: ID of the WorkflowTask.
        in: path
        name: workflow_task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTaskUnpaginatedList'
          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 WorkflowTask items
      tags:
      - WorkflowTask
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-task/{workflow_task_id}/root-workflow-tasks/items:
    get:
      description: List WorkflowTask items.
      operationId: WorkflowTask.rootWorkflowTasks.List
      parameters:
      - description: ID of the WorkflowTask.
        in: path
        name: workflow_task_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTaskUnpaginatedList'
          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 WorkflowTask items
      tags:
      - WorkflowTask
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /workflow-task:batch-create:
    post:
      description: Batch create WorkflowTask synchronously in one transaction. Maximum
        25 items per request.
      operationId: WorkflowTask.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateWorkflowTaskInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/WorkflowTask'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create WorkflowTask
      tags:
      - WorkflowTask
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /workflow-task:batch-update:
    patch:
      description: Batch update WorkflowTask synchronously in one transaction. Maximum
        25 items per request.
      operationId: WorkflowTask.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateWorkflowTaskInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/WorkflowTask'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update WorkflowTask
      tags:
      - WorkflowTask
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /workflow-task:bulk-create:
    post:
      description: Bulk create WorkflowTask.
      operationId: WorkflowTask.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create WorkflowTask
      tags:
      - WorkflowTask
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /workflow-task:bulk-update:
    patch:
      description: Bulk update WorkflowTask.
      operationId: WorkflowTask.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update WorkflowTask
      tags:
      - WorkflowTask
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /worklist:
    post:
      description: Create Worklist.
      operationId: Worklist.Create
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorklistInput'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Worklist'
          description: Created
        '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: Create Worklist
      tags:
      - Worklist
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /worklist/items:
    get:
      description: List Worklist items.
      operationId: Worklist.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/name.anyOf'
      - $ref: '#/components/parameters/name.anyOf.caseSensitive'
      - $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) 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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorklistPaginatedList'
          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 Worklist items
      tags:
      - Worklist
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /worklist/{worklist_id}:
    delete:
      description: Delete Worklist.
      operationId: Worklist.Delete
      parameters:
      - description: ID of the Worklist.
        in: path
        name: worklist_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: *id001
      responses:
        '204':
          description: No Content
        '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: Delete Worklist
      tags:
      - Worklist
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
    get:
      description: Get a single Worklist by ID.
      operationId: Worklist.Get
      parameters:
      - description: ID of the Worklist.
        in: path
        name: worklist_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Worklist'
          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 Worklist by ID
      tags:
      - Worklist
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
    patch:
      description: Update Worklist.
      operationId: Worklist.Update
      parameters:
      - description: ID of the Worklist.
        in: path
        name: worklist_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: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorklistInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Worklist'
          description: OK
        '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: Update Worklist
      tags:
      - Worklist
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /worklist/{worklist_id}/items/items:
    get:
      description: List Worklistable items.
      operationId: Worklist.items.List
      parameters:
      - description: ID of the Worklist.
        in: path
        name: worklist_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorklistableUnpaginatedList'
          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 Worklistable items
      tags:
      - Worklist
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /worklist:batch-create:
    post:
      description: Batch create Worklist synchronously in one transaction. Maximum
        25 items per request.
      operationId: Worklist.BatchCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/CreateWorklistInput'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '201':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Worklist'
                    type: array
                required:
                - items
                type: object
          description: Created
        '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: Batch create Worklist
      tags:
      - Worklist
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /worklist:batch-delete:
    post:
      description: Batch delete Worklist synchronously in one transaction. Maximum
        25 items per request.
      operationId: Worklist.BatchDelete
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/DeleteWorklistInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      additionalProperties: false
                      properties:
                        id:
                          type: string
                      required:
                      - id
                      type: object
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch delete Worklist
      tags:
      - Worklist
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /worklist:batch-update:
    patch:
      description: Batch update Worklist synchronously in one transaction. Maximum
        25 items per request.
      operationId: Worklist.BatchUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                items:
                  items:
                    $ref: '#/components/schemas/UpdateWorklistInputWithPathParams'
                  maxItems: 25
                  minItems: 1
                  type: array
              required:
              - items
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/Worklist'
                    type: array
                required:
                - items
                type: object
          description: OK
        '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: Batch update Worklist
      tags:
      - Worklist
      - Tier 3 Rate Limit
      x-bnch-rate-limit-tier: 3
  /worklist:bulk-create:
    post:
      description: Bulk create Worklist.
      operationId: Worklist.BulkCreate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk create Worklist
      tags:
      - Worklist
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /worklist:bulk-update:
    patch:
      description: Bulk update Worklist.
      operationId: Worklist.BulkUpdate
      parameters:
      - description: Set to true to access beta operations via /api/v3.
        in: header
        name: EARLY-ACCESS
        required: false
        schema: *id001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImport'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncTaskLink'
          description: Task started
        '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: Bulk update Worklist
      tags:
      - Worklist
      - Tier 2 Rate Limit
      x-bnch-rate-limit-tier: 2
  /worksheet/items:
    get:
      description: List Worksheet items.
      operationId: Worksheet.List
      parameters:
      - $ref: '#/components/parameters/archiveReason.anyOf'
      - $ref: '#/components/parameters/archived.anyOf'
      - $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/modifiedAt.gt'
      - $ref: '#/components/parameters/modifiedAt.gte'
      - $ref: '#/components/parameters/modifiedAt.lt'
      - $ref: '#/components/parameters/modifiedAt.lte'
      - $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/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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorksheetPaginatedList'
          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 Worksheet items
      tags:
      - Worksheet
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /worksheet/{worksheet_id}:
    get:
      description: Get a single Worksheet by ID.
      operationId: Worksheet.Get
      parameters:
      - description: ID of the Worksheet.
        in: path
        name: worksheet_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Worksheet'
          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 Worksheet by ID
      tags:
      - Worksheet
      - Tier 5 Rate Limit
      x-bnch-rate-limit-tier: 5
  /worksheet/{worksheet_id}/applicable-review-processes/items:
    get:
      description: List ReviewProcess items.
      operationId: Worksheet.applicableReviewProcesses.List
      parameters:
      - description: ID of the Worksheet.
        in: path
        name: worksheet_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewProcessUnpaginatedList'
          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 ReviewProcess items
      tags:
      - Worksheet
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
  /worksheet/{worksheet_id}/authors/items:
    get:
      description: List Principal items.
      operationId: Worksheet.authors.List
      parameters:
      - description: ID of the Worksheet.
        in: path
        name: worksheet_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: *id001
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalUnpaginatedList'
          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 Principal items
      tags:
      - Worksheet
      - Tier 4 Rate Limit
      x-bnch-rate-limit-tier: 4
security:
- oAuth: []
- basicApiKeyAuth: []
servers:
- url: /api/v3
tags:
- description: Endpoints for obtaining and managing OAuth2 access tokens.
  name: Authentication
- description: 'Represents an amino acid sequence in Benchling''s molecular biology
    platform. An AaSequence stores the

    one-letter amino acid code string along with annotations marking functional regions,
    domains, or other

    features of interest. `AaSequence`s can be registered in the Registry with a unique
    entityRegistryId,

    organized in folders, and linked via schema fields to other entities. The annotations
    array contains

    `AaAnnotation` objects for features like signal peptides, binding domains, or
    engineered mutations.

    Parts (see `AaPart`) indicate regions matching other registered `AaSequence`s.'
  name: AaSequence
  x-bnch-core-type: AaSequence
  x-bnch-organization: Benchling
- description: Defines the structure, field definitions, and configuration options
    for AA sequences.
  name: AaSequenceSchema
  x-bnch-organization: Benchling
- description: Operations for Analysis
  name: Analysis
  x-bnch-organization: Benchling
- description: 'A reusable pipeline configuration that can be instantiated to create
    new Analysis objects.

    AnalysisTemplates define a complete data processing workflow with PipelineSteps
    (see `steps`)

    that can be parameterized through configVariables (see `AnalysisTemplateVariable`)
    and

    dataFrameVariables (see `AnalysisTemplateDataFrameVariable`). When users apply
    a template,

    they provide values for these variables, generating a new Analysis with the template''s

    pipeline structure populated with actual data. Templates are organized within

    TemplateCollections and support versioning through the createdFromPipeline reference.'
  name: AnalysisTemplate
  x-bnch-organization: Benchling
- description: 'Defines a data frame placeholder within an AnalysisTemplate that users
    must provide when

    applying the template. Each variable specifies which PipelineStep input (replaceStep,

    replaceStepData, replaceStepDataIndex) will receive the user-provided data frame.
    The

    replaceDataFrameColumnsSpec field defines the expected column structure that the
    provided

    data must match. When users apply an analysis template to create an Analysis,
    they provide

    bindings that map actual data frames to these variables, populating the template''s
    pipeline

    with real data.'
  name: AnalysisTemplateDataFrameVariable
  x-bnch-organization: Benchling
- description: 'Defines a configuration parameter within an AnalysisTemplate that
    users can customize when

    applying the template. Unlike AnalysisTemplateDataFrameVariable 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 PipelineStep.'
  name: AnalysisTemplateVariable
  x-bnch-organization: Benchling
- description: 'Represents a Benchling App canvas, an embedded UI surface that apps
    use to render custom

    interactive content within notebook entries, entry templates, assay runs, or app
    homepages.

    Each canvas belongs to a single app and contains a list of UI blocks that define
    the

    canvas layout and interactivity.'
  name: AppCanvas
  x-bnch-organization: Benchling
- description: 'Represents a configured value for a Benchling App on a specific tenant.
    Each config

    value has a path identifying its location in the configuration hierarchy and valueData

    containing the actual value. Config values are defined by the app''s configuration
    spec

    and set during installation or later configuration.'
  name: AppConfigValue
  x-bnch-organization: Benchling
- description: 'Represents an installed Benchling App on a tenant, created from an
    `AppDefinitionVersion`.

    App installations store tenant-specific configuration values and feature bindings.
    As a

    Principal, app installations can be attributed as actors for API operations and
    auditing.'
  name: AppInstallation
  x-bnch-organization: Benchling
- description: 'Represents a running or completed session for a Benchling App. App
    sessions track

    long-running app operations, providing status updates and user-facing messages.

    Each session belongs to a single app installation and progresses through a lifecycle

    from RUNNING to a terminal status. Sessions are updated by appending new versions,

    which can change the status, timeout, and displayed messages.'
  name: AppSession
  x-bnch-organization: Benchling
- description: 'Represents a molecular cloning assembly that combines multiple DNA
    fragments into

    complete constructs. Assemblies model the process of joining fragment sequences

    (such as genes, promoters, and terminators) using methods like Gibson Assembly,

    Golden Gate, or restriction enzyme-based cloning. The assembly tracks the input

    fragments and resulting construct sequences, enabling design-to-experiment traceability.

    Assemblies can be organized in folders and support archiving when no longer needed.'
  name: Assembly
  x-bnch-organization: Benchling
- description: Represents a single entry in an object's audit log. Each entry captures
    what changed, who made the change, and contextual information about the affected
    object hierarchy.
  name: AuditLog
  x-bnch-organization: Benchling
- description: 'A Box is a grid-based storage container in Benchling''s inventory
    system, designed

    to hold multiple sample containers (tubes, vials, etc.) in an organized layout.

    Boxes have a defined capacity based on their schema''s height and width dimensions,

    and track how many positions are occupied, empty, or available. Each box is

    assigned a barcode for physical tracking and must be placed within a Location
    (via

    parentStorage). Boxes conform to a BoxSchema that defines their grid dimensions
    and

    which ContainerSchema their contents must use. Boxes are commonly used to organize

    samples in freezers, refrigerators, or other storage equipment.'
  name: Box
  x-bnch-core-type: Box
  x-bnch-organization: Benchling
- description: 'Defines the structure and constraints for a category of Boxes in Benchling''s
    inventory

    system. A BoxSchema specifies the grid dimensions (height and width) determining
    how

    many container positions the box has, and optionally links to a ContainerSchema
    that

    constrains what type of containers can be stored in boxes of this type. BoxSchemas

    support custom field definitions for capturing additional metadata about boxes.
    Each

    BoxSchema can be associated with a Registry and given a prefix for generating
    display

    IDs. Examples include "96-Well Freezer Box" or "81-Position Cryo Box".'
  name: BoxSchema
  x-bnch-organization: Benchling
- description: 'A Chart is a data visualization within Benchling. Charts can be created
    directly (for example, via APIs or the

    UI) or generated from other workflows. Charts store their configuration in a library-specific
    format (see

    `ChartLibrary`) along with a rasterized image for archival purposes. When applicable,
    charts may reference the

    pipeline step (see `PipelineStep`) or AI chat session (see `ChatSession`) they
    originated from as optional

    provenance links, enabling both programmatic and conversational data visualization
    workflows.'
  name: Chart
  x-bnch-organization: Benchling
- description: 'A Collaboration indicates that a Principal or Group is granted a Policy
    on a Resource.

    Some Collaborations represent Ownership, while others indicate that a Resource
    was shared with the Principal

    or Group.'
  name: Collaboration
  x-bnch-organization: Benchling
- description: 'Records a configuration import operation from one Benchling tenant
    to another. Each entry

    captures the source tenant, target organization, who performed the import, and
    an optional

    changelog URL documenting the changes. This provides an audit trail for configuration

    migrations between tenants.'
  name: ConfigImportHistoryEntry
  x-bnch-organization: Benchling
- description: 'A Container is a physical vessel (such as a tube, vial, or cryotube)
    that holds

    biological or chemical samples in Benchling''s inventory system. Containers track

    their contents (see ContainerContent), quantity, location within storage (via

    parentStorage which can be a Box, Plate, or Location), and lifecycle information

    including expiration and freeze-thaw cycles. Each container has a barcode for

    physical identification and conforms to a ContainerSchema that defines its type

    and schema fields. Containers support checkout tracking (see CheckoutRecord) and

    can be associated with Studies. Also known as "tubes" or "sample containers" in

    laboratory contexts.'
  name: Container
  x-bnch-core-type: Container
  x-bnch-organization: Benchling
- description: 'Defines the structure and metadata for a category of Containers in
    Benchling''s inventory system. A

    `ContainerSchema` specifies the container type (e.g., "1.5mL Microcentrifuge Tube",
    "2mL Cryovial"), custom

    field definitions for capturing container-specific data, and an optional Registry
    association with display ID

    prefix. `ContainerSchema`s are referenced by box and matrix plate schemas to constrain
    what container types

    can be stored in boxes or plates of that type, and by fixed plate schemas to identify
    the container schema for

    the wells, which are modeled as containers. Examples of container schemas include
    "Eppendorf Tube", "Falcon

    Tube", or custom organization-specific container types.'
  name: ContainerSchema
  x-bnch-organization: Benchling
- description: 'A flexible, user-defined entity type in Benchling''s Registry. Unlike
    specialized entity

    types such as DnaSequence or Molecule, CustomEntities allow organizations to model
    any

    kind of scientific or business object using configurable EntitySchemas (see `schema`).

    CustomEntities support customFields for storing structured data, can be organized
    into

    Folders and Projects, and integrate with Benchling''s collaboration, search, and
    audit

    systems. They are commonly used to represent cell lines, reagents, instruments,
    or any

    domain-specific items that don''t fit predefined entity categories.'
  name: CustomEntity
  x-bnch-core-type: CustomEntity
  x-bnch-organization: Benchling
- description: Operations for CustomEntitySchema
  name: CustomEntitySchema
  x-bnch-organization: Benchling
- description: '`DataFrame` stores non-schematized tabular data, with Benchling-aware
    column types (see `DataFrameColumn`).

    Data frames are not searchable and lack their own permissions; rather, they are
    child objects of pipelines

    (via `PipelineStepData`), datasets (see `Dataset`), and app canvases. Row data
    is stored in S3. Data frames

    are immutable; if data is updated, a new `DataFrame` is created.'
  name: DataFrame
  x-bnch-organization: Benchling
- description: '`Dataset` stores non-schematized tabular data, with Benchling-aware
    column types.


    Datasets are first-class, searchable, archivable folder items. A Dataset''s actual
    data is stored in a

    `DataFrame`.'
  name: Dataset
  x-bnch-organization: Benchling
- description: 'Represents a short single-stranded DNA oligonucleotide in Benchling''s
    molecular biology

    platform. DNA oligos are typically synthetic sequences used as primers for PCR,
    probes

    for hybridization assays, or components in cloning workflows. Each oligo stores
    its

    nucleotide base sequence, annotations for features of interest, and any chemical

    modifications (see ModifiedNucleotide) such as phosphorothioate backbones or fluorescent

    labels. Oligos can be registered in the Registry with unique identifiers, organized
    in

    folders, and linked to other entities via schema fields. Unlike DnaSequence, oligos
    are

    specifically designed for shorter, synthesizable sequences. Also referred to as
    primers

    or probes depending on their application.'
  name: DnaOligo
  x-bnch-core-type: DnaOligo
  x-bnch-organization: Benchling
- description: Defines the structure, field definitions, and configuration options
    for DNA oligos.
  name: DnaOligoSchema
  x-bnch-organization: Benchling
- description: 'Represents a DNA sequence in Benchling''s molecular biology platform.
    A `DnaSequence` stores the nucleotide

    bases of the forward strand along with rich annotations for biological features
    such as genes, promoters, and

    regulatory elements. Sequences can be linear or circular (controlled by `isCircular`)
    and support translation

    annotations for protein-coding regions (see `Translation`), primer binding sites
    (see `Primer`), and part

    features linking to other sequences (see `DnaPart`). DNA sequences can be registered
    in the Registry with a

    unique `entityRegistryId`, organized in folders, and linked to other entities
    via schema fields. Also known as

    "Sequence" in the Benchling interface, with IDs prefixed by ''seq''.'
  name: DnaSequence
  x-bnch-core-type: DnaSequence
  x-bnch-organization: Benchling
- description: Defines the structure, field definitions, and configuration options
    for DNA sequences.
  name: DnaSequenceSchema
  x-bnch-organization: Benchling
- description: 'Represents an ordered piece of content within an entry, template,
    subtemplate, or document.

    Each document part wraps one content block and records its container, version,
    and audit metadata.'
  name: DocumentPart
  x-bnch-organization: Benchling
- description: 'A configurable list of predefined values used for standardizing data
    entry in schema fields.

    Dropdowns provide controlled vocabulary choices that ensure consistency when users
    fill out

    entity and object fields. Each Dropdown belongs to a Registry (see `registry`)
    and contains

    one or more selectable options (see `DropdownOption`). Dropdowns are referenced
    by schema

    field definitions (see `DropdownLinkFieldDefinition`) to constrain the allowed
    values for a

    field. Organizations use dropdowns to enforce standardized terminology across
    experiments,

    samples, and other registered entities.'
  name: Dropdown
  x-bnch-organization: Benchling
- description: 'A schema field definition that links to a dropdown for value selection.
    The `linkDefinition` field

    references the `Dropdown` configuration that defines the available options. When
    `isMulti`

    is true, users can select multiple dropdown options for a single field value.
    The dropdown

    provides controlled vocabulary for consistent data entry across the organization.'
  name: DropdownLinkFieldDefinition
  x-bnch-organization: Benchling
- description: 'An individual selectable value within a Dropdown. Each DropdownOption
    represents one valid

    choice that users can select when populating a schema field configured with the
    parent

    Dropdown. Options can be archived to remove them from the available choices while
    preserving

    historical data that references them. The option''s name is displayed to users
    when selecting

    values.'
  name: DropdownOption
  x-bnch-organization: Benchling
- description: 'Defines the structure and behavior for a category of registered entities
    in Benchling.

    EntitySchemas specify the field definitions (see `fieldDefinitions` and `SchemaFieldDefinition`)

    that determine what data can be stored on entities of this type. Each schema belongs
    to a

    Registry (see `registry`) and has a prefix used for generating entity IDs. Schemas
    can

    enforce uniqueness constraints (see `constraint`) and configure whether entities
    can be

    stored in containers (see `containableType`). Access is controlled through collaborations

    (see `Collaboration`). Common entity types include DNA sequences, proteins, molecules,

    and custom entities, determined by the schema''s type field.'
  name: EntitySchema
  x-bnch-organization: Benchling
- description: 'An Entry is the core document type in Benchling''s Electronic Lab
    Notebook (ELN), used

    by scientists to record experimental work and observations. Entries are organized
    into

    sections (days) containing various content types such as text, tables, file attachments,

    and structured data tables for results. Entries support rich collaboration features

    including authorship tracking, review workflows (see `Review` and `ReviewProcess`),

    access control through Projects and Folders, and can be linked to Studies. Entries
    may

    optionally conform to an `EntrySchema` that defines custom fields. They can be
    created

    from scratch or from an `EntryTemplate` to ensure consistent structure. Entry
    mutation

    endpoints are currently in closed LA.'
  name: Entry
  x-bnch-core-type: Entry
  x-bnch-organization: Benchling
- description: 'Defines a schema that can be applied to Entries to add structured
    metadata through custom fields.

    Entry schemas allow organizations to standardize the information captured in notebook
    entries by defining

    required or optional fields with specific data types.'
  name: EntrySchema
  x-bnch-organization: Benchling
- description: 'A reusable content block that can be inserted into `DocumentLike`
    objects.

    Subtemplates contain pre-defined note content (text, tables, etc.) that scientists

    commonly need to repeat across multiple entries. Unlike `EntryTemplates` which
    create

    entire new entries, subtemplates are inserted as sections within existing documents.

    Subtemplates belong to a `TemplateCollection` and support versioned publishing
    (see

    `PublishingRecord`) to ensure consistent use across the organization. In the UI,

    these may be referred to simply as "Subtemplates" or "Insertable Content."'
  name: EntrySubtemplate
  x-bnch-organization: Benchling
- description: 'A template used to create new `DocumentLike` objects with pre-populated
    content and structure.

    `EntryTemplate`s contain boilerplate text, tables, placeholders, and other note
    content that provides a

    consistent starting point for documentation. When a new `DocumentLike` object
    is created from a template, the

    template''s content is cloned into the new object. Templates can optionally have
    an `EntrySchema` to ensure

    created objects capture required metadata. typeemplates belong to a `TemplateCollection`
    and support versioned

    publishing (see `PublishingRecord`). In the UI, these are typically called "Templates"
    within the

    Template Collections feature.'
  name: EntryTemplate
  x-bnch-organization: Benchling
- description: 'Represents a restriction enzyme from Benchling''s global catalog of
    commercially available

    enzymes. Restriction enzymes (also known as restriction endonucleases) are molecular
    scissors

    that recognize specific DNA sequences and cleave the DNA at defined positions.
    Each enzyme

    has a recognition sequence (restrictionSiteBases), such as GAATTC for EcoRI, and
    cut site

    details (see CutSiteDetail) specifying where the enzyme cuts relative to that
    recognition

    site. Enzymes can produce blunt ends or sticky ends (overhangs) depending on their
    cut

    pattern. Users can organize frequently used enzymes into EnzymeLists for convenient
    access

    during cloning workflow design.'
  name: Enzyme
  x-bnch-organization: Benchling
- description: 'Represents a user-curated collection of restriction enzymes for molecular
    cloning workflows.

    EnzymeLists allow users and organizations to organize commonly used enzymes into
    named groups

    for easy access when planning restriction digests, cloning strategies, or analyzing
    DNA

    sequences. Each list has an owner (either a user or organization) who controls
    access

    permissions. See `Enzyme` for the individual restriction enzymes that can be added
    to a list.'
  name: EnzymeList
  x-bnch-organization: Benchling
- description: Defines the structure, field definitions, and configuration options
    for Equipments.
  name: EquipmentSchema
  x-bnch-organization: Benchling
- description: 'Configures delivery of Benchling events to external systems via AWS
    EventBridge. Event

    subscriptions enable real-time integration by streaming events (such as entity
    creation,

    updates, or workflow state changes) to a customer''s AWS EventBridge event bus.
    The

    subscription includes the destination AWS ARN (see `destinationAddress`), routing
    metadata,

    and lifecycle management through expiration (see `expiresAt`) and pause controls.
    Paused

    subscriptions stop emitting events but retain their configuration for later resumption.

    Event subscriptions are typically managed through Benchling Apps (see `BenchlingApp`).'
  name: EventSubscription
  x-bnch-organization: Benchling
- description: 'Represents a reusable collection of biological features for auto-annotating
    nucleotide and AA sequences.

    FeatureLibraries enable users to define common sequence motifs (such as genes,
    promoters, terminators, or

    protein domains) with associated patterns, then automatically detect and annotate
    those features across many

    sequences. Each library contains `FeatureLibraryItem`s that specify the pattern
    to match and the annotation

    details to apply. Libraries can be shared with collaborators through ownership
    and permission controls, making

    them useful for standardizing annotation practices across a team. When running
    auto-annotate on a sequence,

    users select which libraries to search against.'
  name: FeatureLibrary
  x-bnch-organization: Benchling
- description: 'Represents a single feature definition within a FeatureLibrary used
    for auto-annotation.

    Each item defines a searchable pattern (nucleotide or amino acid sequence), a
    feature type

    classification (such as ''gene'', ''promoter'', or ''domain''), a display name,
    and a color for

    visualization. When auto-annotate runs against a sequence, the pattern is matched
    according

    to the matchType (see FeatureLibraryMatchType), and matching regions are annotated
    with the

    item''s name, type, and color. Patterns can include special characters for flexible
    matching,

    such as wildcards for arbitrary bases or optional flanking regions.'
  name: FeatureLibraryItem
  x-bnch-organization: Benchling
- description: 'A tenant-defined schema interface (also known as a "Fieldset") that
    groups related fields

    to be shared across multiple schemas. Fieldsets are created and managed by tenant

    administrators and belong to an `Organization`. Schemas can implement an interface
    to inherit

    its `fieldDefinitions`, ensuring consistent field definitions across entity types.
    Unlike

    `StaticSchemaInterface` (which is Benchling-defined and read-only), Fieldsets

    can be modified by users. May include a `constraint` for uniqueness validation
    and a `prefix`

    for ID generation on implementing entities. Can be archived when no longer needed.'
  name: Fieldset
  x-bnch-organization: Benchling
- description: 'A File represents an uploaded document or data file that is surfaced
    in Benchling''s

    Data Catalog for discovery and organization. Files are primarily created through

    Benchling Connect (for external file integrations) and the Analysis Tool (for

    pipeline outputs). Each File is backed by a ScratchFile containing the actual

    binary content and upload state. Files are folder-based items that can be

    starred for quick access, linked to Studies, and support custom fields.

    Files differ from EntryExternalFile (attachments within notebook entries)

    and Blob (raw binary storage) in that they are first-class data catalog

    items with full metadata and discovery capabilities.'
  name: File
  x-bnch-organization: Benchling
- description: 'A hierarchical container for organizing entities, notebook entries,
    and other items within

    a Project. Folders support nested structures through parent-child relationships
    (see

    `parent`), enabling users to create logical groupings that mirror laboratory organization

    or experimental workflows. Folders belong to a Project (see `project`) and inherit
    access

    control through collaborations (see `Collaboration`). Items stored in folders
    implement

    the FolderItem interface. Folders can be starred for quick access (via `Starrable`)
    and

    archived with lineage tracking that affects contained items (via `ArchivableWithLineage`).'
  name: Folder
  x-bnch-organization: Benchling
- description: A database of reference sequences used to characterize protein sequences
    via alignment.
  name: Germline
  x-bnch-organization: Benchling
- description: 'Indicates that a Principal is a member of Group. Role indicates that
    the Principal is

    a member of a subgroup, such as Admins of the Group. Teams are the canonical example

    of a Group.'
  name: GroupMembership
  x-bnch-organization: Benchling
- description: 'A `LabelTemplate` defines the format for printing physical labels
    for inventory items, such as containers,

    plates, and boxes. Each template contains a template string, `zplTemplate`, that
    is populated with item data

    and sent to a compatible label printer. Template strings typically use ZPL (Zebra
    Programming Language), but

    for the most part, Benchling code treats them in a language agnostic way, and
    they can contain other printer

    languages, such as JScript, to work with less common printers. `LabelTemplate`s
    are associated with a Registry

    and enable consistent barcode labeling across an organization''s inventory. `LabelTemplate`s
    can include

    dynamic fields for barcodes, names, dates, and custom metadata.'
  name: LabelTemplate
  x-bnch-organization: Benchling
- description: 'Represents a legacy (pre-App Store) Benchling App installation on
    a tenant. Legacy apps

    are configured directly with webhook URLs and configuration specs rather than
    through

    app definition versions. This type is maintained for backward compatibility with
    older

    app integrations. For new apps, see `AppInstallation`.'
  name: LegacyAppInstallation
  x-bnch-organization: Benchling
- description: 'A reusable parameter definition stored in the Parameter Library. LibraryParameterDefinitions
    allow

    organizations to standardize parameters used across multiple procedures by defining
    a name, description, data

    type, and optional unit type. When creating procedure parameters, users can link
    to a library parameter

    definition to inherit its settings, ensuring consistency across experiments.'
  name: LibraryParameterDefinition
  x-bnch-organization: Benchling
- description: 'A Location represents a physical storage area in Benchling''s inventory
    system, such as

    a freezer, refrigerator, shelf, room, or building. Locations form a hierarchy
    where

    each location can contain child locations (e.g., a freezer contains shelves) as
    well

    as inventory items like Boxes, Plates, and Containers when allowNonLocationChildren
    is

    true. Each location tracks its capacity (totalCapacity, availableCapacity, occupiedCapacity)

    and can restrict what types of items it accepts via allowedInventorySchemas. Locations

    conform to a LocationSchema that defines custom fields for the location type.
    Locations

    are identified by barcode for physical tracking and can be archived when no longer
    in use.'
  name: Location
  x-bnch-core-type: Location
  x-bnch-organization: Benchling
- description: 'Defines the structure and metadata for a category of Locations in
    Benchling''s inventory

    system. A LocationSchema specifies schema field definitions for capturing location-specific

    data (e.g., temperature range, access restrictions) and an optional Registry association

    with display ID prefix. LocationSchemas categorize different types of storage
    areas such

    as "Freezer", "Refrigerator", "Shelf", or "Room". Locations conforming to a schema
    inherit

    its field definitions, allowing consistent metadata capture across similar storage
    types.'
  name: LocationSchema
  x-bnch-organization: Benchling
- description: 'A MatrixPlate is a rack-style storage plate where Containers (tubes,
    vials) can be

    inserted into and removed from grid positions. Unlike FixedPlate or WellPlate
    where

    wells are permanently attached, MatrixPlate positions (see MatrixPlatePosition)
    can

    be empty or hold movable containers. This makes MatrixPlates ideal for tube racks,

    sample storage boxes with removable tubes, and other flexible storage formats.
    Each

    plate tracks its capacity (totalCapacity, availableCapacity, occupiedCapacity)
    and

    conforms to a MatrixPlateSchema that defines the grid dimensions and optionally

    restricts which ContainerSchema types can be stored. MatrixPlates can be stored
    in

    Locations, associated with Studies, and identified by barcode.'
  name: MatrixPlate
  x-bnch-core-type: MatrixPlate
  x-bnch-organization: Benchling
- description: 'Defines the structure and constraints for a category of MatrixPlates
    in Benchling''s

    inventory system. A MatrixPlateSchema specifies the grid dimensions (height and
    width),

    an optional ContainerSchema for tubes that can be inserted, and custom field definitions.

    Unlike WellPlateSchema where wells are permanently fixed, MatrixPlateSchema defines

    plates where containers can be inserted into and removed from positions. Examples
    include

    tube racks and sample storage matrices. Each schema is associated with a Registry

    and given a prefix for generating display IDs.'
  name: MatrixPlateSchema
  x-bnch-organization: Benchling
- description: 'A Mixture is a formulation entity in Benchling that represents a combination
    of

    ingredients with specified amounts. Mixtures are commonly used for buffers, media,

    reagent preparations, and other multi-component solutions. Each mixture has a
    total

    amount with units (see MixtureMeasurementUnits) and contains a list of Ingredients

    specifying what goes into the mixture. Mixtures can be registered in the Registry,

    organized in folders and projects, and may have preparation instructions attached

    (see MixtureInstructions). The `allowMeasuredIngredients` setting (from the schema)

    determines whether the mixture is a thoeretical "recipe", which has target amonunts,
    or a physical "prep",

    with measured amounts.'
  name: Mixture
  x-bnch-core-type: Mixture
  x-bnch-organization: Benchling
- description: Defines the structure, field definitions, and configuration options
    for Mixtures.
  name: MixtureSchema
  x-bnch-organization: Benchling
- description: 'A Molecule represents a small molecule chemical compound in Benchling
    that is imported either as a MolFile or

    using SMILES (Simplified Molecular Input Line Entry System) notation. Molecules
    are registry entities that can

    be registered, searched, and linked to other items. When present, the `canonicalSmiles`
    field provides a

    standardized SMILES representation for comparison, while originalSmiles preserves
    the user-provided SMILES and

    may be null if SMILES was not provided at creation. Molecules support custom fields
    via schemas and can be

    organized in folders and projects.'
  name: Molecule
  x-bnch-core-type: Molecule
  x-bnch-organization: Benchling
- description: Defines the structure, field definitions, and configuration options
    for Molecule schemas.
  name: MoleculeSchema
  x-bnch-organization: Benchling
- description: 'Represents a multiple sequence alignment of nucleotide sequences (DNA
    or RNA). Nucleotide

    alignments are used to compare sequence reads against a reference template for
    verification

    (see AlignmentType TEMPLATE) or to align multiple sequences for consensus building
    (see

    AlignmentType CONSENSUS). Each alignment contains a referenceSequence (the template
    or

    consensus) and a collection of AlignedNucleotideSequence entries representing
    the individual sequences

    being compared. Alignments are commonly used in Sanger sequencing verification
    workflows

    to confirm that a cloned construct matches the expected design.'
  name: NucleotideAlignment
  x-bnch-organization: Benchling
- description: 'A building block component of modified oligonucleotides, representing
    a sugar, phosphate,

    or base subunit. Monomers are the chemical units that assemble to form nucleotides
    in

    therapeutic oligonucleotide design. Each monomer has a symbol identifier, chemical
    structure

    (SMILES), molecular weight, and attachment points defining where it bonds to other
    monomers.

    The naturalAnalog field links modified monomers to their natural counterparts
    (e.g., a

    2''-O-methyl ribose analog links to natural ribose ''r''). Monomers are referenced
    in

    ModifiedNucleotide and CustomNotationAlias to specify the exact chemistry of modified

    sequences. Also known as building blocks in oligonucleotide synthesis contexts.'
  name: NucleotideMonomer
  x-bnch-organization: Benchling
- description: 'An oligo conjugate is a therapeutic modality consisting of a single-stranded

    oligonucleotide backbone with one or more attached conjugate molecules. Common

    examples include antisense oligonucleotides (ASOs) with GalNAc ligands for liver

    targeting, or siRNA strands with lipid or cholesterol conjugates. The backbone

    references the underlying oligo entity, while conjugates lists the attached molecules.

    Structure is defined using HELM notation and can be edited via the visual structure

    editor. Supports versioning (see OligoConjugateVersion) to track changes over
    time.'
  name: OligoConjugate
  x-bnch-core-type: OligoConjugate
  x-bnch-organization: Benchling
- description: Defines the structure, field definitions, and configuration options
    for Oligo Conjugates.
  name: OligoConjugateSchema
  x-bnch-organization: Benchling
- description: 'An oligo duplex is a therapeutic modality consisting of two complementary

    oligonucleotide strands (forward and reverse) with optional conjugate molecules

    attached to either strand. The classic example is siRNA (small interfering RNA),

    which uses double-stranded RNA for gene silencing. The forwardStrand and reverseStrand

    reference the underlying oligo entities, with hydrogen bonds automatically computed

    for base pairing. Structure is defined using HELM notation and can be edited via

    the visual structure editor. Supports versioning (see OligoDuplexVersion) to track

    changes over time.'
  name: OligoDuplex
  x-bnch-core-type: OligoDuplex
  x-bnch-organization: Benchling
- description: Defines the structure, field definitions, and configuration options
    for Oligo Duplexes.
  name: OligoDuplexSchema
  x-bnch-organization: Benchling
- description: 'Represents a group of users within Benchling, typically corresponding
    to a company,

    department, or research group. Organizations provide a many-to-many relationship
    between

    users—each user can belong to multiple organizations, and each organization can
    have

    multiple users. Users are designated as either ADMIN (with management privileges)
    or

    MEMBER within the organization via `GroupMembership`. Organizations can own resources

    like Projects and Folders, and can contain Teams for finer-grained user grouping.

    Organizations also control access settings such as whether members can create
    personal

    ownables and what default policies apply to new resources. In the UI, organizations

    appear in user profiles and are used for sharing and access control throughout
    Benchling.'
  name: Organization
  x-bnch-organization: Benchling
- description: 'Represents a single operation node within a Pipeline''s directed acyclic
    graph (DAG). Each

    step performs a specific transformation determined by its stepType (see `PipelineStepType`),

    with configuration options stored in the config field. Steps receive data through

    inputStepDatas and produce results via outputStepDatas (see `PipelineStepData`).
    The

    incomingEdges and outgoingEdges (see `PipelineStepEdge`) define the data flow
    connections

    to other steps. Execution state is tracked through statusCode and statusMessage.
    Steps

    support provenance tracking through the provenanceUri field for tracing data lineage.'
  name: PipelineStep
  x-bnch-organization: Benchling
- description: 'Represents actual data attached to an input or output slot of a PipelineStep
    during execution.

    Each PipelineStepData corresponds to a defined data shape (input or output) on
    the step''s

    configuration and holds references to the raw data (see `RawStepData`) that fills
    that slot.

    The name field identifies which data shape this instance fills. Multiple raw data
    items can

    be attached when the data shape allows multiple values (isMulti). PipelineStepData
    enables

    data flow between pipeline steps by tracking data lineage and provenance through
    the

    provenanceUri field.'
  name: PipelineStepData
  x-bnch-organization: Benchling
- description: 'A Plate is a legacy unified type representing both well plates and
    tube racks in

    Benchling''s inventory system. The type field (see PlateType) indicates whether
    this

    is a FIXED_PLATE (wells permanently attached, like 96-well or 384-well plates)
    or a

    MATRIX_PLATE (removable containers in a grid, like tube racks). For new integrations,

    prefer using the specific FixedPlate and MatrixPlate types which provide clearer

    semantics and type-specific fields. Plates can be stored in Locations (via parentStorage),

    associated with Studies, and identified by barcode. The wells field returns Container

    objects representing the plate positions.'
  name: Plate
  x-bnch-core-type: Plate
  x-bnch-organization: Benchling
- description: 'A named plate design template backed by a scratch plate that lives
    in a template collection.

    Plate design templates allow scratch plates to be organized and reused as templates.'
  name: PlateDesignTemplate
  x-bnch-organization: Benchling
- description: 'Defines the structure and constraints for a category of Plates in
    Benchling''s inventory

    system. A PlateSchema specifies the grid dimensions (height and width), the plate
    type

    (see PlateType), and optionally links to a ContainerSchema that constrains what
    container

    types can occupy positions. Schema field definitions allow capturing plate-specific

    metadata. PlateSchema is the legacy unified schema type; for new configurations,
    prefer

    using the specific WellPlateSchema (for fixed plates) or MatrixPlateSchema (for
    tube

    racks). Each schema is associated with a Registry and given a prefix for generating

    display IDs and barcodes.'
  name: PlateSchema
  x-bnch-organization: Benchling
- description: 'Defines a named set of permissions that can be assigned to users or
    groups through

    collaborations. Policies contain PolicyStatements that specify allowed actions
    on

    different item types. When a user is granted a collaboration with a specific policy,

    they receive all permissions defined in that policy''s statements. Common policies

    include viewer (read-only access), editor (read and write), and admin (full control).

    Policies are reusable and can be applied across many collaborations.'
  name: Policy
  x-bnch-organization: Benchling
- description: 'Represents an execution of a Model Hub model against multiple data
    inputs (resulting in multiple Predictions).

    A PredictionBatch tracks the input configuration, execution status, and results.

    Each batch is associated with a specific model and version, enabling version tracking.

    Common use cases include protein structure prediction, property prediction, and
    sequence generation.'
  name: PredictionBatch
  x-bnch-organization: Benchling
- description: 'Represents a single prediction within a PredictionBatch.

    Each PredictionJob captures the input configuration for one prediction

    and its association with input components (e.g., AA sequences, molecules).'
  name: PredictionJob
  x-bnch-organization: Benchling
- description: 'A Printer represents a network-connected label printer configured
    in Benchling for printing

    barcode labels on inventory items. Printers are associated with a Registry and
    work with

    LabelTemplates to generate properly formatted labels. Each printer is identified
    by a

    network address and optional port number.'
  name: Printer
  x-bnch-organization: Benchling
- description: 'A reusable template that defines a structured experimental workflow.
    Procedures specify a

    sequence of method steps (see `ProcedureMethodDefinitionVersion`) connected in
    a flowchart

    (see `workflowFlowchartConfig` and `WorkflowFlowchartConfigVersion`) that scientists
    follow when running

    experiments. The `procedureType` determines whether this is a recipe (synthesis/production

    workflow) or an assay (analytical workflow). Procedures belong to a `TemplateCollection`
    for

    organization and access control, and support versioning through publishing (see
    `Publishable`

    and `publishingRecords`). When scientists execute a procedure, they create a `ProcedureRun`

    that tracks the actual experiment execution.'
  name: Procedure
  x-bnch-organization: Benchling
- description: 'Contains the flowchart configuration for a Procedure or TemplateCollection.
    A ProcedureFlowchart

    acts as a container for flowchart versions (see `ProcedureFlowchartVersion`),
    tracking both the

    latest working version (`latestFlowchartVersion`) and the published version

    (`publishedFlowchartVersion`) that is used when creating procedure runs. The parent
    relationship

    (see `parent`) connects this flowchart to either a `Procedure` or `TemplateCollection`.


    Note that this model will be deprecated soon, in favor of `WorkflowFlowchartConfig`.'
  name: ProcedureFlowchart
  x-bnch-organization: Benchling
- 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 `latestProcedureFlowchartConfigVersionProxy` and

    `publishedProcedureFlowchartConfigVersionProxy`), `ProcedureRun`, and `ProcedureRunPlan`
    (not yet in alpha) to

    provide a read-only view of the flowchart structure for execution and planning
    purposes.'
  name: ProcedureFlowchartConfigVersionProxy
  x-bnch-organization: Benchling
- description: 'An immutable snapshot of a procedure''s flowchart structure at a specific
    point in time. Each

    version contains the complete graph of method steps (see `nodes` and

    `ProcedureMethodDefinitionVersion`) and their connections (see `edges` and `ProcedureEdge`).

    New versions are created when a procedure''s flowchart is modified, preserving
    the history of

    changes. The `ProcedureFlowchart` parent tracks which version is latest and which
    is published

    for execution.


    Note that this model will be deprecated soon, in favor of `WorkflowFlowchartConfig`.'
  name: ProcedureFlowchartVersion
  x-bnch-organization: Benchling
- description: 'A versioned method within a procedure flowchart. Methods are the building
    blocks of

    procedures, representing discrete experimental operations that scientists perform.
    Each

    method contains step groups (see `stepGroups` and `ProcedureStepGroup`) organized
    by

    execution phase, along with parameter settings for data collection (`dataParameterSettings`),

    material inputs (`materialInputSettings`), material outputs (`materialOutputSettings`),
    and

    equipment (`equipmentSettings`). Methods appear as nodes in the procedure flowchart
    (see

    `ProcedureFlowchartVersion`) and are connected by edges that define execution

    order and material flow.'
  name: ProcedureMethodDefinitionVersion
  x-bnch-organization: Benchling
- description: 'An instance of a method being executed within a procedure run. When
    a scientist runs a

    procedure, each method in the flowchart becomes a ProcedureMethodExecutionInstance
    that tracks

    the actual execution: the worksheet where data is entered (`worksheet`), the associated
    task

    (`methodTask`), step groups with execution instances (`stepGroups`), and all parameter
    values

    (planned, confirmed, and measured). Links to its `ProcedureRun`, the template
    method it''s based

    on (`templateMethodVersion`), and the specific condition/replicate it belongs
    to

    (`procedureRunConditionReplicate`). Material flow between methods is tracked via

    `sourceProcedureMethodExecutionInstanceAssociations` and

    `targetProcedureMethodExecutionInstanceAssociations`.'
  name: ProcedureMethodExecutionInstance
  x-bnch-organization: Benchling
- description: 'Links two method execution instances across procedure runs to represent
    an intended connection within a study.

    This allows scientists to coordinate their analyses across runs, even when the
    flowchart structure may differ.'
  name: ProcedureMethodExecutionInstanceAssociation
  x-bnch-organization: Benchling
- description: 'Represents a parameter entity within a procedure template. Parameters
    define the data,

    materials, or equipment that scientists interact with during procedure execution.

    The `parameterType` field classifies the parameter as one of: data parameter,
    material

    input, material output, or equipment (see `ProcedureParameterType`). Each parameter
    has

    versioned definitions (`ProcedureParameterVersion`) that specify the name, data
    type,

    and validation rules. During execution, parameter values (`ProcedureParameterPlannedValue`,

    `ProcedureParameterConfirmationValue`, `ProcedureParameterMeasuredValue`) are
    recorded

    against the specific parameter version.'
  name: ProcedureParameter
  x-bnch-organization: Benchling
- description: 'Records a scientist''s confirmation of a parameter value during procedure
    execution. When running

    a procedure, scientists confirm that inputs (such as materials, equipment, or
    data) match

    expectations before proceeding. This type captures that confirmation along with
    an optional

    comment and timestamp (`recordedAt`). Distinct from `ProcedureParameterPlannedValue`
    (the

    expected value set during procedure setup) and `ProcedureParameterMeasuredValue`
    (the actual

    result recorded after execution). For material input parameters, `amount` and
    `container`

    fields specify the confirmed quantities and storage locations. Links to the specific

    `ProcedureMethodExecutionInstance` where the confirmation occurred and the

    `ProcedureParameterVersion` defining the parameter being confirmed.'
  name: ProcedureParameterConfirmationValue
  x-bnch-organization: Benchling
- description: 'Records the actual measured or observed value for a parameter during
    procedure execution.

    Scientists enter measured values after performing an experimental step—for example,

    recording a temperature reading, an absorbance measurement, or an observed result.

    Distinct from `ProcedureParameterPlannedValue` (expected values set during setup)
    and

    `ProcedureParameterConfirmationValue` (verification that inputs match expectations).

    Includes an optional `comment` and `recordedAt` timestamp. Links to the specific

    `ProcedureMethodExecutionInstance` and `ProcedureParameterVersion` for context.'
  name: ProcedureParameterMeasuredValue
  x-bnch-organization: Benchling
- 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
- 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
- description: 'An active execution of a procedure template. Created when scientists
    start running an experiment

    based on a `Procedure`. Contains experimental conditions (`conditions` via `ProcedureRunCondition`)

    and their replicates, which in turn contain method execution instances (`methodExecutionInstances`

    via `ProcedureMethodExecutionInstance`) where actual data are recorded. Links
    to its template via

    `templateProcedureFlowchartVersion` or `procedureFlowchartConfigVersionProxy`
    and belongs to a `Study`. The

    `defaultDataEntryMode` (see `ProcedureRunDataEntryMode`) determines whether each
    condition-replicate has its

    own worksheet or all share one. Workflow orchestration is managed through `workflowRootTaskGroup`.

    Also known as an "experiment" in the Benchling UI.'
  name: ProcedureRun
  x-bnch-organization: Benchling
- 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"
  name: ProcedureRunCondition
  x-bnch-organization: Benchling
- 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`.'
  name: ProcedureRunConditionReplicate
  x-bnch-organization: Benchling
- description: 'A draft experiment plan that can be promoted to a `ProcedureRun` for
    execution. Scientists use

    run plans to configure experimental conditions, parameter values, and replicates
    before

    starting an actual experiment. Belongs to a `Study` and references a procedure
    template via

    either `templateProcedureFlowchartVersion` (for legacy flowcharts) or

    `procedureFlowchartConfigVersionProxy` (for new-style workflow flowcharts). Contains

    `ProcedureRunPlanCondition` objects that define the different experimental configurations
    to

    test. The `dataEntryMode` (see `ProcedureRunDataEntryMode`) specifies whether
    each

    condition-replicate will have its own data entry worksheet or share a single worksheet.
    The

    `confirmationMethodByParamVersionId` allows overriding default confirmation methods
    for

    specific parameters. Upon promotion, the run plan becomes a `ProcedureRun` with
    corresponding

    `ProcedureRunCondition` and `ProcedureRunConditionReplicate` objects. Also known
    as a "draft

    experiment" in the Benchling UI.'
  name: ProcedureRunPlan
  x-bnch-organization: Benchling
- description: 'A planned experimental condition within a `ProcedureRunPlan`, representing
    how a procedure''s

    methods will be configured when the plan is promoted to an actual `ProcedureRun`.
    Each

    condition contains pre-filled parameter values (via `MethodParametersPlan`) for
    the procedure''s

    unit operations, and specifies how many replicates will be run (via

    `ProcedureRunPlanConditionReplicate`). Scientists use conditions to plan different
    experimental

    configurations before execution—for example, testing multiple temperatures or
    reagent

    concentrations. The `position` field determines display order within the parent
    run plan. Upon

    promotion, each ProcedureRunPlanCondition becomes a `ProcedureRunCondition` in
    the resulting

    experiment. Also known as an "experiment condition" in the Benchling UI''s experiment
    planning

    workflow.'
  name: ProcedureRunPlanCondition
  x-bnch-organization: Benchling
- description: 'A versioned definition of a procedure step within a procedure flowchart.
    Steps represent

    documentation or instructions that guide scientists through a procedure but do
    not collect

    data—they differ from methods (`ProcedureMethodDefinitionVersion`) which have
    parameters for

    data entry. The `documentVersion` field links to a `DocumentVersion` containing
    the step''s

    text content, which may include formatted instructions, images, or other rich
    content. Steps

    are immutable; updating a step creates a new version. Belongs to a procedure flowchart
    via

    `procedureFlowchartId`. Also known as a "text step" or "instruction step" in the
    Benchling UI.'
  name: ProcedureStepDefinitionVersion
  x-bnch-organization: Benchling
- description: 'An execution instance of a procedure step within a `ProcedureMethodExecutionInstance`.
    Created

    when a procedure run is started, representing a step where scientists can document
    their work.

    The `document` field links to a `Document` (entry) where scientists write notes,
    observations,

    and results during execution. References both `planStepVersion` (from the run
    plan flowchart)

    and `templateStepVersion` (from the original procedure template) to track provenance—these
    are

    null for ad-hoc steps added during execution or auto-generated confirmation steps.
    The

    `stepTask` provides workflow orchestration via `WorkflowTask`. Can be archived
    along with its

    parent method execution instance through the `ArchivableWithLineage` lineage.
    Also known as a

    "step entry" or "execution step" in the Benchling UI.'
  name: ProcedureStepExecutionInstance
  x-bnch-organization: Benchling
- description: 'A top-level organizational container in Benchling that groups related
    work and controls

    access permissions. Projects contain Folders (see `Folder`) which in turn hold
    entities,

    notebook entries, and other items. Each project has an owner (see `Owner`—typically
    a

    User or Organization) and access is managed through collaborations (see `Collaboration`).

    Projects serve as the primary unit for sharing and permission management: users
    who are

    not collaborators on a project cannot access its contents. The isDataModsEnabled
    flag

    controls whether data modification tracking is active for items in this project.'
  name: Project
  x-bnch-organization: Benchling
- description: 'A Protein is a complex biomolecule entity in Benchling representing
    immunoglobulins or

    related therapeutic proteins like T-cell receptors. Proteins are defined by an

    `ProteinFormat` that specifies their structural organization, with actual sequences

    provided in domains (see `ProteinDomain`) and chains (see `ProteinChain`). Proteins
    support versioning

    through history/fullHistory, allowing tracking of structural changes over time.
    As registry entities,

    proteins can have schemas with custom fields, belong to projects and folders,
    and be linked to studies.'
  name: Protein
  x-bnch-core-type: Protein
  x-bnch-organization: Benchling
- description: 'A ProteinFormat defines the structural template for a class of proteins,
    specifying the

    arrangement of chains and domains. Formats can be built-in (e.g., IgG1, Fab, scFv)
    or

    custom-defined by users.'
  name: ProteinFormat
  x-bnch-organization: Benchling
- description: Defines the structure, field definitions, and configuration options
    for Proteins.
  name: ProteinSchema
  x-bnch-organization: Benchling
- description: 'A historical snapshot of an `Protein` at a specific point in time,
    preserving the complete

    structural state including domains, chains, and HELM notation. Protein versions
    form a

    lineage that tracks changes over time. Each version records its creator and creation
    time.

    The parent field links to the version this one was derived from. Versions may
    become out of

    sync with their constituent entities if underlying sequences change.'
  name: ProteinVersion
  x-bnch-organization: Benchling
- description: A Chemical Reaction is a process where molecules are transformed into
    new molecules.
  name: Reaction
  x-bnch-organization: Benchling
- description: 'A centralized, validated repository for entities and inventory items
    within an organization.

    The registry serves as the source of truth for registered items—entities placed
    in the registry

    have passed validation checks (required fields, unique constraints, unique aliases)
    and received

    a unique registry identifier. Each organization has at most one registry. Items
    can become

    invalid after registration, so asynchronous validation tracks current validity
    state.

    Under the hood, the registry is a special type of project with a single root folder
    for

    entities, while inventory items live directly on the registry. Access is controlled
    through

    `collaborations`. Also known as the "Registry" in the Benchling UI sidebar.'
  name: Registry
  x-bnch-organization: Benchling
- description: 'A reusable template that defines the structure and configuration for
    requests

    in Benchling. Also known as a "Request Template" in the UI. Each RequestV2Definition

    specifies a `templateDocument` that serves as the document template for requests,
    a

    `workflowTaskSchema` that defines the task structure and fields, and a `prefix`
    used

    to generate human-readable display IDs (e.g., "REQ-001") for submissions created
    from

    this template. Request templates are organized within `TemplateCollection` folders
    and

    support collaboration features like starring (see `Starrable`). When users submit
    a

    request, they create a `RequestV2Submission` based on this definition. The template

    can include a `description` to explain its intended use and can be archived when
    no

    longer needed.'
  name: RequestV2Definition
  x-bnch-organization: Benchling
- description: 'A workflow request submitted from a `RequestV2Definition` (known as
    "Request Template" in the UI).

    When a request is submitted (status transitions to SENT), a `WorkflowTaskGroup`
    is automatically

    created to fulfill the request, containing tasks defined by the template''s workflow
    task schema.

    Requests are authored in a `Document` and stored within `Folder`s. The `status`
    field tracks

    the request lifecycle: requests start as DRAFT while being composed, become SENT
    when submitted,

    and transition to FULFILLED when all associated workflow tasks reach terminal
    status. Requests

    can also be DISCARDED (before submission) or CANCELLED (after submission). Users
    can

    be added as `watchers` to receive notifications about request status changes.
    Requests can be

    linked to `Study` entities for research coordination (see `Studyable` interface).'
  name: RequestV2Submission
  x-bnch-organization: Benchling
- description: 'A Result represents a single row of experimental measurement data
    in Benchling''s lab

    automation system. Results conform to a ResultSchema that defines their field
    structure,

    enabling standardized capture of assay outputs such as absorbance readings, Ct
    values,

    concentrations, or other measured quantities. Results are typically created through

    lab automation output processors (see AutomationOutputProcessor), structured result

    tables in notebook entries (via the entry field), or programmatically via the
    API.

    Each result belongs to a Project for access control and can be archived when no
    longer

    needed. Results can be linked to entities, samples, and runs through schema field
    values,

    enabling traceability from raw measurements back to source materials.'
  name: Result
  x-bnch-core-type: Result
  x-bnch-organization: Benchling
- description: 'Defines the structure and metadata fields for a category of assay
    Results in Benchling''s

    lab automation system. A ResultSchema specifies the field definitions that capture

    measurement data, calculated values, and other experimental outcomes. Results
    conforming

    to a schema are typically created through lab automation output processors (see

    AutomationOutputProcessor), structured result tables in notebook entries, or via
    the API.

    Each schema is owned by an Organization and supports collaboration settings for
    access

    control. ResultSchemas are often associated with specific assay types such as
    ELISA,

    qPCR, or mass spectrometry, enabling standardized data capture across experiments.

    Also known as "assay schema" in some contexts (note the assaysch prefix).'
  name: ResultSchema
  x-bnch-organization: Benchling
- description: 'Represents an active or completed review of a reviewable item such
    as an Entry or

    StageEntry. A Review tracks the overall status, the assigned reviewers (see `Reviewer`),

    and links back to the reviewable item. Reviews follow a configured `ReviewProcess`

    that defines the stages and actions required for completion. The review status

    progresses from submission through reviewer actions until reaching a terminal
    state

    like ACCEPTED or REJECTED.'
  name: Review
  x-bnch-organization: Benchling
- description: 'Represents a single action taken within a review. ReviewChanges form
    an ordered

    history of all changes made to a review, including status transitions,

    reviewer assignments, and comments. Each ReviewChange records the action taken,

    any associated comment, whether it was electronically signed, and an optional

    point-in-time snapshot.'
  name: ReviewChange
  x-bnch-organization: Benchling
- description: 'Defines a review process configuration that specifies how entries
    and other

    reviewable items should be reviewed. A ReviewProcess belongs to an Organization

    and can be associated with one or more Projects. When a review is initiated,

    it follows the stages defined in the current `ReviewProcessVersion`. Review

    processes enable organizations to enforce compliance requirements by defining

    who must review, in what order, and what actions are required. Also known as

    "Review Lifecycle" in the backend.'
  name: ReviewProcess
  x-bnch-organization: Benchling
- description: 'A single stage within a ReviewProcess that defines a required step
    in the review

    workflow. Each stage specifies what action reviewers must take (see

    `ReviewProcessActionType`), who is eligible to be a reviewer (see `ReviewerType`),

    and optionally a specific Team. For sequential review processes, stages have a

    position index determining their order. Stages can be configured to allow or

    disallow authors and senders as reviewers, and can permit team member reassignment.


    The list endpoint returns stages from the current version of each accessible review

    process. To retrieve stages scoped to a specific review process, use

    `GET /benchling/review-process/{review_process_id}` and inspect `currentVersion.reviewStages`.'
  name: ReviewProcessStage
  x-bnch-organization: Benchling
- description: 'Represents a short single-stranded RNA oligonucleotide in Benchling''s
    molecular biology

    platform. RNA oligos are synthetic sequences used in applications such as RNA
    interference

    (siRNA, shRNA), antisense oligonucleotides (ASOs), mRNA therapeutics, or CRISPR
    guide RNAs.

    Each oligo stores its nucleotide base sequence, annotations for features of interest,
    and

    chemical modifications (see ModifiedNucleotide) such as 2''-O-methyl sugars or
    phosphorothioate

    backbones that enhance stability and efficacy. RNA oligos can be registered in
    the Registry

    with unique identifiers, organized in folders, and linked to other entities via
    schema

    fields. Unlike RnaSequence, oligos are specifically designed for shorter, synthesizable

    sequences. Also referred to as RNA probes or therapeutic oligonucleotides depending
    on

    their application.'
  name: RnaOligo
  x-bnch-core-type: RnaOligo
  x-bnch-organization: Benchling
- description: Defines the structure, field definitions, and configuration options
    for RNA oligos.
  name: RnaOligoSchema
  x-bnch-organization: Benchling
- description: 'Represents an RNA sequence in Benchling''s molecular biology platform.
    An RnaSequence stores

    the nucleotide bases (using A, C, G, U) along with annotations marking functional
    regions,

    translation annotations for protein-coding regions (see Translation), primer binding
    sites

    (see Primer), and part features linking to other registered sequences (see RnaPart).
    RNA

    sequences are used for modeling messenger RNAs, non-coding RNAs, CRISPR guide
    RNAs, and

    other RNA molecules. Sequences can be registered in the Registry with a unique

    entityRegistryId, organized in folders, and linked via schema fields to other
    entities.

    For modified therapeutic RNAs, see modifiedNucleotides which captures chemical
    modifications.

    Also known as ''Sequence'' in the Benchling interface, with IDs prefixed by ''seq''.'
  name: RnaSequence
  x-bnch-core-type: RnaSequence
  x-bnch-organization: Benchling
- description: Defines the structure, field definitions, and configuration options
    for RNA sequences
  name: RnaSequenceSchema
  x-bnch-organization: Benchling
- description: 'A Run represents an execution instance of a lab automation workflow
    in Benchling, capturing

    the inputs, outputs, and metadata for a single assay or instrument operation.
    Runs conform

    to a RunSchema that defines their structure including input generators (see AutomationInputGenerator)

    for creating worklists and output processors (see AutomationOutputProcessor) for
    parsing

    instrument results. Runs are typically embedded in notebook entries (via the entry
    field)

    and can generate associated Analyses for data processing. Each run tracks validation
    status

    (VALID or INVALID) with optional comments, enabling quality control workflows.
    Runs belong

    to a Project for access control and can be archived when superseded or invalidated.
    Also

    known as "assay runs" in the lab automation context.'
  name: Run
  x-bnch-core-type: Run
  x-bnch-organization: Benchling
- description: 'Defines the structure and automation configuration for a category
    of Runs in Benchling''s

    lab automation system. A RunSchema specifies field definitions for run metadata,

    input generator configurations (see AutomationInputFileConfig) for creating instrument

    worklists, and output processor configurations (see AutomationOutputFileConfig)
    for

    parsing instrument results. Schemas can be linked to an AnalysisTemplate for automated

    data processing after runs complete. Settings control whether runs can be created
    from

    notebooks (allowCreateRunFromNotebook), inserted from the run inbox (allowInsertRunFromInbox),

    and whether equipment tracking is enabled (shouldRecordEquipment). Each schema
    is owned

    by an Organization and has a systemName used for Data Platform integration. RunSchemas

    define the automation workflow for specific assay types like qPCR, ELISA, or sequencing.'
  name: RunSchema
  x-bnch-organization: Benchling
- description: 'A ScratchFile represents raw file content used as intermediate input
    or output of

    pipeline steps (see PipelineStepData). Unlike File, ScratchFiles are not surfaced

    in the Data Catalog because they typically represent transient processing artifacts

    rather than standalone valuable data. ScratchFiles track upload state via uploadStatus

    and provide uploadUrl/downloadUrl for content transfer. When a ScratchFile is

    promoted to user-visible status, it is linked to a File object that appears in
    the

    Data Catalog. The originPipelineStepData field tracks which pipeline step produced

    this file.'
  name: ScratchFile
  x-bnch-organization: Benchling
- description: 'A plate design or record used for designing, tracking, and analyzing
    experimental plates

    outside of the inventory.


    Scratch plates are the working surface for plate-based workflows: you build up

    a plate''s layout (well roles, contents, concentrations, metadata, measurements)

    through one or more creates and updates, then optionally convert it to a

    persistent inventory plate via the `bulk-put-in-inventory` endpoint.


    Each layer of data (label, content, concentration, metadata, measurements, etc.)

    is accessible via its `dataFrame`.


    These endpoints are not generally available and may fail depending on your tenant
    configuration.'
  name: ScratchPlate
  x-bnch-organization: Benchling
- description: 'Represents a non-human identity used for system integrations and automated
    processes

    within Benchling. Service principals act as the identity for service accounts
    that

    perform actions via APIs or background processes without human intervention. Unlike

    `User`, which represents a human user, ServicePrincipal is used when an integration

    or automated system needs to be attributed as the actor for auditing and attribution

    purposes. Service principals implement the Principal interface, allowing them
    to

    appear as creators or actors on domain objects. Also known as "service account"
    in

    some contexts.'
  name: ServicePrincipal
  x-bnch-organization: Benchling
- description: 'A SqlDashboard is a configurable analytics page that displays one
    or more SQL-driven

    visualizations within Benchling Insights. Dashboards belong to a Project and contain

    ordered blocks (see SqlDashboardBlock), each with its own SQL query and chart
    or table

    visualization. Dashboards support parameterConfigs (see SqlParameterConfig) that
    allow

    users to filter data dynamically through dropdowns, date pickers, or entity selectors.

    SQL Dashboards query Benchling''s data warehouse.'
  name: SqlDashboard
  x-bnch-organization: Benchling
- description: 'Represents a single query and visualization pane within a SqlDashboard.
    Each block

    contains a SQL query (sqlQuery) that runs against the Benchling data warehouse,
    along

    with a BlockVisualization that defines how the query results are displayed (as
    a chart,

    table, heatmap, etc.). Blocks are ordered by index within their parent dashboard
    and

    have a name and description for identification. SQL Dashboard Blocks enable users
    to

    build interactive analytics dashboards by combining multiple query-driven visualizations

    on a single page.'
  name: SqlDashboardBlock
  x-bnch-organization: Benchling
- description: 'A StageEntry is an Entry that is associated with a specific stage
    in a legacy Workflow. Unlike regular Entries

    which exist independently in folders, StageEntries are created as part of workflow
    execution and contain the

    documentation for that stage''s work. Each StageEntry belongs to a WorkflowStage
    and may contain multiple

    StageRuns representing individual sample processing. StageEntries support the
    same content types and review

    workflows as regular Entries but are not directly archivable (their lifecycle
    is tied to the workflow). They

    can be created from an `EntryTemplate` configured for the stage.'
  name: StageEntry
  x-bnch-organization: Benchling
- description: 'A structured unit used to plan and organize research in Benchling.

    Each study progresses through phases (see `StudyPhase`) sequentially from design
    to execution to completion.

    The current phase determines what modifications are permitted on the study and
    its associated data.'
  name: Study
  x-bnch-organization: Benchling
- description: 'Represents the link between a Study and a Studyable item (such as
    entities or molecules).

    Each association is identified by id and links a specific `study` to a specific
    `item`, and records

    when the link was created via `createdAt` and who created it via `creator`.'
  name: StudyItemAssociation
  x-bnch-organization: Benchling
- description: 'A configuration template that defines the structure and behavior of
    Studies within an organization. Each

    `StudySchema` specifies the `studyType`, which determines available features and
    workflow capabilities.

    Schemas define custom fields through `fieldDefinitions` that studies of this type
    must populate. The

    `isDesignApprovalRequired` flag controls whether study designs must go through
    a review process before

    execution. Associated `entryTemplates` provide standardized notebook templates
    for documenting study work.

    Studies reference their schema via `Study.studySchema`.'
  name: StudySchema
  x-bnch-organization: Benchling
- description: 'Represents a subgroup of users within an `Organization`, enabling
    finer-grained user

    management and data sharing. Teams belong to exactly one organization, and users
    may

    only join a team if they are already members of that team''s parent organization.
    Each

    team member has either ADMIN or MEMBER role (see `GroupMembership`): admins can
    manage

    team membership, while members receive standard access. Unlike Organizations,
    teams

    cannot directly own Projects or Folders—they are used for collaboration and access

    control purposes. Teams can be configured with `provisionedCapabilities` to grant

    specific Benchling capabilities to members upon joining. The `membersAreAdministratorsOfSchemas`

    flag controls whether team members can create and modify certain schema types.'
  name: Team
  x-bnch-organization: Benchling
- description: 'A container that organizes related templates, subtemplates, and other
    template-like

    items. Template Collections provide a way to group and manage reusable content
    that

    teams use to create standardized entries. Each collection has an owner (typically
    an

    Organization or Team) and can be shared with others through access controls (see

    `Collaboration`). Collections can contain `EntryTemplate`s for creating new entries,

    `EntrySubtemplate`s for inserting content, form definitions, procedures, and analysis

    templates. In the Benchling UI, these appear in the "Template Collections" section.'
  name: TemplateCollection
  x-bnch-organization: Benchling
- description: 'A Test Definition is a configuration object that specifies a type
    of test or assay that can be

    ordered against samples. Each Test Definition is associated with a `ResultSchema`
    that defines

    the structure of measurement data captured when the test is performed. Test Definitions
    serve

    as templates—when a test needs to be performed on a sample, a `TestOrder` is created
    referencing

    the appropriate Test Definition. Test Definitions are used within clinical and
    preclinical study

    workflows (see `StudySampleTestPlan`) and can be linked to `Procedure` assays
    for execution.

    Belongs to an `Organization` and can be archived when no longer needed.'
  name: TestDefinition
  x-bnch-organization: Benchling
- description: 'A Test Order represents an individual request to perform a specific
    test on a sample. Each

    Test Order references a `TestDefinition` that specifies what type of test to perform,
    and

    a `sample` (Entity) that is being tested. Test Orders track their lifecycle through
    `status`

    (see `TestStatus`), from PENDING when created, through IN_PROGRESS during execution,
    to

    COMPLETED or other terminal states. When executed via an Assay workflow, the `procedure`

    and `procedureMethodExecutionInstance` fields link to the execution context. Results
    are

    captured in the `result` field. Test Orders can be associated with `Study` objects
    for

    clinical/preclinical workflows and linked to specific plate wells via `plateWellAssociations`

    for laboratory execution tracking.'
  name: TestOrder
  x-bnch-organization: Benchling
- description: 'A Unit is a specific measure of a physical quantity within Benchling''s
    tenant-specific

    unit dictionary, used to capture and convert scientific measurements across the
    platform.

    Each Unit belongs to a `UnitType` (e.g., "Volume" or "Mass") and defines its relationship

    to the UnitType''s base unit through a `conversionFactor`. For example, a milliliter
    unit

    would have a conversionFactor of 0.001 relative to a liter base unit. Units are

    identified by a human-readable `name` (e.g., "milliliter"), a shorthand `symbol`

    (e.g., "mL"), and may have `aliases` for alternate input symbols. Units within
    the same

    UnitType are inter-convertible; cross-dimensional conversions are not supported.
    Units

    appear throughout Benchling wherever measurements are recorded, including inventory

    container quantities (see `Measurement`), result fields, and sample properties.'
  name: Unit
  x-bnch-organization: Benchling
- description: 'A UnitType is a dimensional category that groups inter-convertible
    `Unit` objects

    within Benchling''s tenant-specific unit dictionary. Examples include Volume,
    Mass,

    Time, Molar Concentration, and custom types like Cell Concentration. Each UnitType

    has a designated `baseUnit` that serves as the reference for conversion factors

    of all other units in the type—units within the same UnitType can be converted
    to

    each other, but cross-dimensional conversions are not supported. The dimensional

    composition is described by `terms` (see `UnitTypeTerm`), and derived types can

    specify their `formula` (see `FormulaUnitTerm`) to define relationships

    like Liter = decimeter³. UnitTypes can be flagged to provide concentration units

    or container quantity units for inventory features regardless of their dimensional

    terms. Historically called "Quantity" in some internal systems.'
  name: UnitType
  x-bnch-organization: Benchling
- description: 'Represents a human user in Benchling who can log in, perform actions,
    and own data.

    Users belong to one or more Organizations and may be members of Teams within those

    organizations. As an Owner, users can own Projects, Folders, and other resources.

    As a Principal, users can be assigned as reviewers, authors, or collaborators
    on

    various items. Users have attributes like email and username for identification.

    Users are distinct from `ServicePrincipal`, which represents non-human service

    accounts used for integrations.'
  name: User
  x-bnch-organization: Benchling
- description: 'Represents credentials for connecting to Benchling''s data warehouse,
    enabling users to query data

    using SQL tools like database clients or BI platforms. This includes all warehouse
    login types:

    user-generated Direct Access credentials, as well as temporary Insights and Agent
    credentials.

    Each WarehouseCredential is tied to a specific Benchling `user` whose permissions
    determine what

    data is accessible through those credentials. Credentials can have an optional
    `expiresAt` date

    for time-limited access and can be permanently disabled via the `revoked` flag.
    Once revoked,

    credentials cannot be reactivated. Users can create multiple credentials (up to
    a per-user limit)

    with different `label` values to distinguish between uses.'
  name: WarehouseCredential
  x-bnch-organization: Benchling
- description: 'A custom SQL view created by users in Benchling''s data warehouse,
    allowing them to

    define reusable queries that can be accessed like tables.

    Views appear in a dedicated schema and can be queried via Insights Dashboards
    or Direct Access.

    View names are unique within the tenant.

    View''s `viewQuery` field contains the SQL SELECT statement that defines the view.

    View''s `existsInWarehouse` flag indicates whether the view exists in the warehouse.
    It is updated

    asynchronously, so it may be out of date for a brief period of time.'
  name: WarehouseCustomView
  x-bnch-organization: Benchling
- description: 'A WellPlate is a multi-well plate in Benchling''s inventory system
    where wells are

    permanently fixed to the plate structure. This is the standard plate type for
    laboratory

    multi-well formats such as 96-well, 384-well, and 1536-well plates used in high-throughput

    screening, PCR, and other assay workflows. The plate''s grid dimensions are defined
    by its

    WellPlateSchema, and each well (see WellPlatePosition) can contain samples, track
    quantities,

    and be assigned experimental roles. WellPlates can be stored in Locations (via
    parentStorage),

    associated with Studies, and identified by barcode. The plateRecords field tracks
    the history

    of transfers and annotations performed on the plate (see PlateRecord). Unlike
    MatrixPlate

    where containers can be inserted or removed, WellPlate wells are integral to the
    plate.'
  name: WellPlate
  x-bnch-core-type: WellPlate
  x-bnch-organization: Benchling
- description: 'Represents a single well within a WellPlate, functioning as a fixed
    container at a

    specific grid position. Each WellPlatePosition has coordinates identifying its
    row

    and column, can hold sample contents (see ContainerContent), and tracks quantity
    as

    a Measurement. Wells can be assigned an ExperimentalRole for assay organization
    and

    support freeze/thaw tracking (see FreezeThawInfo) and expiration tracking (see

    ExpirationInfo) when enabled on the well''s ContainerSchema. Unlike containers
    in a

    MatrixPlate, WellPlatePositions are permanent parts of the plate structure and
    cannot

    be removed or repositioned. Wells are accessed through the parent WellPlate''s
    positions

    field.'
  name: WellPlatePosition
  x-bnch-organization: Benchling
- description: 'Defines the structure and constraints for a category of WellPlates
    in Benchling''s

    inventory system. A WellPlateSchema specifies the grid dimensions (height and
    width)

    determining how many wells the plate has, and requires a ContainerSchema that
    defines

    the well properties (volume capacity, custom fields, etc.). Custom field definitions

    allow capturing plate-level metadata beyond individual well data. Each WellPlateSchema

    is associated with a Registry and has a prefix for generating display IDs and
    barcodes.

    Examples include "96-Well PCR Plate", "384-Well Assay Plate", or organization-specific

    plate formats. Unlike MatrixPlateSchema which defines tube rack formats with removable

    containers, WellPlateSchema is for fixed-well plates where wells are permanent.'
  name: WellPlateSchema
  x-bnch-organization: Benchling
- description: 'Represents the result or product of completing a `WorkflowTask`. Each
    output is associated

    with a single task. Outputs can contain schema-defined

    fields that capture structured data from task execution. In flowchart workflows,
    outputs

    can serve as inputs to downstream tasks, enabling data flow between workflow steps.

    The output schema is defined by the `WorkflowOutputSchema` associated with the
    parent task''s schema.'
  name: WorkflowOutput
  x-bnch-organization: Benchling
- description: 'Defines the structure of `WorkflowOutput` instances produced by tasks
    of a given

    `WorkflowTaskSchema`. Each output schema specifies `fieldDefinitions` for the
    data to

    be captured, an optional `prefix` for human-readable output IDs, and a `name`
    for

    identification. Output schemas belong to an `Organization` and are linked to their
    parent

    `workflowTaskSchema`. In flowcharts, output schemas can define data that flows
    between nodes.'
  name: WorkflowOutputSchema
  x-bnch-organization: Benchling
- description: 'Represents a unit of work within a `WorkflowTaskGroup`. Each task
    has a `status` that progresses

    through a configurable lifecycle (see `WorkflowTaskStatusLifecycle`), an optional
    `assignee`

    and `responsibleParties` for ownership, and a `scheduledOn` date for planning.

    Tasks may or may not produce `WorkflowOutput` instances upon completion. In flowchart
    workflows, tasks can

    have upstream dependencies (`flowchartPreviousItems`) and downstream dependents

    (`flowchartNextItems`), with `rootWorkflowTask` pointing to the flowchart''s entry
    point.

    Tasks support schema-defined custom fields via `schemaFields` and can be linked
    to `Study`

    entities for research coordination.'
  name: WorkflowTask
  x-bnch-organization: Benchling
- description: 'A container that groups related `WorkflowTask` instances together,
    representing a cohesive

    unit of work. Task groups are created from a `WorkflowTaskSchema` (via `workflowTaskSchema`).

    They are stored in `Folder`s and can have `authors` and `watchers` for

    collaboration. In flowchart workflows, task groups can be nested:

    `childWorkflowTaskGroups` contains sub-groups for flowchart nodes, and

    `rootWorkflowTaskGroup` points to the parent when this group is part of a larger
    flowchart.

    When created from a `RequestV2Submission`, the `requestSubmission` field links
    back to the

    originating request. Task groups aggregate the outputs from all their tasks via

    `workflowOutputs`.'
  name: WorkflowTaskGroup
  x-bnch-organization: Benchling
- description: 'A configuration template that defines the structure and behavior of
    `WorkflowTask` instances.

    Each schema specifies an `executionType` (direct, entry, or flowchart) and

    custom `fieldDefinitions` for task data. Schemas belong to an `Organization` and
    can optionally reference an `entryTemplate`

    for entry-based execution or a `flowchartConfig` for flowchart-based execution.
    The `prefix`

    and `taskGroupPrefix` fields define the human-readable ID format for tasks and
    task groups.

    Default folders can be configured via `defaultCreationFolder` and `defaultEntryExecutionFolder`.

    Schemas support `responsibleParties` for default assignment and `validationRules`
    for data

    validation (see `HasValidationRules`). The associated `workflowOutputSchema` defines
    the

    structure of outputs produced by tasks of this schema.'
  name: WorkflowTaskSchema
  x-bnch-organization: Benchling
- description: 'A typed collection of items used to group related objects for batch
    operations. Unlike

    folders, items can belong to multiple worklists simultaneously, making worklists
    useful

    as temporary holding grounds for arbitrary groups of items. Each worklist has
    an `itemType`

    that restricts what kinds of objects it can contain (containers, entities, or
    plates).

    Common use cases include scanning containers into a worklist before adding them
    to a

    transfer table, or grouping entities for bulk export. Worklists have an `owner`
    and support

    `collaborations` for access control (see `Collaboratable` interface). The `items`
    field

    returns the collection of `Worklistable` objects currently in the worklist.'
  name: Worklist
  x-bnch-organization: Benchling
- description: 'A structured document container used to organize and execute procedural
    work within

    Benchling''s notebook system. Worksheets contain ordered `WorksheetStepGroup`s,
    each

    holding `WorksheetStep`s that represent individual tasks or documentation units.
    Each

    step has an associated `Document` for capturing content. Worksheets support workflow

    integration through associated `WorkflowTask`s, can be linked to `Study` objects
    for

    experimental context, and include review capabilities (see `Review`). They are
    stored

    within `Folder`s and support archival.'
  name: Worksheet
  x-bnch-organization: Benchling
- description: Tier 1 rate limit endpoints
  name: Tier 1 Rate Limit
- description: Tier 2 rate limit endpoints
  name: Tier 2 Rate Limit
- description: Tier 3 rate limit endpoints
  name: Tier 3 Rate Limit
- description: Tier 4 rate limit endpoints
  name: Tier 4 Rate Limit
- description: Tier 5 rate limit endpoints
  name: Tier 5 Rate Limit
webhooks:
  v3.customEntity.created:
    post:
      description: Sent to Benchling Apps subscribed to `v3.customEntity.created`
        when a CustomEntity they can access is created.
      operationId: CustomEntity.Created
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomEntityCreatedWebhookEnvelopeV3'
        description: The `v3.customEntity.created` event.
        required: true
      responses:
        '200':
          description: Return a 200 status code to acknowledge receipt of the webhook.
      summary: CustomEntity created
      tags:
      - CustomEntity
  v3.customEntity.updated:
    post:
      description: Sent to Benchling Apps subscribed to `v3.customEntity.updated`
        when a CustomEntity they can access is updated. `message.properties` lists
        the properties that changed.
      operationId: CustomEntity.Updated
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomEntityUpdatedWebhookEnvelopeV3'
        description: The `v3.customEntity.updated` event.
        required: true
      responses:
        '200':
          description: Return a 200 status code to acknowledge receipt of the webhook.
      summary: CustomEntity updated
      tags:
      - CustomEntity
  v3.dnaOligo.created:
    post:
      description: Sent to Benchling Apps subscribed to `v3.dnaOligo.created` when
        a DnaOligo they can access is created.
      operationId: DnaOligo.Created
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DnaOligoCreatedWebhookEnvelopeV3'
        description: The `v3.dnaOligo.created` event.
        required: true
      responses:
        '200':
          description: Return a 200 status code to acknowledge receipt of the webhook.
      summary: DnaOligo created
      tags:
      - DnaOligo
  v3.dnaOligo.updated:
    post:
      description: Sent to Benchling Apps subscribed to `v3.dnaOligo.updated` when
        a DnaOligo they can access is updated. `message.properties` lists the properties
        that changed.
      operationId: DnaOligo.Updated
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DnaOligoUpdatedWebhookEnvelopeV3'
        description: The `v3.dnaOligo.updated` event.
        required: true
      responses:
        '200':
          description: Return a 200 status code to acknowledge receipt of the webhook.
      summary: DnaOligo updated
      tags:
      - DnaOligo
  v3.dnaSequence.created:
    post:
      description: Sent to Benchling Apps subscribed to `v3.dnaSequence.created` when
        a DnaSequence they can access is created.
      operationId: DnaSequence.Created
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DnaSequenceCreatedWebhookEnvelopeV3'
        description: The `v3.dnaSequence.created` event.
        required: true
      responses:
        '200':
          description: Return a 200 status code to acknowledge receipt of the webhook.
      summary: DnaSequence created
      tags:
      - DnaSequence
  v3.dnaSequence.updated:
    post:
      description: Sent to Benchling Apps subscribed to `v3.dnaSequence.updated` when
        a DnaSequence they can access is updated. `message.properties` lists the properties
        that changed.
      operationId: DnaSequence.Updated
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DnaSequenceUpdatedWebhookEnvelopeV3'
        description: The `v3.dnaSequence.updated` event.
        required: true
      responses:
        '200':
          description: Return a 200 status code to acknowledge receipt of the webhook.
      summary: DnaSequence updated
      tags:
      - DnaSequence
  v3.entry.created:
    post:
      description: Sent to Benchling Apps subscribed to `v3.entry.created` when a
        Entry they can access is created.
      operationId: Entry.Created
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntryCreatedWebhookEnvelopeV3'
        description: The `v3.entry.created` event.
        required: true
      responses:
        '200':
          description: Return a 200 status code to acknowledge receipt of the webhook.
      summary: Entry created
      tags:
      - Entry
  v3.project.created:
    post:
      description: Sent to Benchling Apps subscribed to `v3.project.created` when
        a Project they can access is created.
      operationId: Project.Created
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectCreatedWebhookEnvelopeV3'
        description: The `v3.project.created` event.
        required: true
      responses:
        '200':
          description: Return a 200 status code to acknowledge receipt of the webhook.
      summary: Project created
      tags:
      - Project
  v3.project.updated:
    post:
      description: Sent to Benchling Apps subscribed to `v3.project.updated` when
        a Project they can access is updated. `message.properties` lists the properties
        that changed.
      operationId: Project.Updated
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectUpdatedWebhookEnvelopeV3'
        description: The `v3.project.updated` event.
        required: true
      responses:
        '200':
          description: Return a 200 status code to acknowledge receipt of the webhook.
      summary: Project updated
      tags:
      - Project
  v3.rnaOligo.created:
    post:
      description: Sent to Benchling Apps subscribed to `v3.rnaOligo.created` when
        a RnaOligo they can access is created.
      operationId: RnaOligo.Created
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RnaOligoCreatedWebhookEnvelopeV3'
        description: The `v3.rnaOligo.created` event.
        required: true
      responses:
        '200':
          description: Return a 200 status code to acknowledge receipt of the webhook.
      summary: RnaOligo created
      tags:
      - RnaOligo
  v3.rnaOligo.updated:
    post:
      description: Sent to Benchling Apps subscribed to `v3.rnaOligo.updated` when
        a RnaOligo they can access is updated. `message.properties` lists the properties
        that changed.
      operationId: RnaOligo.Updated
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RnaOligoUpdatedWebhookEnvelopeV3'
        description: The `v3.rnaOligo.updated` event.
        required: true
      responses:
        '200':
          description: Return a 200 status code to acknowledge receipt of the webhook.
      summary: RnaOligo updated
      tags:
      - RnaOligo
  v3.rnaSequence.created:
    post:
      description: Sent to Benchling Apps subscribed to `v3.rnaSequence.created` when
        a RnaSequence they can access is created.
      operationId: RnaSequence.Created
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RnaSequenceCreatedWebhookEnvelopeV3'
        description: The `v3.rnaSequence.created` event.
        required: true
      responses:
        '200':
          description: Return a 200 status code to acknowledge receipt of the webhook.
      summary: RnaSequence created
      tags:
      - RnaSequence
  v3.rnaSequence.updated:
    post:
      description: Sent to Benchling Apps subscribed to `v3.rnaSequence.updated` when
        a RnaSequence they can access is updated. `message.properties` lists the properties
        that changed.
      operationId: RnaSequence.Updated
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RnaSequenceUpdatedWebhookEnvelopeV3'
        description: The `v3.rnaSequence.updated` event.
        required: true
      responses:
        '200':
          description: Return a 200 status code to acknowledge receipt of the webhook.
      summary: RnaSequence updated
      tags:
      - RnaSequence
  v3.run.created:
    post:
      description: Sent to Benchling Apps subscribed to `v3.run.created` when a Run
        they can access is created.
      operationId: Run.Created
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunCreatedWebhookEnvelopeV3'
        description: The `v3.run.created` event.
        required: true
      responses:
        '200':
          description: Return a 200 status code to acknowledge receipt of the webhook.
      summary: Run created
      tags:
      - Run