Jump to

• Request
• Response
• Examples

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: string
  Dynamic process instance ID.

Body ()

Action and variables to update.

Root Schema : InstanceActionInput

Type: object

Show Source

• action(optional): string
  Allowed Values: [ "abort", "close", "complete" ]

  complete, close, abort
• deletions(optional): array deletions
• variables(optional): object VariablesMap
  Additional Properties Allowed: additionalProperties

  a (key, MapItem) map. `default`is an example key

{
    "type":"object",
    "properties":{
        "variables":{
            "$ref":"#/definitions/VariablesMap"
        },
        "deletions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "action":{
            "type":"string",
            "description":"complete, close, abort",
            "enum":[
                "abort",
                "close",
                "complete"
            ]
        }
    }
}

Nested Schema : deletions

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : VariablesMap

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "description":"a (key, MapItem) map. `default`is an example key",
    "properties":{
        "default":{
            "type":"object"
        }
    },
    "additionalProperties":{
        "type":"object"
    }
}

a (key, MapItem) map. `default`is an example key

Show Source

• default(optional): object default

{
    "description":"a (key, MapItem) map. `default`is an example key",
    "properties":{
        "default":{
            "type":"object"
        }
    },
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : default

Type: object

Nested Schema : additionalProperties

Type: object

Back to Top

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.

Back to Top

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"
}

Back to Top