跳转至

使用 RESTful API 暴露应用程序作业

通过 RESTful API 公开应用程序作业

CCH Tagetik 使用 Open RESTful API 公开应用程序作业的执行。
状态 SWAGGER
活动 -
格式 根端点
OData <api root>/dataprocessing/job/v1

应用程序作业

要运行应用程序作业，可以通过 POST 方法调用以下 URL：

http://server:port/tagetikcpm/api/dataprocessing/job/v1/database_id/job_code**

应用程序作业 job_code 将在通过 database_id 指定的环境中运行。

如果应用程序作业代码不存在，将返回错误。

当前管理的任务包括：

  • ETL
  • 加载到分析工作区
  • 从分析工作区更新财务工作区
  • DTP
  • 存储过程
  • 计算逻辑
  • 对原始场景的初步数据处理
  • 对合并区域的初步处理
  • 法律实体的数据处理
  • 合并

在响应中，将以 JSON 格式返回以下内容：

dataprocessingId：数据处理 ID

例如：{ "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB" }

要检查应用程序作业的执行状态，可以使用 GET 请求调用以下 URL：

http://server:port/tagetikcpm/api/dataprocessing/job/v1/**dataprocessingId

在响应中，将以 JSON 格式返回以下内容：

status：RUNNING/FAILED/COMPLETED - 取决于数据处理是正在运行、失败还是成功完成。

例如：{"requestDateTime": "2021-06-25T10:56:42.850+0000", "status": "COMPLETED"}

要中断应用程序作业的执行，可以通过 DELETE 方法调用以下 URL：

http://server:port/tagetikcpm/api/dataprocessing/job/v1/dataprocessingId

在响应中，将以 JSON 格式返回以下内容：

message："Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId" - 取决于数据处理是否已完成。

例如：{"message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"}

警告：要通过 API 执行作业，所有任务都必须使用设置为"从元素列表"的固定参数。不支持将参数设置为"从参数"的情况。