Perform Bulk Action on Tasks
put
/ic/api/process/v1/tasks
Performs action on multiple tasks based on the payload.
Request
Supported Media Types
- application/json
Action Payload
Nested Schema : action
Type:
Show Source
object
-
abortType(optional):
string
-
activityChanges(optional):
array activityChanges
-
assignees(optional):
array assignees
-
comments(optional):
string
-
correlationKeyChanges(optional):
array correlationKeyChanges
-
dataObjectChanges(optional):
array dataObjectChanges
-
faultActionType(optional):
string
-
flowId(optional):
integer(int64)
-
id(optional):
string
-
instanceAttributeChanges(optional):
array instanceAttributeChanges
-
processes(optional):
array processes
-
type(optional):
string
Response
Supported Media Types
- application/json
200 Response
Success
Nested Schema : task
Type:
object
400 Response
Bad request
401 Response
Unauthorized
404 Response
Task list not found
500 Response
Internal Server Error
Examples
The following example shows how to reassign set of tasks to a different user by using PUT request on the REST resource.
Send Request
https://example.com/ic/api/process/v1/tasks
Where,
-
example.com
is the host where Oracle Integration is running.
Example of Request Body
Example 1:
{ "action":{"id":"REASSIGN"}, "tasks":["<taskId>"], "identities": [ {"id":"<userId>","type":"user"} ] }
Where,
-
<userId> is the user ID.
<taskId> specifies the IDs of tasks on which you want to perform actions.
To operate on multiple tasks, separate IDs with a
","
.To get the task ID of the current user, see Retrieve a Task List.
Example 2:
The following example shows the request body when you approve two tasks.
{ "action":{"id":"APPROVE" , "type":"CUSTOM"}, "comment":{"commentStr":"test" , "commentScope":"BPM"}, "priority" : 1,: "tasks":[ "200002", "200006"] }
Example of Response Header
Status Code: 200 OK Date: Wed, 27 Apr 2016 00:53:16 GMT Content-Type: application/json
Example of Response Body
{ "totalResult": false, "hasMore": false, "items": [ {"href": "http://example.com/ic/api/process/v1/tasks/200002", "length": 0, "rel": "self", "title": "Approver to review request and approve, reject, or request additional information", "hasSubTasksFlag": false, "isDocsEnabledFlag": false, "isConversationEnabledFlag": false, "hasSubTasks": false } ], "user": { "href": "http://example.com/ic/api/process/v1/identities/user/jsmith", "length": 0, "rel": "user" } }