ETL via APIs
Introduction¶
CCH Tagetik also allows you to run ETL job data processing via OPEN RESTful APIs.
| STATUS | SWAGGER | |
| ACTIVE | - |
|
| FORMAT | ROOT ENDPOINT | |
| REST/OpenAPI | <api root>/etl/job/v1 |
Access conditions¶
To be able to use these specific APIs, the user must be authenticated (Basic Auth, OAuth2).
APIs must also be enabled in the Repository. For reverse proxies, further settings are necessary. They can be used with both http and https protocols.
For more details on authentication and enabling, see REST API Overview.
APIs for running ETL jobs¶
Method¶
POST
URL¶
http://server:port/tagetikcpm/api/etl/job/v1/database_id/etl_job_code**
Parameters¶
database_id = ID of the database on which to run the ETL
Property¶
The following property can be included in JSON format in the body of the request
| Property | Description | Options |
|---|---|---|
| process | If the ETL job requires it, this allows you to indicate the process with which it must be run. | - |
| etlParameters | If the ETL job uses ETL parameters in the ETL routine tasks, their values can be indicated by specifying the concatenation between etl_domain_code** | **etl_parameter_code as the parameter name. |
Example
{"process" : "ACTUAL","etlParameters" : [{"code" : "ED1|ENTITY","value": "001"},{"code" : "ED2|SCENARIO_PERIOD","value": "2022ACT;01"}]}
Data returned¶
In the response, the following will be returned in JSON format:
- the following data processing ID:
- dataprocessingId
- an error will be returned if the parameter validation has failed
{ "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB" }
APIs for checking ETL job data processing status¶
Method¶
GET
URL¶
Data returned¶
The response returns the data processing status in JSON format:
status: RUNNING/FAILED/COMPLETED
| Status | Description |
|---|---|
| RUNNING | Running |
| FAILED | Failed |
| COMPLETED | Completed successfully |
| WARNING | Completed with warnings |
E.g.: {"requestDateTime": "2021-06-25T10:56:42.850+0000", "status": "COMPLETED"}
APIs for stopping ETL job data processing¶
Method¶
DELETE
URL¶
In the response, the following ID will be returned in JSON format:
message: "Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"
| Message | Description |
|---|---|
| Stop on dataprocessingOid | Data Processing was stopped |
| Notify on dataprocessingOid | Data processing with reported stop but currently still in progress |
E.g.: {"message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"}