BEbenchling
Workflow Task Schema

Update WorkflowTaskSchema

Update WorkflowTaskSchema.

patch/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.

Headers

EARLY-ACCESSstring

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

Request body

archiveReasonstring

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedboolean

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

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.

isPropagateWatchersEnabledboolean

Whether watchers are propagated for tasks of this schema.

namestring

Updated user-facing name. When provided, must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.

prefixstring

The prefix for the displayId of tasks of this schema.

systemNamestring

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. Changing it requires warehouse table-name changes to be enabled for the caller; otherwise the update fails with a validation error. Supplying the schema's exact current system name always succeeds.

taskGroupInstructionsstring nullable

The instructions for task groups of this schema.

taskGroupPrefixstring

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

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 2 revisions of this API.