通过 API 访问主数据管理功能

通过 API 访问主数据管理功能¶

简介¶

CCH Tagetik 可以通过根据 OData V4.0 标准开发的 API（RESTful API）运行主数据管理数据处理。


状态		SWAGGER
活动		`-`

格式		根端点
REST / OpenAPI		`<api root>/mdm`

使用此咨询方法必须满足某些条件。

访问条件¶

要能够使用这些特定 API，用户必须经过身份验证（基本身份验证、OAuth2）。

还必须在存储库中启用 API。对于反向代理，还需要进行其他设置。它们可以与 http 和 https 协议一起使用。

有关身份验证和启用的更多详细信息，请参阅 REST API 概述。

用于运行导出（DB to File）的 API¶

方法¶

POST

URL¶

<api-root>/mdm/export/v1/routine_code

参数¶

routine_code = 要导出的 MDM 例程

重要：如果指定的 MDM 例程不是 DB to File，则返回错误消息。

返回的数据¶

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

dataprocessingId = 数据处理 ID。

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

用于检查导出状态（DB to File）的 API¶

方法¶

GET

URL¶

<api-root>/mdm/export/v1/dataprocessingId

返回的数据¶

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

status：RUNNING/FAILED/COMPLETED

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

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

fileName_[routine_name]：生成文件的名称

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

用于停止导出（DB to File）的 API¶

方法¶

DELETE

URL¶

<api-root>/mdm/export/v1/dataprocessingId

返回的数据¶

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

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

消息	描述
Stop on dataprocessingOid	请求中断仍在运行的数据处理
Notify on dataprocessingOid	请求中断已结束的数据处理。系统会响应处理结束消息。

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

用于运行导入（File to DB）的 API¶

方法¶

POST

URL¶

<api-root>/mdm/import/v1/routine_code

参数¶

routine_code = 要导入的 MDM 例程

重要：如果指定的 MDM 例程不是 File to DB，则返回错误消息。

属性¶

以下属性可以 JSON 格式包含在请求正文中。

属性	描述	选项
filename	必填。要导入的文件。	-
endpoint	如果文件位于远程目录中，则要使用的端点。请参阅端点页面。	-
dir	文件所在的目录	如果指定了端点，则允许基于端点的根指定子目录。如果未指定端点，则可以指定： - 空字段 = 配置为 CCH Tagetik 可写文件夹的目录 - 相对路径 = 可写文件夹子目录 - 绝对路径 = 允许目录中指示的通用目录

示例¶

{ "filename":"export.zip", "endpoint":"", "dir":""} - 从 可写文件夹 导入 "export.zip" 文件

{ "filename":"export.zip", "endpoint":"", "dir":"tmp"} - 从 可写文件夹 的 "tmp" 子目录导入 "export.zip" 文件

{ "filename":"export.zip", "endpoint":"", "dir":"C:\impexp"} - 从 "C:\impexp" 目录导入 "export.zip" 文件

{ "filename":"export.zip", "endpoint":"SFTP", "dir":""} - 通过 SFTP 端点导入 "export.zip" 文件

{ "filename":"export.zip", "endpoint":"SFTP", "dir":"tmp"} - 导入 SFTP 端点 "tmp" 子目录中存在的 "export.zip" 文件

返回的数据¶

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

dataprocessingId：数据处理 ID。

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

用于检查导入状态（File to DB）的 API¶

方法¶

GET

URL¶

<api-root>/mdm/import/v1/dataprocessingId

返回的数据¶

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

status：RUNNING/FAILED/COMPLETED

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

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

用于停止导入（File to DB）的 API¶

方法¶

DELETE

URL¶

<api-root>/mdm/import/v1/dataprocessingId

返回的数据¶

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

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

消息	描述
Stop on dataprocessingOid	请求中断仍在运行的数据处理
Notify on dataprocessingOid	请求中断已结束的数据处理。系统会响应处理结束消息。

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

用于运行导入（DB to DB）的 API¶

方法¶

POST

URL¶

<api-root>/mdm/import/v1/routine_code

参数¶

routine_code = 要导入的 MDM 例程

重要：如果指定的 MDM 例程不是 DB to DB，则返回错误消息。

返回的数据¶

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

dataprocessingId = 数据处理 ID

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

用于检查导入状态（DB to DB）的 API¶

方法¶

GET

URL¶

/mdm/import/v1/dataprocessingId

返回的数据¶

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

status：RUNNING/FAILED/COMPLETED

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

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

用于停止导入（DB to DB）的 API¶

方法¶

DELETE

URL¶

<api-root>/mdm/import/v1/dataprocessingId

返回的数据¶

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

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

消息	描述
Stop on dataprocessingOid	请求中断仍在运行的数据处理
Notify on dataprocessingOid	请求中断已结束的数据处理。系统会响应处理结束消息。

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