Unify and manage your data

Get Number of Process Instances

This API enables you to get the number of process instances that were started on the tenant, including the processes that are already completed.

Note: This Get Number of Process Instances API shows the number of Open and Closed processes.

Request

Operation Endpoint:

 GET {workflowPath}/workflow/{tenantId}/processCount 
Table 1. Parameters
Parameter Required Description
Headers Authorization Yes Access Token in format "Bearer <accessToken>" (see details in Authentication API).
EnvironmentURL Yes Reltio Environment URL.
Body startedBefore No Time in milliseconds.
startedAfter No Time in milliseconds.

Response

Response Structure:

  • total - number of process instances of the process type
  • data-array with results for each element returned. Each result will have the following properties:
    • processType- number of records returned
    • noOfInstances- number of process instances of the process type
  • 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"

Example

Sample Response JSON:

{
	"total": 5,
	"data": [{
		"processType": "potentialMatchReview",
		"noOfInstances": 2
	}, {
		"processType": "recommendForDelete",
		"noOfInstances": 3
	}]
	"status": "OK"
}