Skip to navigation

Update WorkflowTask

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.
reasonForChangeobjectOptional

Reason for change applied to the entire request. Only relevant to tenants with Data Modifications enabled, where it may be required to update or delete items and is validated against the tenant’s configured reasons. Tenants without Data Modifications enabled can omit it; if supplied, it is not validated.

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

OK
__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
createdAtstringOptionalformat: "datetime"
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
modifiedAtstringOptionalformat: "datetime"
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
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error