Retrieve Process Instances Using a Filter

This API enables you to search for process instances using a filter.

Note: The Retrieve Process Instances Using a Filter API shows only the number of Open processes.

Request

Operation Endpoint:

POST {workflowPath}/workflow/{tenantId} /processInstances/_search

Table 1. Parameters
Parameter		Required	Description
Headers	`Authorization`	Yes	Access Token in format `"Bearer <accessToken>"` (see details in Authentication API).
	`Content-Type`	Yes	Should be "`Content-Type: application/json`".
	`EnvironmentURL`	Yes	Reltio Environment URL.
Body	`objectURIs`	No	List of Reltio object URIs (entity/relation).
	`processType`	No	Process definition type.
	`suspended`	No	Suspended: `true` or `false`.
	`offset`	No	Start position.
	`max`	No	Number of records to be returned.

Sample Request JSON:

{ "objectURIs":["entities/e1"]}

Response

Response Structure:

total- total number of records
offset- start position of records
size- number of records returned
data- array with results for each element returned. Each result will have the following properties:
- processInstanceId- process instance ID
- processDefinitionId- process definition ID
- processType- process definition type
- suspended- is suspended (true/false)
error- returned if an error is encountered, contains details of the issue:
- errorCode- 5-digit error code
- errorMessage- error message
- errorData- details of the error:
  - exception- exception message
  - stack- stack trace
- innerError- details of the error from Reltio API:
  - errorMessage- Reltio API error message
  - errorCode- Reltio API error code
  - innerErrorData- Reltio API inner error data
warning- returned if the operation is completed with some minor issues
status- result of the operation; possible values are "OK" or "failed"

Sample Response JSON:

{
	"data": [{
		"processInstanceId": "5",
		"processDefinitionId ": "reviewDeleteEntity:1:3",
		"processType": "reviewDeleteEntity",
		"suspended": false
	}],
	"total": 1,
	"status": "OK"
}

Unify and manage your data

Retrieve Process Instances Using a Filter

Sample Request JSON:

Footer