BEbenchling
Workflow Task Schema

Get WorkflowTaskSchema by ID

Get a single WorkflowTaskSchema by ID.

get/api/v3/workflow-task-schema/{workflow_task_schema_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

workflow_task_schema_idstring required

ID of the WorkflowTaskSchema.

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
canOnlyBePartOfFlowchartboolean
canSetAssigneeOnTaskCreationboolean

Whether or not tasks of this schema can be created with a non-null assignee.

createdAtstring datetime
executionType'DIRECT' | 'ENTRY' | 'FLOWCHART' | 'PROCEDURE' | 'PROCEDURE_METHOD' | 'PROCEDURE_STEP' | 'PIPELINE'

The method by which instances of this schema are executed

fieldDefinitionsstring uri
idstring
isPropagateWatchersEnabledboolean
modifiedAtstring datetime
namestring
prefixstring

The prefix for the displayId of tasks of this schema.

systemNamestring

A unique, stable identifier for this schema used for programmatic access and integrations.

taskGroupInstructionsstring nullable

The instructions for task groups of this schema

taskGroupPrefixstring

The prefix for the displayId of task groups containing tasks of this schema

validationRulesstring uri

Changes

No recorded changes to this operation across all 1 revision of this API.