Learn how The task helps you to start a process instance.

Use this API to start a workflow process instance. By default, Reltio allows you to start up to 15,000 processes a day in a given tenant. The API returns a 429 HTTP response status code if you exceed this number of processes.

For more information, see Job Throttling and Queuing.

If you want to reduce this daily request threshold, for example, to manage your load predictions and optimize resource utilization, contact Reltio Support.

Request

Operation Endpoint:

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

Sample Request:

{
	"processType": "reviewUpdateAttribute",
	"objectURIs": ["entities/e1"],
	"comment": "Started Review update attribute process"
}

Response Structure:

• processInstanceId- ID of the process instance created
• 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:

{ "processInstanceId":"1234", "status":"OK"}