Suspend a Process Instance
Request
Operation Endpoint:
PUT {workflowPath}/workflow/{tenantId}/processInstances/{processInstanceId}/_suspend
Parameter | Required | Description | |
---|---|---|---|
Headers | Authorization |
Yes | Access Token in format "Bearer
(see details
in Authentication API). |
EnvironmentURL |
Yes | Reltio Environment URL. |
Response
Response Structure:
-
error
- returned if an error is encountered, contains details of the issue:errorCode
- 5-digit error codeerrorMessage
- error message-
errorData
- 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:
{ "status":"OK"}