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.
Request
Operation Endpoint:
GET {workflowPath}/workflow/{tenantId}/processCount
Parameter | Required | Description | |
---|---|---|---|
Headers | Authorization |
Yes | Access Token in format "Bearer
(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 returnednoOfInstances
- number of process instances of the process type
error
- returned if an error is encountered, contains details of the issue:errorCode
- 5-digit error codeerrorMessage
- error messageerrorData
- details of the error:exception
- exception messagestack
- stack trace
innerError
- details of the error from Reltio API:errorMessage
- Reltio API error messageerrorCode
- Reltio API error codeinnerErrorData
- Reltio API inner error data
warning
- returned if the operation is completed with some minor issuesstatus
- 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"
}