Create WorkflowTaskSchema | Benchling Documentation

curl -X POST https://{tenant_name}.benchling.com/api/v3/workflow-task-schema \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "executionType": "executionType",
  "organizationId": "organizationId",
  "prefix": "prefix",
  "taskGroupPrefix": "taskGroupPrefix"
}'

{
  "__typename": "__typename",
  "archiveReason": "archiveReason",
  "archived": true,
  "canOnlyBePartOfFlowchart": true,
  "canSetAssigneeOnTaskCreation": true,
  "createdAt": "createdAt",
  "defaultCreationFolder": {
    "__typename": "__typename",
    "id": "id"
  },
  "defaultEntryExecutionFolder": {
    "__typename": "__typename",
    "id": "id"
  },
  "entryTemplate": {
    "__typename": "__typename",
    "id": "id"
  },
  "executionType": "DIRECT",
  "fieldDefinitions": "fieldDefinitions",
  "id": "id",
  "isPropagateWatchersEnabled": true,
  "modifiedAt": "modifiedAt",
  "name": "name",
  "organization": {
    "__typename": "__typename",
    "id": "id"
  },
  "prefix": "prefix",
  "systemName": "systemName",
  "taskGroupInstructions": "taskGroupInstructions",
  "taskGroupPrefix": "taskGroupPrefix",
  "validationRules": "validationRules",
  "workflowOutputSchema": {
    "__typename": "__typename",
    "id": "id"
  }
}

Create WorkflowTaskSchema.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

executionTypestringRequired

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

organizationIdstringRequired

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

prefixstringRequired

The prefix for the displayId of tasks of this schema.

taskGroupPrefixstringRequired

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

canOnlyBePartOfFlowchartbooleanOptional

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

canSetAssigneeOnTaskCreationbooleanOptional

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

defaultCreationFolderIdstring or nullOptional

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

defaultEntryExecutionFolderIdstring or nullOptional

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

defaultResponsiblePartyIdslist of stringsOptional

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

fieldDefinitionslist of objectsOptional

The field definitions for the task schema.

isPropagateWatchersEnabledbooleanOptional

Whether watchers are propagated for tasks of this schema.

namestringOptional

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

systemNamestringOptional

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 or nullOptional

The instructions for task groups of this schema.

workflowOutputSchemaobject or nullOptional

The output schema configuration for tasks of this schema.

displayNamestringOptionalDeprecated

Deprecated. Use name instead.

Response

Created

__typenamestringOptional

archiveReasonstring or nullOptional

archivedbooleanOptional

canOnlyBePartOfFlowchartbooleanOptional

canSetAssigneeOnTaskCreationbooleanOptional

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

createdAtstringOptional

defaultCreationFolderobject or nullOptional

ID of the default folder for creating workflow task groups

defaultEntryExecutionFolderobject or nullOptional

ID of the default folder for workflow task execution entries

entryTemplateobject or nullOptional

The ID of the template of the entries tasks of this schema will be executed into.

executionTypeenumOptional

The method by which instances of this schema are executed

fieldDefinitionsstringOptionalformat: "uri"

idstringOptional

isPropagateWatchersEnabledbooleanOptional

modifiedAtstringOptional

namestringOptional

organizationobjectOptional

The organization that owns the schema.

prefixstringOptional

The prefix for the displayId of tasks of this schema.

systemNamestringOptional

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

taskGroupInstructionsstring or nullOptional

The instructions for task groups of this schema

taskGroupPrefixstringOptional

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

validationRulesstringOptionalformat: "uri"

workflowOutputSchemaobject or nullOptional

Errors

400

Workflow Task Schema Create Request Bad Request Error

403

Workflow Task Schema Create Request Forbidden Error

404

Workflow Task Schema Create Request Not Found Error

409

Workflow Task Schema Create Request Conflict Error

429

Workflow Task Schema Create Request Too Many Requests Error

500

Workflow Task Schema Create Request Internal Server Error

Authentication

Headers

Request

Response

Errors