通过 API 进行 ETL
简介¶
CCH Tagetik 还允许您通过 OPEN RESTful API 运行 ETL 作业数据处理。
| 状态 | SWAGGER | |
| ACTIVE | - |
|
| 格式 | 根端点 | |
| REST/OpenAPI | <api root>/etl/job/v1 |
访问条件¶
要使用这些特定的 API，用户必须经过身份验证（Basic Auth、OAuth2）。
还必须在存储库（Repository）中启用这些 API。对于反向代理，还需要进行额外设置。它们可同时用于 http 和 https 协议。
有关身份验证和启用的更多详细信息，请参阅 REST API 概述。
用于运行 ETL 作业的 API¶
方法¶
POST
URL¶
http://server:port/tagetikcpm/api/etl/job/v1/database_id/etl_job_code**
参数¶
database_id = 要在其上运行 ETL 的数据库 ID
属性¶
以下属性可以 JSON 格式包含在请求正文中
| 属性 | 描述 | 选项 |
|---|---|---|
| process | 如果 ETL 作业需要，此属性允许您指明运行该作业时必须使用的流程。 | - |
| etlParameters | 如果 ETL 作业在 ETL 例程任务中使用了 ETL 参数，则可以通过指定 etl_domain_code** | **etl_parameter_code 的拼接作为参数名称来指明其值。 |
示例
{"process" : "ACTUAL","etlParameters" : [{"code" : "ED1|ENTITY","value": "001"},{"code" : "ED2|SCENARIO_PERIOD","value": "2022ACT;01"}]}
返回的数据¶
响应将以 JSON 格式返回以下内容：
- 以下数据处理 ID：
- dataprocessingId
- 如果参数验证失败，将返回错误
{ "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB" }
用于检查 ETL 作业数据处理状态的 API¶
方法¶
GET
URL¶
返回的数据¶
响应以 JSON 格式返回数据处理状态：
status：RUNNING/FAILED/COMPLETED
| 状态 | 描述 |
|---|---|
| RUNNING | 运行中 |
| FAILED | 失败 |
| COMPLETED | 成功完成 |
| WARNING | 完成但有警告 |
例如：{"requestDateTime": "2021-06-25T10:56:42.850+0000", "status": "COMPLETED"}
用于停止 ETL 作业数据处理的 API¶
方法¶
DELETE
URL¶
响应将以 JSON 格式返回以下 ID：
message："Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"
| 消息 | 描述 |
|---|---|
| Stop on dataprocessingOid | 数据处理已停止 |
| Notify on dataprocessingOid | 数据处理已报告停止，但目前仍在进行中 |
例如：{"message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"}