Accelerate the Value of Data

Unregister Tenants

Request

Operation Endpoint:

DELETE  {workflowPath}/workflow/registrations
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 tenantIds Yes Comma-separated list of Tenant IDs.

Example

Sample Request JSON:

{ "tenantIds":["a5","a7"]}

Response

Response Structure:

  • tenantIds- list of Tenant IDs registered for the environment
  • 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:

{ "tenantIds":["a1","a6","a2"], "status":"OK"}

Retrieve Registered Tenants

Request

Operation Endpoint:

GET {workflowPath}/workflow/registrations
Table 2. Parameters
Parameter Required Description
Headers Authorization Yes Access Token in format "Bearer <accessToken>" (see details in Authentication API).
EnvironmentURL Yes Reltio Environment URL.

Response

Response Structure:

  • tenantIds- list of Tenant IDs registered for the environment
  • 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:

{ "tenantIds":["a1","a6","a2"], "status":"OK"}