Get WorkflowTask by ID

GET

https://{tenant_name}.benchling.com/api/v3/workflow-task/:workflow_task_id

GET

/api/v3/workflow-task/:workflow_task_id

curl https://{tenant_name}.benchling.com/api/v3/workflow-task/workflow_task_id \
     -H "Authorization: Bearer <token>"

{
  "__typename": "__typename",
  "archiveReason": "archiveReason",
  "archived": true,
  "assignee": {
    "__typename": "__typename",
    "id": "id"
  },
  "childTasks": "childTasks",
  "clonedFrom": {
    "__typename": "__typename",
    "id": "id"
  },
  "createdAt": "createdAt",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "displayId": "displayId",
  "executionEntry": {
    "__typename": "__typename",
    "id": "id"
  },
  "executionType": "DIRECT",
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "rootWorkflowTasks": "rootWorkflowTasks",
  "scheduledOn": "2023-01-15",
  "schema": {
    "__typename": "__typename",
    "id": "id"
  },
  "schemaFields": [
    {
      "__typename": "__typename",
      "id": "id",
      "linkedEntityId": "linkedEntityId"
    }
  ],
  "status": "PENDING",
  "workflowOutputs": "workflowOutputs",
  "workflowTaskGroup": {
    "__typename": "__typename",
    "id": "id"
  }
}

Get a single WorkflowTask by ID.

Authentication

AuthorizationBearer

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

Path parameters

workflow_task_idstringRequired

ID of the WorkflowTask.

Query parameters

returningstringOptional

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

omitstringOptional

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

Response

__typenamestringOptional

archiveReasonstring or nullOptional

archivedbooleanOptional

assigneeobject or nullOptional

The assignee of this task

childTasksstring or nullOptionalformat: "uri"

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

clonedFromobject or nullOptional

The task that this task was cloned from

createdAtstringOptional

creatorobjectOptional

displayIdstring or nullOptional

User-friendly ID of the workflow task

executionEntryobject or nullOptional

The entry that this task is executed in. This is only non-null for tasks with an ENTRY execution type.

executionTypeenumOptional

The method by which the task of the workflow is executed

idstringOptional

modifiedAtstringOptional

namestringOptional

rootWorkflowTasksstring or nullOptionalformat: "uri"

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.

scheduledOndate or nullOptional

The date on which the task is scheduled to be executed

schemaobjectOptional

schemaFieldslist of objects or nullOptional

statusenumOptional

The status of this task

workflowOutputsstring or nullOptionalformat: "uri"

The outputs of this task

workflowTaskGroupobjectOptional

The task group that this task is a part of

Errors

400

Workflow Task Get Request Bad Request Error

403

Workflow Task Get Request Forbidden Error

404

Workflow Task Get Request Not Found Error

429

Workflow Task Get Request Too Many Requests Error

500

Workflow Task Get Request Internal Server Error