Trigger pipeline

Learn about the Delta Lake API endpoint to trigger the pipeline.

Use this endpoint to trigger the pipeline in Databricks.

You need to have a role with Tenant admin and Datapipeline tenant admin to run the endpoint.

Request

POST 
{{hub-url}}/api/tenants/{{tenantID}}/adapters/deltalake/actions/trigger_pipeline

where {{hub-url}} is https://{{env}}-data-pipeline-hub.reltio.com.

Table 1. Header
Parameter	Type	Required	Description
Authorization	string	Yes	The bearer token URL returned by the Authentication.For information on obtaining an authorization token to run Reltio REST APIs using the Security OAuth 2.0 security method, see topic Authentication API.
Content-type	string	Yes	The format to use to transmit data: application/json Reltio APIs transmit data in the JavaScript Object Notation (JSON) standard text-based format.

Table 2. Parameters - Path
Parameter	Type	Required	Description
tenantId	string	Yes	The unique identification number for the Reltio tenant, for example: `AbCdEfGH12i3jK4` .

Table 3. Parameters - Body
Parameter	Type	Required	Description
fullRefresh	boolean	No	Determine whether to run a full refresh of the data.

Examples

Table 4. Request example
`POST https://dev-data-pipeline-hub.reltio.com/api/tenants/AbCdEfGH12i3jK4/adapters/deltalake/actions/tigger_pipeline`
This example shows how to run a request	Payload: `{ "fullRefresh": "true/false" }`

Table 5. Response examples
Success example: `{ "status": "SUCCESS", "errors": [], "message": "Pipeline triggered successfully. Please check the pipeline run details for more information." "adapter-response": { "update_id": "f1417e20-f5b3-49ff-a28a-702a0ee60d1c", "request_id": "f1417e20-f5b3-49ff-a28a-702a0ee60d1c" } }`
This example shows the response returned for the request example above.	where: `%status;` Result of the request `%errors;` Any errors when the result is not a success. adapter-response Details of the request's result.
Validation error when another pipeline update is running: `{ "severity": "Error", "errorMessage": "Cannot trigger pipeline when an update is running.", "errorCode": 8027, "errorDetailMessage": "Cannot trigger pipeline when an update is running.", "foundErrors": null, "innerErrorData": null, "exception": null, "stack": null, "causedBy": null }`

Success example:

{ 
"status": "SUCCESS", 
"errors": [], 
"message": "Pipeline triggered successfully. Please check the pipeline run details for more information." 
"adapter-response": { 
  "update_id": "f1417e20-f5b3-49ff-a28a-702a0ee60d1c", 
  "request_id": "f1417e20-f5b3-49ff-a28a-702a0ee60d1c" 
} 
}

This example shows the response returned for the request example above.

where:

%status;: Result of the request
%errors;: Any errors when the result is not a success.
adapter-response: Details of the request's result.

Validation error when another pipeline update is running:

{ 
"severity": "Error", 
"errorMessage": "Cannot trigger pipeline when an update is running.", 
"errorCode": 8027, 
"errorDetailMessage": "Cannot trigger pipeline when an update is running.", 
"foundErrors": null, 
"innerErrorData": null, 
"exception": null, 
"stack": null, 
"causedBy": null 
}

Accelerate the Value of Data

Trigger pipeline

Request

Examples

Footer