---
title: "Get a workflow task schema"
method: GET
path: "/workflow-task-schemas/{schema_id}"
tags: ["schemas"]
---

# Get a workflow task schema

`GET /workflow-task-schemas/{schema_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com/api/v2`
- URL: `https://{tenant_name}.benchling.com/api/v2/workflow-task-schemas/{schema_id}`
- Auth: HTTP bearer

Get a workflow task schema

## Path parameters

- `schema_id` string, required

## Response `200`

OK

- WorkflowTaskSchema
  - `archiveRecord` ArchiveRecord
    - `reason` string
  - `fieldDefinitions` WorkflowTaskSchemaFieldDefinitionsItems[]
    - union
      - SimpleFieldDefinition
        - `archiveRecord` ArchiveRecord
          - `reason` string
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean
        - `name` string
        - `type` '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'
      - IntegerFieldDefinition
        - `archiveRecord` ArchiveRecord
          - `reason` string
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean
        - `name` string
        - `type` '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'
        - `numericMax` number, double, nullable
        - `numericMin` number, double, nullable
        - `unit` UnitSummary
          - `id` string
          - `name` string
          - `symbol` string
          - `unitTypeId` string
      - FloatFieldDefinition
        - `archiveRecord` ArchiveRecord
          - `reason` string
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean
        - `name` string
        - `type` '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'
        - `decimalPrecision` number, double, nullable
        - `legalTextDropdownId` string, nullable
        - `numericMax` number, double, nullable
        - `numericMin` number, double, nullable
        - `unit` UnitSummary
          - `id` string
          - `name` string
          - `symbol` string
          - `unitTypeId` string
      - DropdownFieldDefinition
        - `archiveRecord` ArchiveRecord
          - `reason` string
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean
        - `name` string
        - `type` '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'
        - `dropdownId` string, nullable
      - SchemaLinkFieldDefinition
        - `archiveRecord` ArchiveRecord
          - `reason` string
        - `id` string
        - `isMulti` boolean
        - `isRequired` boolean
        - `name` string
        - `type` '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'
        - `schemaId` string, nullable
  - `id` string
  - `name` string
  - `type` string
  - `canSetAssigneeOnTaskCreation` boolean: Whether or not tasks of this schema can be created with a non-null assignee.
  - `defaultCreationFolderId` string, nullable: ID of the default folder for creating workflow task groups
  - `defaultEntryExecutionFolderId` string, nullable: ID of the default folder for workflow task execution entries
  - `defaultResponsibleTeam` TeamSummary
    - `id` string
    - `name` string
  - `entryTemplateId` string, nullable: The ID of the template of the entries tasks of this schema will be executed into.
  - `isPropagateWatchersEnabled` boolean: Whether propagation of watchers has been enabled for this task schema.
  - `prefix` string: The prefix for the displayId of tasks of this schema.
  - `statusLifecycle` WorkflowTaskStatusLifecycle
    - `id` string
    - `initialStatus` WorkflowTaskStatus
      - `displayName` string: The status label
      - `id` string: The ID of the workflow task status
      - `statusType` 'PENDING' | 'IN_PROGRESS' | 'FAILED' | 'CANCELLED' | 'INVALID' | 'COMPLETED': The status type
    - `name` string
    - `statuses` WorkflowTaskStatus[]
      - `displayName` string: The status label
      - `id` string: The ID of the workflow task status
      - `statusType` 'PENDING' | 'IN_PROGRESS' | 'FAILED' | 'CANCELLED' | 'INVALID' | 'COMPLETED': The status type
    - `transitions` WorkflowTaskStatusLifecycleTransition[]
      - `from` WorkflowTaskStatus
        - `displayName` string: The status label
        - `id` string: The ID of the workflow task status
        - `statusType` 'PENDING' | 'IN_PROGRESS' | 'FAILED' | 'CANCELLED' | 'INVALID' | 'COMPLETED': The status type
      - `to` WorkflowTaskStatus
        - `displayName` string: The status label
        - `id` string: The ID of the workflow task status
        - `statusType` 'PENDING' | 'IN_PROGRESS' | 'FAILED' | 'CANCELLED' | 'INVALID' | 'COMPLETED': The status type
  - `taskGroupPrefix` string: The prefix for the displayId of task groups containing tasks of this schema
  - `workflowOutputSchema` WorkflowOutputSchema
    - `archiveRecord` ArchiveRecord
      - `reason` string
    - `fieldDefinitions` WorkflowOutputSchemaFieldDefinitionsItems[]
      - union
        - SimpleFieldDefinition
          - `archiveRecord` ArchiveRecord
            - `reason` string
          - `id` string
          - `isMulti` boolean
          - `isRequired` boolean
          - `name` string
          - `type` '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'
        - IntegerFieldDefinition
          - `archiveRecord` ArchiveRecord
            - `reason` string
          - `id` string
          - `isMulti` boolean
          - `isRequired` boolean
          - `name` string
          - `type` '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'
          - `numericMax` number, double, nullable
          - `numericMin` number, double, nullable
          - `unit` UnitSummary
            - `id` string
            - `name` string
            - `symbol` string
            - `unitTypeId` string
        - FloatFieldDefinition
          - `archiveRecord` ArchiveRecord
            - `reason` string
          - `id` string
          - `isMulti` boolean
          - `isRequired` boolean
          - `name` string
          - `type` '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'
          - `decimalPrecision` number, double, nullable
          - `legalTextDropdownId` string, nullable
          - `numericMax` number, double, nullable
          - `numericMin` number, double, nullable
          - `unit` UnitSummary
            - `id` string
            - `name` string
            - `symbol` string
            - `unitTypeId` string
        - DropdownFieldDefinition
          - `archiveRecord` ArchiveRecord
            - `reason` string
          - `id` string
          - `isMulti` boolean
          - `isRequired` boolean
          - `name` string
          - `type` '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'
          - `dropdownId` string, nullable
        - SchemaLinkFieldDefinition
          - `archiveRecord` ArchiveRecord
            - `reason` string
          - `id` string
          - `isMulti` boolean
          - `isRequired` boolean
          - `name` string
          - `type` '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'
          - `schemaId` string, nullable
    - `id` string
    - `name` string
    - `type` string
    - `prefix` string
  - `defaultResponsibleParties` PartySummary[]: Default list of users and teams that are responsible for tasks of this schema
    - `handle` string
    - `id` string
    - `name` string
  - `executionType` 'DIRECT' | 'ENTRY' | 'FLOWCHART' | 'PROCEDURE' | 'PROCEDURE_METHOD' | 'PROCEDURE_STEP': The method by which instances of this schema are executed
  - `flowchartConfig` WorkflowFlowchartConfigSummary
    - `flowchartConfigVersionIds` string[]: The ID of all the versions of this flowchart config sorted chronologically from most recent (current) version to the least recent one
    - `id` string: The ID of the workflow flowchart config
  - `modifiedAt` string, date-time: DateTime the Oligo was last modified.

## Other responses

- `404`: Not found

---

[API](https://skmtc.dev/benchling/apis/benchling-api-2.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api-2/revisions/01d2fa8523cd?raw)