Accelerate the Value of Data

Deploy Process Definition(s)

Request

Operation Endpoint:

POST {workflowPath}/workflow/deployments
Table 1. Parameters
Parameter Required Description
Headers Authorization Yes Access Token in format "Bearer <accessToken>" (see details in Authentication API).
Content-Type Yes Should be "Content-Type: application/json" .
EnvironmentURL Yes Reltio Environment URL.
Body file Yes *bpmn20.dita containing process definition(s).
tenantId No Tenant ID.
name No Name of the deployment.

Response

Response Structure:

  • deploymentId- ID of the new deployment
  • 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:

{ "deploymentId":"123", "status":"OK"}