> This page is for Developer Documentation. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.benchling.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.benchling.com/_mcp/server. # Batch create WorkflowTaskSchema POST https://{tenant_name}.benchling.com/api/v3/workflow-task-schema:batch-create Content-Type: application/json Batch create WorkflowTaskSchema synchronously in one transaction. Maximum 25 items per request. Reference: https://docs.benchling.com/docs/api/benchling-api/workflow-task-schema/batchcreate ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Headers - `EARLY-ACCESS` (string, optional) — Set to true to access beta operations via /api/v3. ### Body (application/json) This endpoint expects an object. - `items` (list of CreateWorkflowTaskSchemaInput, required) ## Response ### 201 Created - `items` (list of WorkflowTaskSchema, required) ## Errors ### 400 Workflow Task Schema Batch Create Request Bad Request Error Bad Request - `detail` (GeneralErrorDetail, required, nullable) - `instance` (string, required) - `status` (integer, required) - `title` (string, required, nullable) - `type` (string, required) - `invalidId` (string, optional) ### 403 Workflow Task Schema Batch Create Request Forbidden Error Forbidden - `detail` (GeneralErrorDetail, required, nullable) - `instance` (string, required) - `status` (integer, required) - `title` (string, required, nullable) - `type` (string, required) - `invalidId` (string, optional) ### 404 Workflow Task Schema Batch Create Request Not Found Error Not Found - `detail` (GeneralErrorDetail, required, nullable) - `instance` (string, required) - `status` (integer, required) - `title` (string, required, nullable) - `type` (string, required) - `invalidId` (string, optional) ### 409 Workflow Task Schema Batch Create Request Conflict Error Conflict - `detail` (GeneralErrorDetail, required, nullable) - `instance` (string, required) - `status` (integer, required) - `title` (string, required, nullable) - `type` (string, required) - `invalidId` (string, optional) ### 429 Workflow Task Schema Batch Create Request Too Many Requests Error Too Many Requests - `detail` (TooManyRequestsErrorBodyDetail, required, nullable) - `instance` (string, required) - `status` (integer, required) - `title` (string, required, nullable) - `type` (string, required) - `invalidId` (string, optional) - `violated-policies` (list of enum, optional) — The budget policies that rejected the request, in canonical order: `user`, `integration`, then `tenant`. - Allowed values: `user`, `integration`, `tenant` ### 500 Workflow Task Schema Batch Create Request Internal Server Error Internal Server Error - `detail` (InternalServerErrorBodyDetail, required, nullable) - `instance` (string, required) - `status` (integer, required) - `title` (string, required, nullable) - `type` (string, required) - `errorId` (string, optional) ## Types ### CreateWorkflowTaskSchemaInput - `executionType` (string, required) — The method by which instances of this schema are executed (e.g., DIRECT, ENTRY, FLOWCHART). - `organizationId` (string, required) — The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller. - `prefix` (string, required) — The prefix for the displayId of tasks of this schema. - `taskGroupPrefix` (string, required) — The prefix for the displayId of task groups containing tasks of this schema. - `canOnlyBePartOfFlowchart` (boolean, optional) — Whether tasks of this schema can only exist as part of a flowchart. - `canSetAssigneeOnTaskCreation` (boolean, optional) — Whether tasks of this schema can be created with a non-null assignee. - `defaultCreationFolderId` (string, optional, nullable) — API ID of the default folder for creating workflow task groups. - `defaultEntryExecutionFolderId` (string, optional, nullable) — API ID of the default folder for workflow task execution entries. - `defaultResponsiblePartyIds` (list of string, optional) — API IDs of the default responsible parties for tasks of this schema. - `fieldDefinitions` (list of CreateWorkflowTaskSchemaInputFieldDefinitionsItem, optional) — The field definitions for the task schema. - `isPropagateWatchersEnabled` (boolean, optional) — Whether watchers are propagated for tasks of this schema. - `name` (string, optional) — The user-facing name of the schema. Must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization. - `systemName` (string, optional) — 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. - `taskGroupInstructions` (string, optional, nullable) — The instructions for task groups of this schema. - `workflowOutputSchema` (CreateWorkflowOutputSchemaInput, optional, nullable) — The output schema configuration for tasks of this schema. - `displayName` (string, optional, deprecated) — Deprecated. Use name instead. ### WorkflowTaskSchema A configuration template that defines the structure and behavior of `WorkflowTask` instances. Each schema specifies an `executionType` (direct, entry, or flowchart) and custom `fieldDefinitions` for task data. Schemas belong to an `Organization` and can optionally reference an `entryTemplate` for entry-based execution. The `prefix` and `taskGroupPrefix` fields define the human-readable ID format for tasks and task groups. Default folders can be configured via `defaultCreationFolder` and `defaultEntryExecutionFolder`. Schemas support `responsibleParties` for default assignment. The associated `workflowOutputSchema` defines the structure of outputs produced by tasks of this schema. - `__typename` (string, optional) - `archiveReason` (string, optional, nullable) - `archived` (boolean, optional) - `canOnlyBePartOfFlowchart` (boolean, optional) - `canSetAssigneeOnTaskCreation` (boolean, optional) — Whether or not tasks of this schema can be created with a non-null assignee. - `createdAt` (string, optional) - `defaultCreationFolder` (FolderRef, optional, nullable) — ID of the default folder for creating workflow task groups - `defaultEntryExecutionFolder` (FolderRef, optional, nullable) — ID of the default folder for workflow task execution entries - `entryTemplate` (EntryTemplateRef, optional, nullable) — The ID of the template of the entries tasks of this schema will be executed into. - `executionType` (enum, optional) — The method by which instances of this schema are executed - Allowed values: `DIRECT`, `ENTRY`, `FLOWCHART`, `PROCEDURE`, `PROCEDURE_METHOD`, `PROCEDURE_STEP`, `PIPELINE` - `fieldDefinitions` (string, optional) - `id` (string, optional) - `isPropagateWatchersEnabled` (boolean, optional) - `modifiedAt` (string, optional) - `name` (string, optional) - `organization` (OrganizationRef, optional) — The organization that owns the schema. - `prefix` (string, optional) — The prefix for the displayId of tasks of this schema. - `systemName` (string, optional) — A unique, stable identifier for this schema used for programmatic access and integrations. - `taskGroupInstructions` (string, optional, nullable) — The instructions for task groups of this schema - `taskGroupPrefix` (string, optional) — The prefix for the displayId of task groups containing tasks of this schema - `validationRules` (string, optional) - `workflowOutputSchema` (WorkflowOutputSchemaRef, optional, nullable) ### GeneralErrorDetail ### TooManyRequestsErrorBodyDetail ### InternalServerErrorBodyDetail ### CreateWorkflowTaskSchemaInputFieldDefinitionsItem - `type`: `BOOLEAN` - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `DATE` - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `DATE_TIME` - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `DECIMAL` - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `displayPrecision` (integer, optional) — The number of decimal places to display (0 to 10). - `numericMax` (double, optional) — The maximum allowed value, inclusive. - `numericMin` (double, optional) — The minimum allowed value, inclusive. - `unitId` (string, optional) — The API ID of the unit to associate with this field. - `type`: `INTEGER` - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `numericMax` (double, optional) — The maximum allowed value, inclusive. - `numericMin` (double, optional) — The minimum allowed value, inclusive. - `unitId` (string, optional) — The API ID of the unit to associate with this field. - `type`: `LONG_TEXT` - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `TEXT` - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `AA_SEQUENCE_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any AA sequence. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `PROTEIN_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any antibody. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `REQUEST_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any assay request. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `RESULT_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any assay result. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `RUN_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any assay run. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `ATTACHMENT_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `CUSTOM_ENTITY_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any custom entity. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `DNA_OLIGO_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required) — The API ID of the schema/interface that linked items must belong to. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `DNA_SEQUENCE_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any DNA sequence. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `DROPDOWN` - `dropdownId` (string, required) — The API ID of the Dropdown that defines the available options. - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `ENTITY_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `ENTRY_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `EQUIPMENT_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any equipment. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `FIELDSET_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required) — The API ID of the schema/interface that linked items must belong to. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `MIXTURE_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any mixture. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `MOLECULE_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any molecule. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `OLIGO_CONJUGATE_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any oligo conjugate. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `OLIGO_DUPLEX_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any oligo duplex. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `RNA_SEQUENCE_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required) — The API ID of the schema/interface that linked items must belong to. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `RNA_OLIGO_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required) — The API ID of the schema/interface that linked items must belong to. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `STORAGE_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any storage location. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `SYSTEM_CATEGORY_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required) — The API ID of the schema/interface that linked items must belong to. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. ### CreateWorkflowOutputSchemaInput - `prefix` (string, required) — The prefix for the displayId of workflow outputs of this schema. - `fieldDefinitions` (list of CreateWorkflowOutputSchemaInputFieldDefinitionsItem, optional) — The field definitions for the output schema. ### FolderRef - `__typename` (string, optional) - `id` (string, optional) ### EntryTemplateRef - `__typename` (string, optional) - `id` (string, optional) ### OrganizationRef - `__typename` (string, optional) - `id` (string, optional) ### WorkflowOutputSchemaRef - `__typename` (string, optional) - `id` (string, optional) ### CreateWorkflowOutputSchemaInputFieldDefinitionsItem - `type`: `BOOLEAN` - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `DATE` - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `DATE_TIME` - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `DECIMAL` - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `displayPrecision` (integer, optional) — The number of decimal places to display (0 to 10). - `numericMax` (double, optional) — The maximum allowed value, inclusive. - `numericMin` (double, optional) — The minimum allowed value, inclusive. - `unitId` (string, optional) — The API ID of the unit to associate with this field. - `type`: `INTEGER` - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `numericMax` (double, optional) — The maximum allowed value, inclusive. - `numericMin` (double, optional) — The minimum allowed value, inclusive. - `unitId` (string, optional) — The API ID of the unit to associate with this field. - `type`: `LONG_TEXT` - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `TEXT` - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `AA_SEQUENCE_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any AA sequence. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `PROTEIN_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any antibody. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `REQUEST_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any assay request. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `RESULT_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any assay result. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `RUN_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any assay run. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `ATTACHMENT_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `CUSTOM_ENTITY_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any custom entity. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `DNA_OLIGO_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required) — The API ID of the schema/interface that linked items must belong to. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `DNA_SEQUENCE_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any DNA sequence. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `DROPDOWN` - `dropdownId` (string, required) — The API ID of the Dropdown that defines the available options. - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `ENTITY_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `ENTRY_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `EQUIPMENT_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any equipment. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `FIELDSET_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required) — The API ID of the schema/interface that linked items must belong to. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `MIXTURE_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any mixture. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `MOLECULE_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any molecule. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `OLIGO_CONJUGATE_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any oligo conjugate. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `OLIGO_DUPLEX_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any oligo duplex. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `RNA_SEQUENCE_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required) — The API ID of the schema/interface that linked items must belong to. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `RNA_OLIGO_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required) — The API ID of the schema/interface that linked items must belong to. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `isParent` (boolean, optional) — When true, indicates a parent-child relationship used in the registry's lot-numbering functionality. - `type`: `STORAGE_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required, nullable) — The API ID of the schema to constrain links to, or null to allow links to any storage location. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. - `type`: `SYSTEM_CATEGORY_LINK` - `isMulti` (boolean, required) — When true, multiple linked values are allowed. - `isRequired` (boolean, required) — When true, a value must be provided for this field. - `linkDefinitionId` (string, required) — The API ID of the schema/interface that linked items must belong to. - `name` (string, required) — The user-facing display name of this field definition. Must be unique within the schema. - `systemName` (string, required) — The machine-readable identifier used as the warehouse column name. Must be unique within the schema. - `description` (string, optional) — An optional user-provided description of this field definition. ## Examples **Request** ```json { "items": [ { "executionType": "executionType", "organizationId": "organizationId", "prefix": "prefix", "taskGroupPrefix": "taskGroupPrefix" } ] } ``` **Response** ```json { "items": [ { "__typename": "__typename", "archiveReason": "archiveReason", "archived": true, "canOnlyBePartOfFlowchart": true, "canSetAssigneeOnTaskCreation": true, "createdAt": "createdAt", "executionType": "DIRECT", "fieldDefinitions": "fieldDefinitions", "id": "id", "isPropagateWatchersEnabled": true, "modifiedAt": "modifiedAt", "name": "name", "prefix": "prefix", "systemName": "systemName", "taskGroupInstructions": "taskGroupInstructions", "taskGroupPrefix": "taskGroupPrefix", "validationRules": "validationRules" } ] } ``` **SDK Code** ```python import requests url = "https://{tenant_name}.benchling.com/api/v3/workflow-task-schema:batch-create" payload = { "items": [ { "executionType": "executionType", "organizationId": "organizationId", "prefix": "prefix", "taskGroupPrefix": "taskGroupPrefix" } ] } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://{tenant_name}.benchling.com/api/v3/workflow-task-schema:batch-create'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"items":[{"executionType":"executionType","organizationId":"organizationId","prefix":"prefix","taskGroupPrefix":"taskGroupPrefix"}]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ```