BEbenchling
Workflow Task

Get WorkflowTask by ID

Get a single WorkflowTask by ID.

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

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

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