DTP 运行数据处理 API

URL¶

http://server:port/tagetikcpm/api/aih/dtp/v1/

用于运行 DTP 数据处理的 API¶

重要：从 API 启动 DTP 不支持多维流程；此外，必须启用用户功能 0003912 才能使用以下 API。

运行属于由 database_id 标识的数据库、且定义在由 workspace_code 标识的分析工作区上的、代码为 dtp_code 的 DTP 的数据处理。

方法¶

POST

URL¶

/aih/dtp/v1/database_id/workspace_code/dtp_code

以下与执行上下文相关的属性必须以 JSON 格式包含在请求体中：

属性	描述	选项
process	必填。为加载所选的流程。	-
scenario	仅对按场景和期间提交的流程为必填，单一提交流程不需要。为数据处理所选的场景。	-
period	仅对按场景和期间提交的流程为必填，单一提交流程不需要。为数据处理所选的期间。	-
entity	必填。为数据处理所选的实体或节点	- 要指示实体，请发送实体代码（例如 A01） - 要指示节点，请发送由 "GER
contextIndependentRun	可选。允许以独立于上下文的模式启动 DTP。如果未指示，DTP 将以标准模式运行：依赖于上下文。	- false：标准、依赖于上下文的执行。 - true：独立于上下文的执行。
runtimeParameters	可选。允许填写 DTP 配置中的运行时参数。	- AW 参数 - 报表参数

示例¶

{ "process": "CAV1", "scenario": "2020sp", "period": "07", "entity": "A01"} - 使用流程 CAV1 和场景/期间 2020sp/07 对实体 A01 进行加载

{ "process": "CAV1", "scenario": "2020sp", "period": "07", "entity": "GER|01"} - 使用流程 CAV1 和场景/期间等于 2020sp/07 对节点 01 进行加载

{ "process":"CAV1", "scenario":"2020sp", "period":"07", "entity":"GER|01", "contextIndependentRun":"true"} - 使用流程 CAV1、场景/期间等于 2020sp/07 且启用 "独立于上下文" 选项对节点 01 进行加载。

{ "process":"CAV1", "scenario":"2020sp", "period":"07", "entity":"A01","runtimeParameters": { "reportingParameters": {"ENTITY": "010|110", "$SCE_P": "$|$|2024SCE", "$PER_P": "02"}, "AWParameters": {"AW_PARAMETER": "AW pararmeter"}}} - 使用流程 CAV1、场景/期间等于 2020sp/07 及运行时参数对实体 A01 进行上传。

注意：按层次或分组组织的维度类型的报表参数值必须使用以下语法给出：

按层次组织的维度类型参数：GER|NODO 或 GER|NODO|ELEMENT
按分组组织的维度类型参数：$|NODO 或 $|NODO|ELEMENT
要指示不属于层次/分组的元素：$|$|ELEMENT
无组织结构的维度类型参数：ELEMENT

重要：目前不支持：

用户权限
对于维度类型的报表参数：
显式限制
依赖参数
仅选择节点或仅选择元素
多选
默认值

返回的数据¶

响应以 JSON 格式返回以下 ID：

dataprocessingId = 数据处理 ID。

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

用于检查 DTP 数据处理状态的 API¶

返回 DTP 数据处理状态。

方法¶

GET

URL¶

/aih/dtp/v1/dataprocessingId

返回的数据¶

响应以 JSON 格式返回数据处理状态：

status：RUNNING/FAILED/COMPLETED

状态	描述
RUNNING	运行中
FAILED	失败
COMPLETED	成功完成

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

用于停止 DTP 数据处理的 API¶

方法¶

DELETE

URL¶

/aih/dtp/v1/dataprocessingId

返回的数据¶

响应以 JSON 格式返回以下 ID：

message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"

消息	描述
Stop on dataprocessingOid	数据处理已停止
Notify on dataprocessingOid	数据处理进行中

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