Terminate Process Instances in the Background
Learn how to terminate workflow process instances in the background using filter parameters and API requests.
This endpoint terminates process instances on the tenant using filters.
Request
Operation Endpoint:
POST 'https://prod-workflow.reltio.com/workflow-adapter/workflow/{tenantId}/jobs/terminateProcessInstances?background=true'| Parameter | Required | Description | |
|---|---|---|---|
| Headers | Authorization | Yes | Access Token in format "Bearer (see details in Authentication API ). |
Content-Type | Yes | Should be | |
EnvironmentalURL | Yes | Reltio Environment URL. | |
| Parameters | background | No | Background false/true. |
| Body | processType | Yes | Process definition type. |
objectURIs | Yes | List of Reltio object URIs (entity/relation). | |
processDefinitionId | No | Process definition ID. | |
assignee | No | Assignee of the active task. | |
createdBy | No | Initiator of the process instance. | |
startedAfter | No | Time in milliseconds. | |
startedBefore | No | Time in milliseconds. | |
state | No | Validation state of process instance; default value=all; will return tasks with any state. |
Response
Response Structure:
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
status: result of the operation; possible values are "OK" or "failed"
Request
{
"processType":"dataChangeRequestReview",
"objectURIs":[
"entities/E8y5hJv"
],
"processDefinitionId":"recommendForDelete:118:8842195",
"assignee":"adminqa",
"createdBy":"user3mosk",
"startedAfter":1499680875124,
"startedBefore":1500285675127,
"state":"valid"
}Response
{
"status":"OK",
"total":1,
"data":[
{
"processInstanceId":"8900966"
}
]
}