REST API authorization for task actions

Edit online

For each task action, the implemented authorization is determined by a set of associated authorization roles and action policies. You can enable users to perform actions by assigning them to the roles or policies.

Table 1. REST API authorization for task actions
Task action	Eligible roles	Enabled for task states	Preconditions	API Documentation
Retrieve task details (GET) `/task/{taskId}?parts={string}[{\|string\|string}]` Task action: `ACTION_VIEW_TASK_DETAILS`	IBM® Business Automation Workflow (Business Automation Workflow) administrator Process application administrator Instance owner Task team manager Task owner Potential task owner Collaborator	Any		Human task details
Retrieve task data (GET) `/task/{taskID}?action={string}&fields={string}[&failureMode={string}][&parts={string}]` Task action: `ACTION_GETTASK`	Business Automation Workflow administrator Process application administrator Instance owner Task team manager Task owner Potential task owner Collaborator	Any		Retrieve one or more variables within a running task
Retrieve task client settings (GET) `/task/{taskId}/clientSettings/{type}` Task action: `ACTION_VIEW_TASK`	Instance owner Task owner Potential task owner (if task owner is not set) Collaborator	New/Received Closed		Retrieve client settings for human task instance
Set task data (PUT) `/task/{taskID}?action={string}&params={string}[&failureMode={string}]` Task action: `ACTION_SETTASK`	Business Automation Workflow administrator Process application administrator Task owner Collaborator	New/Received and assigned to user		Set task data
Claim a task (PUT) `/task/{taskID}?action={string}` Task action: `ACTION_CLAIM`	Business Automation Workflow administrator Process application administrator Potential task owner (if task owner is not set)	New/Received and not assigned		Claim a task
Invite a user to task (POST) `/task/{taskID}?action={string}&user={string}[&message={string}]` Task action: `ACTION_INVITE`	Task owner	New/Received	Users that can be invited: Experts, recommended experts, task team members	Invite task collaboration
Start a task (PUT) `/task/{taskID}?action={string}` Task action: `ACTION_VIEW_TASK`	Business Automation Workflow administrator Process application administrator Task owner Potential task owner (if task owner is not set) Collaborator	New/Received		Start a task
Finish a task (PUT) `/task/{taskID}?action={string}&parts={string}[&params={string}]` Task action: `ACTION_COMPLETE`	Business Automation Workflow administrator Process application administrator Instance owner Task owner	New/Received		Finish/complete task
Complete a task (PUT) `/task/{taskID}?action={string}&parts={string}[&params={string}]` Task action: `ACTION_COMPLETE`	Business Automation Workflow administrator Process application administrator Instance owner Task owner	New/Received		Finish/complete task
Update a task (PUT) `/task/{taskID}?action={string}[&dueDate={string}][&priority={string}][&parts={string}]` Task action: `ACTION_UPDATEDUEDATE` `ACTION_UPDATEPRIORITY`	Business Automation Workflow administrator Process application administrator Instance owner Task team manager Authenticated user dueDate restricted by policy `ACTION_CHANGE_TASK_DUE_DATE` (default: tw_admins) priority restricted by policy `ACTION_CHANGE_TASK_PRIORITY` (default: tw_admins) If an action policy specifies one or more user groups, authorization is restricted to users who belong to these groups. By default, only users who belong to the tw_admin group are authorized.	New/Received		Update task
Assign a task to a user (PUT) `/task/{taskID}?action={string}&toUser={string}[&parts={string}]` Task action: `ACTION_REASSIGNTOUSER`	Business Automation Workflow administrator Process application administrator Instance owner Task team manager Task owner Restricted by action policy `ACTION_REASSIGN_TASK_USER_ROLE`	New/Received	Task team manager can reassign to any authenticated user Task owner can reassign to potential owners	Assign task to user
Assign a task to a group (PUT) `/task/{taskID}?action={string}&toGroup={string}[&parts={string}]` Task action: `ACTION_REASSIGNTOGROUP`	Business Automation Workflow administrator Process application administrator Instance owner Task team manager	New/Received	Business Automation Workflow administrator, process application administrator, instance owner, or task team manager can reassign to any authenticated group	Assign task to group
Assign a task to me (PUT) `/task/{taskID}?action={string}&toMe={boolean}[&parts={string}]` Task action: `ACTION_ASSIGN_TASK`	Business Automation Workflow administrator Process application administrator Potential task owner (if task owner is not set) Restricted by action policy `ACTION_ASSIGN_TASK`	New/Received (if task is not assigned)		Assign task to me
Assign a task back (PUT) `/task/{taskID}?action={string}&back={boolean}[&parts={string}]` Task action: `ACTION_REASSIGN_TASK` `ACTION_CANCELCLAIM_ASSUMING_REASSIGN`	Business Automation Workflow administrator Process application administrator Instance owner Task team manager Task owner (restricted by action policy ACTION_REASSIGN_TASK)	New/Received and assigned (claimed)	The task is assigned back to the original role	Assign task back
Cancel a task (PUT) `/task/{taskID}?action={string}[&parts={string}]` Task action: `ACTION_REASSIGN_TASK`	Business Automation Workflow administrator Process application administrator Instance owner Task team manager Task owner Restricted by action policy `ACTION_REASSIGN_TASK`	New/Received and assigned (claimed)	The task must be assigned to a user	Release (cancel) a task to other users
Bulk task details (GET) `/task?action={string}&taskIDs={string}[&parts={string}]`	Business Automation Workflow administrator Process application administrator Instance owner Task team manager Potential task owner (if task owner is not set) Collaborator Task owner	New/Received Closed		Bulk get task details
Bulk claim tasks - multiple claims (PUT) `/task?action={string}&taskIDs={string}[&parts={string}]`	Business Automation Workflow administrator Process application administrator Potential task owner (if task owner is not set) Restricted by action policy `ACTION_ASSIGN_TASK`	New/Received		Bulk claim multiple tasks
Bulk cancel tasks (PUT) `/task?action={string}&taskIDs={string}[&parts={string}]`	Business Automation Workflow administrator Process application administrator Instance owner Task team manager Task owner	New/Received and task is assigned	The tasks must be assigned to a user	Release multiple tasks