将数据加载到分析工作区的数据处理 API

URL¶

/aih/loadtoaw/v1/_code

用于将数据加载到分析工作区数据集的 API¶

将来自外部源的数据加载到在分析工作区上定义、并由属于 database_id 所标识数据库的 workspace_code/dataset_code 对标识的数据集上，加载到由 typology 代码标识的类型上（$ 表示报表层）。用于加载的设置对应于由代码 dsm_code 标识的数据源映射中定义的设置。

方法¶

POST

URL¶

/aih/loadtoaw/v1/database_id/workspace_code/dataset_code/typology/dsm_code

属性¶

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

属性	描述	选项
process	必填。选择用于加载的流程。	-
scenario	仅对按场景和期间提交的流程为必填，对单一提交流程则不需要。	-
period	仅对按场景和期间提交的流程为必填，对单一提交流程则不需要。	-
entity	必填。选择用于加载的实体或节点。	- 要表示实体，请使用实体代码（例如 A01） - 要表示节点，请使用由 "GER

示例¶

{ "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 加载

返回的数据¶

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

dataprocessingId：数据处理 ID。

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

用于检查数据加载到分析工作区数据集状态的 API¶

返回数据加载流程的状态。

方法¶

GET

URL¶

/aih/loadtoaw/v1/dataprocessingId

返回的数据¶

在响应中，将以 JSON 格式返回数据处理状态：

status：RUNNING/FAILED/COMPLETED

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

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

用于停止将数据加载到分析工作区数据集的 API¶

方法¶

DELETE

URL¶

/aih/loadtoaw/v1/dataprocessingId

返回的数据¶

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

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

消息	描述
Stop on dataprocessingOid	数据处理已停止
Notify on dataprocessingOid	已请求停止数据处理，但仍在进行中

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