Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Cloud Service Automation4.80.0002

Develop > Application Programming Interface > Legacy APIs > Processinstances API

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

Send Help Center feedback