Control a Dynamic Process Instance
put
/ic/api/process/v1/dp-instances/{id}
Perform the specified action on a dynamic process instance.
The behavior of the abort action depends on the setting in the abortType parameter. Valid values for abortType are:
- self: Aborts all instances matching the flow ID of the current instance on which the abort action is performed.
- downstream: Aborts all instances that match the specified flow ID and its child flow IDs.
- all: Aborts all instances that match the specified flow ID and its parent and child flow IDs.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
Dynamic process instance ID.
Action and variables to update.
Root Schema : InstanceActionInput
Type:
Show Source
object
-
action:
string
Allowed Values:
[ "abort", "close", "complete" ]
complete, close, abort -
deletions:
array deletions
-
variables:
object VariablesMap
Additional Properties Allowed: additionalPropertiesa (key, MapItem) map. `default`is an example key
Nested Schema : VariablesMap
Type:
object
Additional Properties Allowed
Show Source
a (key, MapItem) map. `default`is an example key
Show Source
Nested Schema : default
Type:
object
Nested Schema : additionalProperties
Type:
object
Response
Supported Media Types
- application/json
204 Response
Successful operation
400 Response
The state transition is not allowed. For example, when the dynamic process instance is already completed.
401 Response
Unauthorized
403 Response
The dynamic process instance cannot be operated on because of CMMN restrictions.
404 Response
The dynamic process instance with the specified ID was not found.
500 Response
Internal Server Error.
Examples
The following example shows how to update a process instance by submitting a PUT request on the REST resource.
Send Request
https://example.com/ic/api/process/<version>/dp-instances/<Id>
Where,
-
example.com
is the host where Oracle Integration is running.
Example: Abort a Process Instance and all its Children
The following example shows how to send a request in JSON format with the PUT method.
In this example, we are aborting a process instance and all the instances of its children having the same flow ID.
PUT Request:
https://example.com/ic/api/process/v1/dp-instances/20007
Request Body:
{ "abortType":"downstream", "action":"abort" }