Workflow Task Schema

Create WorkflowTaskSchema

Create WorkflowTaskSchema.

post/api/v3/workflow-task-schema

Request

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

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Request body

canOnlyBePartOfFlowchartboolean

Whether tasks of this schema can only exist as part of a flowchart.

canSetAssigneeOnTaskCreationboolean

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

defaultCreationFolderIdstring nullable

API ID of the default folder for creating workflow task groups.

defaultEntryExecutionFolderIdstring nullable

API ID of the default folder for workflow task execution entries.

defaultResponsiblePartyIdsstring[]

API IDs of the default responsible parties for tasks of this schema.

displayNamestring

Deprecated. Use name instead.

executionTypestring required

The method by which instances of this schema are executed (e.g., DIRECT, ENTRY, FLOWCHART).

isPropagateWatchersEnabledboolean

Whether watchers are propagated for tasks of this schema.

namestring

The user-facing name of the schema. Must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.

organizationIdstring required

The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller.

prefixstring required

The prefix for the displayId of tasks of this schema.

systemNamestring

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.

taskGroupInstructionsstring nullable

The instructions for task groups of this schema.

taskGroupPrefixstring required

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

Response

Created

__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.