BEbenchling
Workflow Task

Update WorkflowTask

Update WorkflowTask.

patch/api/v3/workflow-task/{workflow_task_id}

Request

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

Path parameters

workflow_task_idstring required

ID of the WorkflowTask.

Request body

assigneeIdstring nullable

The ID of the user to assign this task to. Set to null to unassign.

scheduledOnstring date nullable

The date on which the task is scheduled to be executed. Set to null to clear.

schemaFieldsobject

Schema field values for the task, keyed by field name.

status'PENDING' | 'PLANNED' | 'IN_PROGRESS' | 'FAILED' | 'CANCELLED' | 'INVALID' | 'COMPLETED' | 'COMPLETED_AFTER_REVIEW' | 'ACTIVE' | 'SKIPPED' | 'NOT_READY' | 'READY'

The status to transition this task to. Must be a valid transition in the task schema's status lifecycle. Cannot be updated alongside schemaFields, assigneeId, or scheduledOn.

studyIdsstring[]

IDs of studies to associate with this task.

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
childTasksstring uri nullable

All descendants of a root task in a flowchart. This will be empty if this task is not a root task.

createdAtstring datetime
displayIdstring nullable

User-friendly ID of the workflow task

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

The method by which the task of the workflow is executed

idstring
modifiedAtstring datetime
namestring
rootWorkflowTasksstring uri nullable

All root tasks of the flowchart(s) that this task is a part of. A task may be associated with more than one root task when branches rooted at different flowchart tasks are pooled together.

scheduledOnstring date nullable

The date on which the task is scheduled to be executed

status'PENDING' | 'PLANNED' | 'IN_PROGRESS' | 'FAILED' | 'CANCELLED' | 'INVALID' | 'COMPLETED' | 'COMPLETED_AFTER_REVIEW' | 'ACTIVE' | 'SKIPPED' | 'NOT_READY' | 'READY'

The status of this task

workflowOutputsstring uri nullable

The outputs of this task

Changes

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