Update WorkflowTask

PATCH

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

PATCH

/api/v3/workflow-task/:workflow_task_id

curl -X PATCH https://{tenant_name}.benchling.com/api/v3/workflow-task/workflow_task_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "__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"
  }
}

Update WorkflowTask.

Authentication

AuthorizationBearer

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

Path parameters

workflow_task_idstringRequired

ID of the WorkflowTask.

Request

This endpoint expects an object.

assigneeIdstring or nullOptional

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

scheduledOndate or nullOptional

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

schemaFieldsmap from strings to objectsOptional

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

statusenumOptional

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.

studyIdslist of stringsOptional

IDs of studies to associate with this task.

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 Update Request Bad Request Error

403

Workflow Task Update Request Forbidden Error

404

Workflow Task Update Request Not Found Error

409

Workflow Task Update Request Conflict Error

429

Workflow Task Update Request Too Many Requests Error

500

Workflow Task Update Request Internal Server Error