Retrieve Activities Flow for a Process Instance
/ic/api/process/v1/processes/{processId}/activityflows
Request
-
processId(required): string
Value of process ID
-
activityType: array[string]
Collection Format:
multi
Activity type that you want to filter on. Following are allowed values for activity type:- ABSTRACT_ACTIVITY
- USER_TASK
- SERVICE_TASK
- SEND_TASK
- RECEIVE_TASK
- BUSINESS_RULE_TASK
- SCRIPT_TASK
- MANUAL_TASK
- CALL_ACTIVITY
- SUBPROCESS
- NOTIFICATION_TASK
- UPDATE_TASK
- START_EVENT
- THROW_INTERMEDIATE_EVENT
- CATCH_INTERMEDIATE_EVENT
- END_EVENT
- BOUNDARY_EVENT
- EVENT
- EXCLUSIVE_GATEWAY
- INCLUSIVE_GATEWAY
- PARALLEL_GATEWAY
- EVENT_BASED_GATEWAY
- COMPLEX_GATEWAY
-
Allowed Values:
[ "ABSTRACT_ACTIVITY", "USER_TASK", "SERVICE_TASK", "SEND_TASK", "RECEIVE_TASK", "BUSINESS_RULE_TASK", "SCRIPT_TASK", "MANUAL_TASK", "CALL_ACTIVITY", "SUBPROCESS", "NOTIFICATION_TASK", "UPDATE_TASK", "START_EVENT", "THROW_INTERMEDIATE_EVENT", "CATCH_INTERMEDIATE_EVENT", "END_EVENT", "BOUNDARY_EVENT", "EVENT", "EXCLUSIVE_GATEWAY", "INCLUSIVE_GATEWAY", "PARALLEL_GATEWAY", "EVENT_BASED_GATEWAY", "COMPLEX_GATEWAY" ]
-
includeDataObjects: boolean
include DataObjects in response?Default Value:
false
-
suspendInstance: boolean
Suspend Instance or not - to prevent the instance from moving between the time the user gets the open activities and work upon themDefault Value:
false
Response
- application/json
200 Response
object
-
editable:
boolean
-
expressionString:
string
-
name:
string
-
namespaceMapping:
object namespaceMapping
Additional Properties Allowed: additionalProperties
-
type:
object QName
-
value:
string
object
object
400 Response
401 Response
404 Response
500 Response
Examples
The following examples show how to retrieve open activities, valid targets, and data objects for a process by submitting a GET request on the REST resource.
Examples: Retrieve Only Activities of a Specific Type
Note that the activityType
parameter is not case-sensitive so you can specify uppercase or lowercase values.
Example: Retrieve all human tasks
Send Request:
https://example.com/ic/api/process/v1/processes/30001/activityflows?activityType=USER_TASK
Example: Retrieve parallel gateways and end events
Send Request:
https://example.com/ic/api/process/v1/processes/30001/activityflows?activityType=PARALLEL_GATEWAY&activityType=END_EVENT
Retrieve Open Activities, Valid Targets, and Data Objects for a Process
Send Request:
https://example.com/ic/api/process/v1/processes/{processId}/activityflows
where,
-
example.com
is the host where Oracle Integration is running. -
<version> is the REST API version.
-
<Process ID> is the ID of the process.
For example, 1. You can get the <Process ID> using Retrieve the Process Instance List.
Example of Response Header
Status Code: 200 OK
Example of Response Body
{ "levels": 0, "flowChanges": [ { "activityLocation": "TravelProcess", "sourceActivity": { "locationInfo": { "absoluteScopeId": "TravelProcess_try.2", "activityInfo": { "displayName": "User task", "id": "ACT4b60e9aa3d738847e732c6ab8a9c7adc", "processId": "TravelProcess" }, "processInstanceInfo": { "id": 20001, "thread": 0 }, "root": false, "multiInstance": false, "loopCounter": null }, "container": false }, "targetGrabActivities": [ { "displayName": "User task", "id": "ACT4b60e9aa3d738847e732c6ab8a9c7adc", "processId": "TravelProcess" }, { "displayName": "End", "id": "EVT18856620525658", "processId": "TravelProcess" } ] } ], "links": [ { "length": 0, "rel": "canonical", "href": "http://example.com/ic/api/process/v1/processes/20001/activityflows" }, { "length": 0, "rel": "parent", "href": "http://example.com/ic/api/process/v1/processes/20001/" }, { "length": 0, "rel": "self", "href": "http://example.com/ic/api/process/v1/processes/20001/activityflows" } ] }