分析工作区数据处理 API
功能¶
启动导出、导入、复制和更新分析工作区所需的数据处理。
协议¶
开放式 RESTful API
分析工作区上的数据处理¶
分析工作区导出¶
用于运行分析工作区导出的 API
从通过 database_id 指示的环境中运行分析工作区 workspace_code 的导出。
方法¶
POST
URL¶
参数¶
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| date | boolean | 可选 | 除设置外，在导出中包含分析工作区数据。 值：true/false 默认：false。 |
示例
复制
返回的数据¶
响应以 JSON 格式返回以下 ID：
dataprocessingId = 数据处理 ID。
复制
用于检查分析工作区导出状态的 API
返回导出流程状态。
方法¶
GET
URL¶
返回的数据¶
响应以 JSON 格式返回数据处理状态：
status：RUNNING/FAILED/COMPLETED
| 状态 | 描述 |
|---|---|
| RUNNING | 运行中 |
| FAILED | 失败 |
| COMPLETED | 成功完成 |
exportedFileNames：生成的文件名
复制
{
"requestDateTime": "2021-06-25T10:56:42.850+0000",
"status": "COMPLETED",
"parameters": [
{
"exportedFileNames": "export_DB_USER_1_20230206115313820.awex"
}
]
}
用于停止分析工作区导出的 API
停止导出。
方法¶
DELETE
URL¶
返回的数据¶
响应以 JSON 格式返回以下 ID：
message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"
| 消息 | 描述 |
|---|---|
| Stop on dataprocessingOid | 数据处理已停止 |
| Notify on dataprocessingOid | 已请求停止数据处理但仍在进行中 |
复制
分析工作区导入¶
用于运行分析工作区导入的 API
在通过 database_id 标识的环境上，运行导出文件中包含的分析工作区的导入，该文件在请求体中使用 filename 指示。
方法¶
POST
URL¶
JSON 格式的属性¶
以下属性可以 JSON 格式包含在请求体中。
| 属性 | 描述 | 选项 |
|---|---|---|
| filename | 必填。标识要导入的文件。 | 可以指定： - 单个文件名 - 文件名列表（分隔符 = ;) - 所有扩展名为 .awex 的文件（filename = *） |
| endpoint | 如果文件位于远程目录中，则要使用的端点。 参见 。 | - |
| dir | 文件所在的目录 | 如果指定了端点，则允许基于端点的根目录指定子目录。 如果未指定端点，则可以指定： - 空字段 = 配置为 CCH Tagetik 可写文件夹的目录 - 相对路径 = 可写文件夹子目录 - 绝对路径 = 指定的通用目录（参见系统管理模块中的 ） |
示例
复制
从可写文件夹导入 'export.awex' 文件
复制
从 'C:\impexp' 目录导入 'export.awex' 文件
复制
通过 SFTP 端点导入 'export.awex' 文件
复制
在 SFTP 端点的 "tmp" 子目录上导入 "export.awex" 文件
复制
在 SFTP 端点上导入文件 "export_1_of_2.awex" 和 "export_2_of_2.awex"
复制
导入 SFTP 端点上存在的所有扩展名为 ".awex" 的文件
返回的数据¶
在响应中，将以 JSON 格式返回以下 ID：
dataprocessingId = 数据处理 ID
复制
用于检查分析工作区导入状态的 API
返回导入流程状态。
方法¶
GET
URL¶
返回的数据¶
响应以 JSON 格式返回数据处理状态：
status：RUNNING/FAILED/COMPLETED
| 状态 | 描述 |
|---|---|
| RUNNING | 运行中 |
| FAILED | 失败 |
| COMPLETED | 成功完成 |
复制
用于停止分析工作区导入的 API
停止导入。
方法¶
DELETE
URL¶
返回的数据¶
响应以 JSON 格式返回以下 ID：
message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"
| 消息 | 描述 |
|---|---|
| Stop on dataprocessingOid | 数据处理已停止 |
| Notify on dataprocessingOid | 已请求停止数据处理但仍在进行中 |
复制
分析工作区复制¶
用于复制分析工作区的 API
从通过 database_id 指示的环境中复制分析工作区 source_workspace_code。
方法¶
POST
URL¶
参数¶
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| targetWorkspaceCode | text | 必填 | 要创建的分析工作区代码。 |
| targetWorkspaceDescriptions | *** | 必填 | 要分配给所创建分析工作区的描述列表。 |
| date | boolean | 可选 | 在复制中包含所复制分析工作区的数据。 值：true/false 默认：false。 |
| forms | boolean | 可选 | 在复制中包含与所复制分析工作区相关的表单。 值：true/false 默认：false。 |
示例
复制
{
"targetWorkspaceCode":"001",
"targetWorkspaceDescriptions": {
"it":"Nuovo AW",
"en": "New AW"
},
"data":true,
"forms":false
}
返回的数据¶
响应以 JSON 格式返回以下 ID：
dataprocessingId = 数据处理 ID。
复制
用于检查分析工作区复制状态的 API
返回复制数据处理的状态。
方法¶
GET
URL¶
返回的数据¶
响应以 JSON 格式返回数据处理状态：
status：RUNNING/FAILED/COMPLETED
| 状态 | 描述 |
|---|---|
| RUNNING | 运行中 |
| FAILED | 失败 |
| COMPLETED | 成功完成 |
复制
用于中止分析工作区复制的 API
中断复制。
方法¶
DELETE
URL¶
返回的数据¶
响应以 JSON 格式返回以下 ID：
message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"
| 消息 | 描述 |
|---|---|
| Stop on dataprocessingOid | 数据处理已停止 |
| Notify on dataprocessingOid | 已请求停止数据处理但仍在进行中 |
复制
分析工作区更新¶
用于执行分析工作区更新的 API
从通过 database_id 指示的环境中更新分析工作区 target_workspace_code。
方法¶
POST
URL¶
参数¶
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| sourceType | text | 必填 | 指定更新的源类型。 值：LOCAL、FILE |
| disableDataManagementAudit | boolean | 可选 | 禁用审计中的 'Data Management' 项 值：true/false 默认：false |
| dtpOperationSortingType | text | 可选 | 指示 DTP 操作的更新方式。 值：REORDER_USING_CODES、APPEND 默认：REORDER_USING_CODES |
| sourceWorkspaceCode | text | 必填，仅当 sourceType = LOCAL 时可定义 | 要从中更新的分析工作区代码。 |
| date | boolean | 可选，仅当 sourceType = LOCAL 时可定义 | 在更新中包含源分析工作区的数据。 值：true/false 默认：false。 |
| filename | text | 必填，仅当 sourceType = FILE 时可定义 | 标识要导入的文件。可以指定： - 单个文件名 - 文件名列表（分隔符 = ;) - 所有扩展名为 .awex 的文件（filename = *） |
| endpoint | text | 可选，仅当 sourceType = FILE 时可定义 | 如果文件位于远程目录中，则要使用的端点。 参见 。 |
| dir | text | 可选，仅当 sourceType = FILE 时可定义 | 文件所在的目录。如果指定了端点，则允许基于端点的根目录指定子目录。 如果未指定端点，则可以指定： - 空字段 = 配置为 CCH Tagetik 可写文件夹的目录 - 相对路径 = 可写文件夹子目录 - 绝对路径 = 指定的通用目录（参见系统管理模块中的 ） |
示例
复制
{
"sourceType": "LOCAL",
"dtpOperationSortingType": "REORDER_USING_CODES",
"sourceWorkspaceCode":"005",
"data": true
}
复制
{
"sourceType": "FILE",
"dtpOperationSortingType": "APPEND",
"filename":"export.awex",
"endpoint":"",
"dir":"tmp"
}
返回的数据¶
响应以 JSON 格式返回以下 ID：
dataprocessingId = 数据处理 ID。
复制
用于检查分析工作区更新状态的 API
返回更新数据处理的状态。
方法¶
GET
URL¶
返回的数据¶
响应以 JSON 格式返回数据处理状态：
status：RUNNING/FAILED/COMPLETED
| 状态 | 描述 |
|---|---|
| RUNNING | 运行中 |
| FAILED | 失败 |
| COMPLETED | 成功完成 |
复制
用于中断分析工作区更新的 API
停止更新。
方法¶
DELETE
URL¶
返回的数据¶
响应以 JSON 格式返回以下 ID：
message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"
| 消息 | 描述 |
|---|---|
| Stop on dataprocessingOid | 数据处理已停止 |
| Notify on dataprocessingOid | 已请求停止数据处理但仍在进行中 |
复制
分析工作区的 DTP 导出¶
用于从分析工作区导出 DTP 的 API
从通过 database_id 指示的环境中运行属于分析工作区 workspace_code 的 DTP dtp_code 的导出。
方法¶
POST
URL¶
参数¶
无
返回的数据¶
响应以 JSON 格式返回以下 ID：
dataprocessingId = 数据处理 ID。
复制
用于检查分析工作区 DTP 导出状态的 API
返回 DTP 导出处理的状态。
方法¶
GET
URL¶
返回的数据¶
响应以 JSON 格式返回数据处理状态：
status：RUNNING/FAILED/COMPLETED
| 状态 | 描述 |
|---|---|
| RUNNING | 运行中 |
| FAILED | 失败 |
| COMPLETED | 成功完成 |
exportedFileNames：生成的文件名
复制
{
"requestDateTime": "2021-06-25T10:56:42.850+0000",
"status": "COMPLETED",
"parameters": [
{
"exportedFileNames": "DTP_export_DB_USER_1_20230206115313820.awex"
}
]
}
用于中止分析工作区 DTP 导出的 API
停止 DTP 导出。
方法¶
DELETE
URL¶
返回的数据¶
响应以 JSON 格式返回以下 ID：
message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"
| 消息 | 描述 |
|---|---|
| Stop on dataprocessingOid | 数据处理已停止 |
| Notify on dataprocessingOid | 已请求停止数据处理但仍在进行中 |
复制
分析工作区的 DTP 导入¶
用于从分析工作区导入 DTP 的 API
在通过 database_id 标识的环境上，从分析工作区 workspace_code 导入 DTP。
方法¶
POST
URL¶
JSON 格式的属性¶
以下属性可以 JSON 格式包含在请求体中。
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| filename | text | 必填 | 标识要导入的文件。可以指定： - 单个文件名 - 文件名列表（分隔符 = ;) - 所有扩展名为 .awex 的文件（filename = *） |
| endpoint | text | 可选 | 如果文件位于远程目录中，则要使用的端点。 参见 。 |
| dir | text | 可选 | 文件所在的目录。如果指定了端点，则允许基于端点的根目录指定子目录。 如果未指定端点，则可以指定： - 空字段 = 配置为 CCH Tagetik 可写文件夹的目录 - 相对路径 = 可写文件夹子目录 - 绝对路径 = 指定的通用目录（参见系统管理模块中的 ） |
示例
复制
复制
返回的数据¶
在响应中，将以 JSON 格式返回以下 ID：
dataprocessingId = 数据处理 ID
复制
用于检查分析工作区 DTP 导入状态的 API
返回 DTP 导入数据处理的状态。
方法¶
GET
URL¶
返回的数据¶
响应以 JSON 格式返回数据处理状态：
status：RUNNING/FAILED/COMPLETED
| 状态 | 描述 |
|---|---|
| RUNNING | 运行中 |
| FAILED | 失败 |
| COMPLETED | 成功完成 |
复制
用于中断分析工作区 DTP 导入的 API
停止 DTP 的导入。
方法¶
DELETE
URL¶
返回的数据¶
响应以 JSON 格式返回以下 ID：
message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"
| 消息 | 描述 |
|---|---|
| Stop on dataprocessingOid | 数据处理已停止 |
| Notify on dataprocessingOid | 已请求停止数据处理但仍在进行中 |
复制