openapi: 3.0.1
info:
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  title: Benchling AA Sequences Schemas API
  version: 2.0.0
  description: 'AA Sequences are the working units of cells that make everything run (they help make structures, catalyze reactions and allow for signaling - a kind of internal cell communication). On Benchling, these are comprised of a string of amino acids and collections of other attributes, such as annotations.

    '
servers:
- url: /api/v2
security:
- oAuth: []
- basicApiKeyAuth: []
tags:
- description: '

    Schemas represent custom configuration of objects in Benchling. See this [guide in our documentation](https://docs.benchling.com/docs/schemas) on how Schemas impact our developers

    '
  name: Schemas
paths:
  /assay-result-schemas:
    get:
      description: List assay result schemas
      operationId: listAssayResultSchemas
      parameters:
      - in: query
        name: nextToken
        schema:
          type: string
      - in: query
        name: pageSize
        schema:
          default: 50
          maximum: 100
          minimum: 0
          nullable: false
          type: integer
      - description: 'Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

          '
        examples:
          and-range:
            summary: Filter for all models modified within a certain range using the AND operator.
            value: '> 2022-03-01 AND < 2022-04-01'
          full-rfc-3339-format:
            summary: Filter for modified models using the full RFC 3339 format
            value: '> 2020-12-31T21:07:14-05:00'
          greater-than-example:
            summary: Filter for all models modified after a certain date
            value: '> 2022-03-01'
        in: query
        name: modifiedAt
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssayResultSchemasPaginatedList'
          description: OK
          headers:
            Result-Count:
              description: The total number of schemas that match the given query
              schema:
                type: integer
            x-rate-limit-limit:
              description: The number of allowed assay results in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-remaining:
              description: The number of calls remaining in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-reset:
              description: The number of seconds remaining in the current rate-limit period
              schema:
                type: integer
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
      summary: List assay result schemas
      tags:
      - Schemas
  /assay-result-schemas/{schema_id}:
    get:
      description: Get a Result schema by ID
      operationId: getResultSchema
      parameters:
      - description: ID of schema to get
        in: path
        name: schema_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssayResultSchema'
          description: OK
        '400':
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
      summary: Get a Result schema by ID
      tags:
      - Schemas
  /assay-run-schemas:
    get:
      description: List assay run schemas
      operationId: listAssayRunSchemas
      parameters:
      - in: query
        name: nextToken
        schema:
          type: string
      - in: query
        name: pageSize
        schema:
          default: 50
          maximum: 100
          minimum: 0
          nullable: false
          type: integer
      - description: 'Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

          '
        examples:
          and-range:
            summary: Filter for all models modified within a certain range using the AND operator.
            value: '> 2022-03-01 AND < 2022-04-01'
          full-rfc-3339-format:
            summary: Filter for modified models using the full RFC 3339 format
            value: '> 2020-12-31T21:07:14-05:00'
          greater-than-example:
            summary: Filter for all models modified after a certain date
            value: '> 2022-03-01'
        in: query
        name: modifiedAt
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssayRunSchemasPaginatedList'
          description: OK
          headers:
            Run-Count:
              description: The total number of schemas that match the given query
              schema:
                type: integer
            x-rate-limit-limit:
              description: The number of allowed assay runs in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-remaining:
              description: The number of calls remaining in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-reset:
              description: The number of seconds remaining in the current rate-limit period
              schema:
                type: integer
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
      summary: List assay run schemas
      tags:
      - Schemas
  /assay-run-schemas/{schema_id}:
    get:
      description: Get a Run schema by ID
      operationId: getRunSchema
      parameters:
      - description: ID of schema to get
        in: path
        name: schema_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssayRunSchema'
          description: OK
        '400':
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
      summary: Get a Run schema by ID
      tags:
      - Schemas
  /batch-schemas:
    get:
      description: List batch schemas
      operationId: listBatchSchemas
      parameters:
      - in: query
        name: nextToken
        schema:
          type: string
      - in: query
        name: pageSize
        schema:
          default: 50
          maximum: 100
          minimum: 0
          nullable: false
          type: integer
      - description: 'Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

          '
        examples:
          and-range:
            summary: Filter for all models modified within a certain range using the AND operator.
            value: '> 2022-03-01 AND < 2022-04-01'
          full-rfc-3339-format:
            summary: Filter for modified models using the full RFC 3339 format
            value: '> 2020-12-31T21:07:14-05:00'
          greater-than-example:
            summary: Filter for all models modified after a certain date
            value: '> 2022-03-01'
        in: query
        name: modifiedAt
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchSchemasPaginatedList'
          description: OK
          headers:
            Result-Count:
              description: The total number of schemas that match the given query
              schema:
                type: integer
            x-rate-limit-limit:
              description: The number of allowed requests in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-remaining:
              description: The number of calls remaining in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-reset:
              description: The number of seconds remaining in the current rate-limit period
              schema:
                type: integer
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
      summary: List batch schemas
      tags:
      - Schemas
  /batch-schemas/{schema_id}:
    get:
      description: Get a batch schema by ID
      operationId: getBatchSchema
      parameters:
      - description: ID of schema to get
        in: path
        name: schema_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchSchema'
          description: OK
        '400':
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
      summary: Get a batch schema by ID
      tags:
      - Schemas
  /box-schemas:
    get:
      description: List box schemas
      operationId: listBoxSchemas
      parameters:
      - in: query
        name: nextToken
        schema:
          type: string
      - in: query
        name: pageSize
        schema:
          default: 50
          maximum: 100
          minimum: 0
          nullable: false
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoxSchemasPaginatedList'
          description: OK
          headers:
            Result-Count:
              description: The total number of schemas that match the given query
              schema:
                type: integer
            x-rate-limit-limit:
              description: The number of allowed requests in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-remaining:
              description: The number of calls remaining in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-reset:
              description: The number of seconds remaining in the current rate-limit period
              schema:
                type: integer
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
      summary: List box schemas
      tags:
      - Schemas
  /box-schemas/{schema_id}:
    get:
      description: Get a box schema by ID
      operationId: getBoxSchema
      parameters:
      - description: ID of schema to get
        in: path
        name: schema_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoxSchema'
          description: OK
        '400':
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
      summary: Get a box schema by ID
      tags:
      - Schemas
  /container-schemas:
    get:
      description: List container schemas
      operationId: listContainerSchemas
      parameters:
      - in: query
        name: nextToken
        schema:
          type: string
      - in: query
        name: pageSize
        schema:
          default: 50
          maximum: 100
          minimum: 0
          nullable: false
          type: integer
      - description: 'Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

          '
        examples:
          and-range:
            summary: Filter for all models modified within a certain range using the AND operator.
            value: '> 2022-03-01 AND < 2022-04-01'
          full-rfc-3339-format:
            summary: Filter for modified models using the full RFC 3339 format
            value: '> 2020-12-31T21:07:14-05:00'
          greater-than-example:
            summary: Filter for all models modified after a certain date
            value: '> 2022-03-01'
        in: query
        name: modifiedAt
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerSchemasPaginatedList'
          description: OK
          headers:
            Result-Count:
              description: The total number of schemas that match the given query
              schema:
                type: integer
            x-rate-limit-limit:
              description: The number of allowed requests in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-remaining:
              description: The number of calls remaining in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-reset:
              description: The number of seconds remaining in the current rate-limit period
              schema:
                type: integer
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
      summary: List container schemas
      tags:
      - Schemas
  /container-schemas/{schema_id}:
    get:
      description: Get a container schema by ID
      operationId: getContainerSchema
      parameters:
      - description: ID of schema to get
        in: path
        name: schema_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerSchema'
          description: OK
        '400':
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
      summary: Get a container schema by ID
      tags:
      - Schemas
  /entity-schemas:
    get:
      description: List entity schemas
      operationId: listEntitySchemas
      parameters:
      - in: query
        name: nextToken
        schema:
          type: string
      - in: query
        name: pageSize
        schema:
          default: 50
          maximum: 100
          minimum: 0
          nullable: false
          type: integer
      - description: 'Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

          '
        examples:
          and-range:
            summary: Filter for all models modified within a certain range using the AND operator.
            value: '> 2022-03-01 AND < 2022-04-01'
          full-rfc-3339-format:
            summary: Filter for modified models using the full RFC 3339 format
            value: '> 2020-12-31T21:07:14-05:00'
          greater-than-example:
            summary: Filter for all models modified after a certain date
            value: '> 2022-03-01'
        in: query
        name: modifiedAt
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitySchemasPaginatedList'
          description: OK
          headers:
            Result-Count:
              description: The total number of schemas that match the given query
              schema:
                type: integer
            x-rate-limit-limit:
              description: The number of allowed requests in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-remaining:
              description: The number of calls remaining in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-reset:
              description: The number of seconds remaining in the current rate-limit period
              schema:
                type: integer
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
      summary: List entity schemas
      tags:
      - Schemas
  /entity-schemas/{schema_id}:
    get:
      description: Get an entity schema by ID
      operationId: getEntitySchema
      parameters:
      - description: ID of schema to get
        in: path
        name: schema_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitySchema'
          description: OK
        '400':
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
      summary: Get an entity schema by ID
      tags:
      - Schemas
  /entry-schemas:
    get:
      description: List entry schemas
      operationId: listEntrySchemas
      parameters:
      - in: query
        name: nextToken
        schema:
          type: string
      - in: query
        name: pageSize
        schema:
          default: 50
          maximum: 100
          minimum: 0
          nullable: false
          type: integer
      - description: 'Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

          '
        examples:
          and-range:
            summary: Filter for all models modified within a certain range using the AND operator.
            value: '> 2022-03-01 AND < 2022-04-01'
          full-rfc-3339-format:
            summary: Filter for modified models using the full RFC 3339 format
            value: '> 2020-12-31T21:07:14-05:00'
          greater-than-example:
            summary: Filter for all models modified after a certain date
            value: '> 2022-03-01'
        in: query
        name: modifiedAt
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntrySchemasPaginatedList'
          description: OK
          headers:
            Result-Count:
              description: The total number of schemas that match the given query
              schema:
                type: integer
            x-rate-limit-limit:
              description: The number of allowed entrys in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-remaining:
              description: The number of calls remaining in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-reset:
              description: The number of seconds remaining in the current rate-limit period
              schema:
                type: integer
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
      summary: List entry schemas
      tags:
      - Schemas
  /entry-schemas/{schema_id}:
    get:
      description: Get an Entry schema by ID
      operationId: getEntrySchema
      parameters:
      - description: ID of schema to get
        in: path
        name: schema_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntrySchemaDetailed'
          description: OK
        '400':
          description: Bad Entry
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
      summary: Get an Entry schema by ID
      tags:
      - Schemas
  /location-schemas:
    get:
      description: List location schemas
      operationId: listLocationSchemas
      parameters:
      - in: query
        name: nextToken
        schema:
          type: string
      - in: query
        name: pageSize
        schema:
          default: 50
          maximum: 100
          minimum: 0
          nullable: false
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationSchemasPaginatedList'
          description: OK
          headers:
            Result-Count:
              description: The total number of schemas that match the given query
              schema:
                type: integer
            x-rate-limit-limit:
              description: The number of allowed requests in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-remaining:
              description: The number of calls remaining in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-reset:
              description: The number of seconds remaining in the current rate-limit period
              schema:
                type: integer
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
      summary: List location schemas
      tags:
      - Schemas
  /location-schemas/{schema_id}:
    get:
      description: Get a location schema by ID
      operationId: getLocationSchema
      parameters:
      - description: ID of schema to get
        in: path
        name: schema_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationSchema'
          description: OK
        '400':
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
      summary: Get a location schema by ID
      tags:
      - Schemas
  /plate-schemas:
    get:
      description: List plate schemas
      operationId: listPlateSchemas
      parameters:
      - in: query
        name: nextToken
        schema:
          type: string
      - in: query
        name: pageSize
        schema:
          default: 50
          maximum: 100
          minimum: 0
          nullable: false
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlateSchemasPaginatedList'
          description: OK
          headers:
            Result-Count:
              description: The total number of schemas that match the given query
              schema:
                type: integer
            x-rate-limit-limit:
              description: The number of allowed requests in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-remaining:
              description: The number of calls remaining in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-reset:
              description: The number of seconds remaining in the current rate-limit period
              schema:
                type: integer
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
      summary: List plate schemas
      tags:
      - Schemas
  /plate-schemas/{schema_id}:
    get:
      description: Get a plate schema by ID
      operationId: getPlateSchema
      parameters:
      - description: ID of schema to get
        in: path
        name: schema_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlateSchema'
          description: OK
        '400':
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
      summary: Get a plate schema by ID
      tags:
      - Schemas
  /request-schemas:
    get:
      description: List Legacy Request schemas
      operationId: listRequestSchemas
      parameters:
      - in: query
        name: nextToken
        schema:
          type: string
      - in: query
        name: pageSize
        schema:
          default: 50
          maximum: 100
          minimum: 0
          nullable: false
          type: integer
      - description: 'Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

          '
        examples:
          and-range:
            summary: Filter for all models modified within a certain range using the AND operator.
            value: '> 2022-03-01 AND < 2022-04-01'
          full-rfc-3339-format:
            summary: Filter for modified models using the full RFC 3339 format
            value: '> 2020-12-31T21:07:14-05:00'
          greater-than-example:
            summary: Filter for all models modified after a certain date
            value: '> 2022-03-01'
        in: query
        name: modifiedAt
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestSchemasPaginatedList'
          description: OK
          headers:
            Result-Count:
              description: The total number of schemas that match the given query
              schema:
                type: integer
            x-rate-limit-limit:
              description: The number of allowed requests in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-remaining:
              description: The number of calls remaining in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-reset:
              description: The number of seconds remaining in the current rate-limit period
              schema:
                type: integer
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
      summary: List request schemas
      tags:
      - Schemas
  /request-schemas/{schema_id}:
    get:
      description: Get a Legacy Request schema by ID
      operationId: getRequestSchema
      parameters:
      - description: ID of schema to get
        in: path
        name: schema_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestSchema'
          description: OK
        '400':
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
      summary: Get a Legacy Request schema by ID
      tags:
      - Schemas
  /request-task-schemas:
    get:
      description: List Request Task schemas
      operationId: listRequestTaskSchemas
      parameters:
      - in: query
        name: nextToken
        schema:
          type: string
      - in: query
        name: pageSize
        schema:
          default: 50
          maximum: 100
          minimum: 0
          nullable: false
          type: integer
      - description: 'Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

          '
        examples:
          and-range:
            summary: Filter for all models modified within a certain range using the AND operator.
            value: '> 2022-03-01 AND < 2022-04-01'
          full-rfc-3339-format:
            summary: Filter for modified models using the full RFC 3339 format
            value: '> 2020-12-31T21:07:14-05:00'
          greater-than-example:
            summary: Filter for all models modified after a certain date
            value: '> 2022-03-01'
        in: query
        name: modifiedAt
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestTaskSchemasPaginatedList'
          description: OK
          headers:
            Result-Count:
              description: The total number of schemas that match the given query
              schema:
                type: integer
            x-rate-limit-limit:
              description: The number of allowed requests in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-remaining:
              description: The number of calls remaining in the current rate-limit period
              schema:
                type: integer
            x-rate-limit-reset:
              description: The number of seconds remaining in the current rate-limit period
              schema:
                type: integer
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
      summary: List request task schemas
      tags:
      - Schemas
  /request-task-schemas/{schema_id}:
    get:
      description: Get a Legacy Request Task schema by ID
      operationId: getRequestTaskSchema
      parameters:
      - description: ID of schema to get
        in: path
        name: schema_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestTaskSchema'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
      summary: Get a Request Task schema by ID
      tags:
      - Schemas
  /workflow-task-schemas:
    get:
      description: List workflow task schemas
      operationId: listWorkflowTaskSchemas
      parameters:
      - in: query
        name: nextToken
        schema:
          type: string
      - in: query
        name: pageSize
        schema:
          default: 50
          maximum: 100
          minimum: 0
          nullable: false
          type: integer
      - description: 'Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

          '
        examples:
          and-range:
            summary: Filter for all models modified within a certain range using the AND operator.
            value: '> 2022-03-01 AND < 2022-04-01'
          full-rfc-3339-format:
            summary: Filter for modified models using the full RFC 3339 format
            value: '> 2020-12-31T21:07:14-05:00'
          greater-than-example:
            summary: Filter for all models modified after a certain date
            value: '> 2022-03-01'
        in: query
        name: modifiedAt
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTaskSchemasPaginatedList'
          description: OK
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not found
      summary: List workflow task schemas
      tags:
      - Schemas
  /workflow-task-schemas/{schema_id}:
    get:
      description: Get a workflow task schema
      operationId: getWorkflowTaskSchema
      parameters:
      - description: The workflow task schema ID
        in: path
        name: schema_id
        required: true
        schema:
          example: prstsch_KnR9iVum
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTaskSchema'
          description: OK
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not found
      summary: Get a workflow task schema
      tags:
      - Schemas
components:
  schemas:
    RequestTaskSchemasPaginatedList:
      properties:
        nextToken:
          type: string
        requestTaskSchemas:
          items:
            $ref: '#/components/schemas/RequestTaskSchema'
          readOnly: true
          type: array
      type: object
    RequestSchema:
      allOf:
      - $ref: '#/components/schemas/Schema'
      - properties:
          modifiedAt:
            description: DateTime the Legacy Request Schema was last modified
            example: '2017-04-18T05:55:48.685345+00:00'
            format: date-time
            type: string
          organization:
            description: 'The organization that owns the schema.

              '
            properties:
              handle:
                type: string
              id:
                type: string
              name:
                type: string
            type: object
          systemName:
            type: string
          type:
            enum:
            - request
            readOnly: true
            type: string
        type: object
    EntitySchemasPaginatedList:
      properties:
        entitySchemas:
          items:
            $ref: '#/components/schemas/EntitySchema'
          readOnly: true
          type: array
        nextToken:
          type: string
      type: object
    SchemaLinkFieldDefinition:
      allOf:
      - $ref: '#/components/schemas/FieldDefinition'
      - properties:
          schemaId:
            nullable: true
            type: string
          type:
            enum:
            - entity_link
            - entry_link
            - part_link
            - translation_link
            - batch_link
            - storage_link
            - assay_request_link
            - assay_result_link
            - assay_run_link
            type: string
        type: object
    EntrySchemaDetailed:
      allOf:
      - $ref: '#/components/schemas/RegistrySchema'
      - properties:
          modifiedAt:
            description: DateTime the Entry Schema was last modified
            example: '2017-04-18T05:55:48.685345+00:00'
            format: date-time
            type: string
          type:
            enum:
            - entry
            readOnly: true
            type: string
        type: object
    BoxSchemasList:
      properties:
        boxSchemas:
          items:
            $ref: '#/components/schemas/BoxSchema'
          readOnly: true
          type: array
      type: object
    BoxSchema:
      allOf:
      - $ref: '#/components/schemas/RegistrySchema'
      - properties:
          containerSchema:
            nullable: true
            properties:
              id:
                type: string
              name:
                type: string
            type: object
          height:
            type: number
          modifiedAt:
            description: DateTime the Box Schema was last modified
            example: '2017-04-18T05:55:48.685345+00:00'
            format: date-time
            type: string
          type:
            enum:
            - box
            readOnly: true
            type: string
          width:
            type: number
        type: object
    LocationSchema:
      allOf:
      - $ref: '#/components/schemas/RegistrySchema'
      - properties:
          modifiedAt:
            description: DateTime the Location Schema was last modified
            example: '2017-04-18T05:55:48.685345+00:00'
            format: date-time
            type: string
          type:
            enum:
            - location
            readOnly: true
            type: string
        type: object
    RequestSchemasPaginatedList:
      properties:
        nextToken:
          type: string
        requestSchemas:
          items:
            $ref: '#/components/schemas/RequestSchema'
          readOnly: true
          type: array
      type: object
    TeamSummary:
      allOf:
      - type: object
      - properties:
          id:
            type: string
          name:
            type: string
      - example:
          id: team_5cjIguqc
          name: Elion's Team
    UnitSummary:
      properties:
        id:
          example: unit_NyKvCSBC
          type: string
        name:
          example: meter
          type: string
        symbol:
          example: m
          type: string
        unitTypeId:
          example: qnty_7W2R1EFJ
          type: string
      type: object
    WorkflowTaskStatusLifecycle:
      properties:
        id:
          example: prstswf_123kjlkj
          type: string
        initialStatus:
          $ref: '#/components/schemas/WorkflowTaskStatus'
        name:
          example: Direct Completion
          type: string
        statuses:
          example:
          - displayName: Pending
            id: prsts_wQzUCsW0
            statusType: PENDING
          - displayName: In Progress
            id: prsts_fc0781
            statusType: IN_PROGRESS
          items:
            $ref: '#/components/schemas/WorkflowTaskStatus'
          type: array
        transitions:
          items:
            $ref: '#/components/schemas/WorkflowTaskStatusLifecycleTransition'
          type: array
      type: object
    SimpleFieldDefinition:
      allOf:
      - $ref: '#/components/schemas/FieldDefinition'
      - properties:
          type:
            enum:
            - dna_sequence_link
            - aa_sequence_link
            - custom_entity_link
            - mixture_link
            - molecule_link
            - blob_link
            - text
            - long_text
            - boolean
            - datetime
            - date
            - json
            type: string
        type: object
    EntitySchema:
      allOf:
      - $ref: '#/components/schemas/RegistrySchema'
      - properties:
          constraint:
            nullable: true
            properties:
              fieldDefinitionNames:
                items:
                  type: string
                type: array
              hasUniqueResidues:
                type: boolean
            type: object
          containableType:
            enum:
            - NONE
            - ENTITY
            - BATCH
            type: string
          containerNameTemplateParts:
            items:
              $ref: '#/components/schemas/NameTemplatePart'
            nullable: true
            type: array
          modifiedAt:
            description: DateTime the Entity Schema was last modified
            example: '2017-04-18T05:55:48.685345+00:00'
            format: date-time
            type: string
          nameTemplateParts:
            items:
              $ref: '#/components/schemas/NameTemplatePart'
            nullable: true
            type: array
          type:
            enum:
            - custom_entity
            - dna_sequence
            - rna_sequence
            - aa_sequence
            - mixture
            - dna_oligo
            - rna_oligo
            - molecule
            readOnly: true
            type: string
        type: object
      title: EntitySchema
    AssayResultSchema:
      allOf:
      - $ref: '#/components/schemas/BaseAssaySchema'
      - properties:
          modifiedAt:
            description: DateTime the Assay Result Schema was last modified
            example: '2017-04-18T05:55:48.685345+00:00'
            format: date-time
            type: string
          type:
            enum:
            - assay_result
            readOnly: true
            type: string
        type: object
    BatchSchemasPaginatedList:
      allOf:
      - $ref: '#/components/schemas/BatchSchemasList'
      - properties:
          nextToken:
            type: string
        type: object
    WorkflowTaskStatus:
      properties:
        displayName:
          description: The status label
          example: Pending
          readOnly: true
          type: string
        id:
          description: The ID of the workflow task status
          example: wfts_wQzUCsW0
          readOnly: true
          type: string
        statusType:
          description: The status type
          enum:
          - PENDING
          - IN_PROGRESS
          - FAILED
          - CANCELLED
          - INVALID
          - COMPLETED
          example: PENDING
          readOnly: true
          type: string
      type: object
    BoxSchemasPaginatedList:
      allOf:
      - $ref: '#/components/schemas/BoxSchemasList'
      - properties:
          nextToken:
            type: string
        type: object
    BadRequestError:
      properties:
        error:
          allOf:
          - $ref: '#/components/schemas/BaseError'
          - properties:
              type:
                enum:
                - invalid_request_error
                type: string
      type: object
    WorkflowFlowchartConfigSummary:
      properties:
        flowchartConfigVersionIds:
          description: The ID of all the versions of this flowchart config sorted chronologically from most recent (current) version to the least recent one
          items:
            example: wffccv_giVNQcAF
            type: string
          readOnly: true
          type: array
        id:
          description: The ID of the workflow flowchart config
          example: wffcc_giVNQcAF
          readOnly: true
          type: string
      type: object
    EntrySchemasPaginatedList:
      properties:
        entrySchemas:
          items:
            $ref: '#/components/schemas/EntrySchemaDetailed'
          readOnly: true
          type: array
        nextToken:
          type: string
      type: object
    PlateSchemasPaginatedList:
      allOf:
      - $ref: '#/components/schemas/PlateSchemasList'
      - properties:
          nextToken:
            type: string
        type: object
    WorkflowTaskSchemasPaginatedList:
      additionalProperties: false
      properties:
        nextToken:
          example: Im5ldyB0ZXN0Ig==
          type: string
        workflowTaskSchemas:
          items:
            $ref: '#/components/schemas/WorkflowTaskSchema'
          type: array
      type: object
    IntegerFieldDefinition:
      allOf:
      - $ref: '#/components/schemas/FieldDefinition'
      - properties:
          numericMax:
            nullable: true
            type: number
          numericMin:
            nullable: true
            type: number
          type:
            enum:
            - integer
            type: string
          unit:
            allOf:
            - $ref: '#/components/schemas/UnitSummary'
            nullable: true
        type: object
    BaseError:
      properties:
        message:
          type: string
        type:
          type: string
        userMessage:
          type: string
      type: object
    PlateSchemasList:
      properties:
        plateSchemas:
          items:
            $ref: '#/components/schemas/PlateSchema'
          readOnly: true
          type: array
      type: object
    WorkflowTaskSchemaBase:
      allOf:
      - $ref: '#/components/schemas/Schema'
      - properties:
          canSetAssigneeOnTaskCreation:
            description: Whether or not tasks of this schema can be created with a non-null assignee.
            type: boolean
          defaultCreationFolderId:
            description: ID of the default folder for creating workflow task groups
            nullable: true
            type: string
          defaultEntryExecutionFolderId:
            description: ID of the default folder for workflow task execution entries
            nullable: true
            type: string
          defaultResponsibleTeam:
            allOf:
            - $ref: '#/components/schemas/TeamSummary'
            nullable: true
          entryTemplateId:
            description: The ID of the template of the entries tasks of this schema will be executed into.
            example: tmpl_27b8fb
            nullable: true
            type: string
          isPropagateWatchersEnabled:
            description: Whether propagation of watchers has been enabled for this task schema.
            type: boolean
          prefix:
            description: The prefix for the displayId of tasks of this schema.
            type: string
          statusLifecycle:
            $ref: '#/components/schemas/WorkflowTaskStatusLifecycle'
          taskGroupPrefix:
            description: The prefix for the displayId of task groups containing tasks of this schema
            type: string
          workflowOutputSchema:
            allOf:
            - $ref: '#/components/schemas/WorkflowOutputSchema'
            nullable: true
    ArchiveRecord:
      properties:
        reason:
          example: Made in error
          type: string
      type: object
    FieldType:
      enum:
      - dna_sequence_link
      - aa_sequence_link
      - custom_entity_link
      - entity_link
      - mixture_link
      - molecule_link
      - dropdown
      - part_link
      - translation_link
      - aa_part_link
      - base_molecule_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
      type: string
    Schema:
      properties:
        archiveRecord:
          allOf:
          - $ref: '#/components/schemas/ArchiveRecord'
          nullable: true
        fieldDefinitions:
          items:
            oneOf:
            - $ref: '#/components/schemas/SimpleFieldDefinition'
            - $ref: '#/components/schemas/IntegerFieldDefinition'
            - $ref: '#/components/schemas/FloatFieldDefinition'
            - $ref: '#/components/schemas/DropdownFieldDefinition'
            - $ref: '#/components/schemas/SchemaLinkFieldDefinition'
          type: array
        id:
          type: string
        name:
          type: string
        type:
          type: string
      type: object
    AssayRunSchema:
      allOf:
      - $ref: '#/components/schemas/BaseAssaySchema'
      - properties:
          automationInputFileConfigs:
            items:
              properties:
                name:
                  type: string
              type: object
            type: array
          automationOutputFileConfigs:
            items:
              properties:
                name:
                  type: string
              type: object
            type: array
          modifiedAt:
            description: DateTime the Assay Run Schema was last modified
            example: '2017-04-18T05:55:48.685345+00:00'
            format: date-time
            type: string
          type:
            enum:
            - assay_run
            readOnly: true
            type: string
        type: object
    AssayResultSchemasPaginatedList:
      properties:
        assayResultSchemas:
          items:
            $ref: '#/components/schemas/AssayResultSchema'
          readOnly: true
          type: array
        nextToken:
          type: string
      type: object
    AssayRunSchemasPaginatedList:
      properties:
        assayRunSchemas:
          items:
            $ref: '#/components/schemas/AssayRunSchema'
          readOnly: true
          type: array
        nextToken:
          type: string
      type: object
    PartySummary:
      properties:
        handle:
          type: string
        id:
          type: string
        name:
          type: string
      type: object
    DropdownFieldDefinition:
      allOf:
      - $ref: '#/components/schemas/FieldDefinition'
      - properties:
          dropdownId:
            nullable: true
            type: string
          type:
            enum:
            - dropdown
            type: string
        type: object
    PlateSchema:
      allOf:
      - $ref: '#/components/schemas/RegistrySchema'
      - properties:
          containerSchema:
            nullable: true
            properties:
              id:
                type: string
              name:
                type: string
            type: object
          height:
            type: number
          modifiedAt:
            description: DateTime the Plate Schema was last modified
            example: '2017-04-18T05:55:48.685345+00:00'
            format: date-time
            type: string
          plateType:
            type: string
          type:
            enum:
            - plate
            readOnly: true
            type: string
          width:
            type: number
        type: object
    BatchSchema:
      allOf:
      - $ref: '#/components/schemas/RegistrySchema'
      - properties:
          entitySchemaId:
            type: string
          modifiedAt:
            description: DateTime the Batch Schema was last modified
            example: '2017-04-18T05:55:48.685345+00:00'
            format: date-time
            type: string
        type: object
    WorkflowOutputSchema:
      allOf:
      - $ref: '#/components/schemas/Schema'
      - properties:
          prefix:
            type: string
    LocationSchemasPaginatedList:
      allOf:
      - $ref: '#/components/schemas/LocationSchemasList'
      - properties:
          nextToken:
            type: string
        type: object
    WorkflowTaskSchema:
      allOf:
      - $ref: '#/components/schemas/WorkflowTaskSchemaBase'
      - properties:
          defaultResponsibleParties:
            description: Default list of users and teams that are responsible for tasks of this schema
            items:
              $ref: '#/components/schemas/PartySummary'
            type: array
          executionType:
            description: The method by which instances of this schema are executed
            enum:
            - DIRECT
            - ENTRY
            - FLOWCHART
            - PROCEDURE
            - PROCEDURE_METHOD
            - PROCEDURE_STEP
            type: string
          flowchartConfig:
            allOf:
            - $ref: '#/components/schemas/WorkflowFlowchartConfigSummary'
          modifiedAt:
            description: DateTime the Oligo was last modified.
            format: date-time
            readOnly: true
            type: string
    LocationSchemasList:
      properties:
        locationSchemas:
          items:
            $ref: '#/components/schemas/LocationSchema'
          readOnly: true
          type: array
      type: object
    FloatFieldDefinition:
      allOf:
      - $ref: '#/components/schemas/FieldDefinition'
      - properties:
          decimalPrecision:
            nullable: true
            type: number
          legalTextDropdownId:
            nullable: true
            type: string
          numericMax:
            nullable: true
            type: number
          numericMin:
            nullable: true
            type: number
          type:
            enum:
            - float
            type: string
          unit:
            allOf:
            - $ref: '#/components/schemas/UnitSummary'
            nullable: true
        type: object
    NameTemplatePart:
      properties:
        datetimeFormat:
          nullable: true
          type: string
        fieldId:
          nullable: true
          type: string
        text:
          nullable: true
          type: string
        type:
          type: string
      type: object
    RegistrySchema:
      allOf:
      - $ref: '#/components/schemas/Schema'
      - properties:
          prefix:
            type: string
          registryId:
            type: string
        type: object
    NotFoundError:
      properties:
        error:
          allOf:
          - $ref: '#/components/schemas/BaseError'
          - properties:
              invalidId:
                type: string
              type:
                enum:
                - invalid_request_error
                type: string
      type: object
    BaseAssaySchema:
      allOf:
      - $ref: '#/components/schemas/Schema'
      - properties:
          derivedFrom:
            deprecated: true
            description: This feature is no longer supported.
            nullable: true
            type: string
          organization:
            properties:
              handle:
                type: string
              id:
                type: string
              name:
                type: string
            type: object
          systemName:
            type: string
        type: object
    FieldDefinition:
      properties:
        archiveRecord:
          allOf:
          - $ref: '#/components/schemas/ArchiveRecord'
          nullable: true
        id:
          example: tsf_HXUnClU9
          type: string
        isMulti:
          type: boolean
        isRequired:
          type: boolean
        name:
          example: Resistance Gene
          type: string
        type:
          $ref: '#/components/schemas/FieldType'
      type: object
    RequestTaskSchema:
      allOf:
      - $ref: '#/components/schemas/Schema'
      - properties:
          modifiedAt:
            description: DateTime the Legacy Request Task Schema was last modified
            example: '2017-04-18T05:55:48.685345+00:00'
            format: date-time
            type: string
          organization:
            description: 'The organization that owns the schema.

              '
            properties:
              handle:
                type: string
              id:
                type: string
              name:
                type: string
            type: object
          systemName:
            type: string
          type:
            enum:
            - request_task
            readOnly: true
            type: string
        type: object
    ContainerSchemasPaginatedList:
      allOf:
      - $ref: '#/components/schemas/ContainerSchemasList'
      - properties:
          nextToken:
            type: string
        type: object
    BatchSchemasList:
      properties:
        batchSchemas:
          items:
            $ref: '#/components/schemas/BatchSchema'
          readOnly: true
          type: array
      type: object
    WorkflowTaskStatusLifecycleTransition:
      example:
        from:
          displayName: Pending
          id: prsts_wQzUCsW0
          statusType: PENDING
        to:
          displayName: In Progress
          id: prsts_fc0781
          statusType: IN_PROGRESS
      properties:
        from:
          $ref: '#/components/schemas/WorkflowTaskStatus'
        to:
          $ref: '#/components/schemas/WorkflowTaskStatus'
      type: object
    ContainerSchemasList:
      properties:
        containerSchemas:
          items:
            $ref: '#/components/schemas/ContainerSchema'
          readOnly: true
          type: array
      type: object
    ContainerSchema:
      allOf:
      - $ref: '#/components/schemas/RegistrySchema'
      - properties:
          modifiedAt:
            description: DateTime the Container Schema was last modified
            example: '2017-04-18T05:55:48.685345+00:00'
            format: date-time
            type: string
          type:
            enum:
            - container
            readOnly: true
            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: /api/v2/token
      type: oauth2
externalDocs:
  description: Additional API Documentation
  url: https://docs.benchling.com