将数据集导出到文件的 API

对属于分析工作区和由 database_id 标识的数据库的、由 workspace_code/dataset_code 对标识的数据集文件运行导出数据处理。

用于导出的设置如由 dtm_code 标识的数据目标映射文件中所定义，所选类型为 报表层（$）。

重要：API 不支持对已配置将同一文件下载到客户端/浏览器的数据集文件运行导出数据处理；因此，在运行时会返回以下错误：{ "code": 400, "message": "Invalid file location - local download is not supported" }。

.

方法

POST

URL

api-root>/aih/dtm/v1/database_id/workspace_code/dataset_code/dtm_code

属性

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

属性	描述	选项
process	必填。为导出所选的流程。	-
scenario	仅对按场景和期间提交的流程为必填。对于单一提交流程，导出时不得选择场景。	-
period	仅对按场景和期间提交的流程为必填。对于单一提交流程，导出时不得选择期间。	-
entity	必填。为导出所选的实体或节点。	- 要指示实体，请发送实体代码（例如 A01） - 要指示节点，请发送由 "GER

示例

复制

使用流程 CAV1 和场景/期间 2020sp/07 对实体 A01 进行导出

{
    "process": "CAV1",
    "scenario":"2020sp",
    "period":"07",
    "entity":"A01"
}

复制

使用流程 CAV1 和场景/期间等于 2020sp/07 对节点 01 进行导出

{
    "process": "CAV1",
    "scenario": "2020sp",
    "period": "07",
    "entity": "GER|01"
}

返回的数据

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

dataprocessingId = 数据处理 ID。

复制

{
    "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB"
}

用于检查数据集导出到文件状态的 API

返回导出流程状态。

方法

GET

URL

/aih/dtm/v1/dataprocessingId

返回的数据

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

status：RUNNING/FAILED/COMPLETED

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

复制

{
    "requestDateTime": "2021-06-25T10:56:42.850+0000",
    "status": "COMPLETED",
    "parameters": []
}

用于停止数据集导出到文件的 API

停止导出。

方法

DELETE

URL

/aih/dtm/v1/dataprocessingId

返回的数据

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

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

消息	描述
Stop on dataprocessingOid	数据处理已停止
Notify on dataprocessingOid	数据处理仍在运行

复制

{
    "message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"
}