Processinstances API

The Processinstances API is used to return execution results from OO flows. When OO makes one of these REST calls, the process instance properties are updated accordingly. When the process completes, the process notification handler passes these properties to the caller.

Note This REST API is supported only for sequenced designs and not for topology designs.

Base URL

https://<host>:<port>/csa/rest

URIs

The following URIs are appended to the base URL:

URI Method Parameters Description
/processinstances/<process_instance_id> GET userIdentifier=<user_id>

Required; the user ID that you want to use as credentials for this API call. See Get userIdentifier for the steps required to get the userIdentifier value.

The user identified by userIdentifier must have admin access.
Retrieve a Process Instance
/processinstances POST userIdentifier Create a Process Instance
/processinstances/<process_instance_id> PUT userIdentifier, scope, view, action Update a Process Instance
/processinstances/<process_instance_id>/execute POST userIdentifier Execute a Process Instance