Explore

Discover Start Explore Model Integrate Engage

Discover Start Explore Model Integrate Engage

Accelerate the Value of Data

Explore

Explore Contents

Get a crash course

Get to know Reltio

Get your bearings in Reltio

Chart your course

Embark on your journey

Get going with APIs and ROCS utilities

Reltio REST APIs

Integrate APIs

Delta Lake API

Configure pipeline

Configure pipeline scheduler

Configure pipeline scheduler

Learn about the Delta Lake API endpoint to configure the scheduler job for the pipeline.

Use this endpoint to configure the scheduler job of the Databricks Delta Lake pipeline.

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/configure_scheduler

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
cronExpression	struct	Yes	Cron job expression.

Examples

Table 4. Request example
`POST https://dev-data-pipeline-hub.reltio.com/api/tenants/AbCdEfGH12i3jK4/adapters/deltalake/actions/configure_scheduler`
This example shows how to run a request	Payload: `{ "cronExpression":"24 38 9 20 * ?" }`

Table 5. Response examples
Success example: `{ "status": "SUCCESS", "errors": [], "adapter-response": { "job_id": "327543511345588" } }`
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 pipeline not enabled: `{ "severity": "Error", "errorMessage": "Adapter not enabled for deltalake.", "errorCode": 8004, "errorDetailMessage": "Adapter not enabled for deltalake.", "foundErrors": null, "innerErrorData": null, "causedBy": null, "asJSON": "{\"severity\":\"Error\",\"errorMessage\":\"Adapter not enabled for deltalake.\",\"errorCode\":8004,\"errorDetailMessage\":\"Adapter not enabled for deltalake.\",\"foundErrors\":null,\"innerErrorData\":null,\"exception\":null,\" stack\":null,\"causedBy\":null}" }`
Validation error when you speficy the cron job incorrectly: `{ "severity": "Error", "errorMessage": "Invalid Job cron expression.", "errorCode": 8019, "errorDetailMessage": "Invalid Job cron expression.", "foundErrors": null, "innerErrorData": null, "exception": null, "stack": null, "causedBy": null }`
Validation error when pipeline is not present for the tenant `{ "severity": "Error", "errorMessage": "Pipeline not found for tenant.", "errorCode": 8020, "errorDetailMessage": "Pipeline not found for tenant. Please configure pipeline using endpoint.", "foundErrors": null, "innerErrorData": null, "exception": null, "stack": null, "causedBy": null }`
Validation error when there is another active scheduler job already present: `{ "severity": "Error", "errorMessage": "Pipeline Job already present.", "errorCode": 8021, "errorDetailMessage": "Pipeline Job already present. Please delete the existing job and create new one.", "foundErrors": null, "innerErrorData": null, "exception": null, "stack": null, "causedBy": null }`

Updated on April 12, 2024

You've found your way to a temporary environment. Content is not complete or final. Looking for Reltio documentation? Go to docs.reltio.com.