分区管理 API
此 API 支持从 Tagetik 应用程序数据集中提取信息、创建和删除分区。
| API 标题： | AIH Dataset swagger openapi 3.0.3 |
| 描述： | 用于 AIH 数据库应用程序中分区管理的 API |
| 版本： | 1.000 |
| 身份验证： | OAuth2、API Key、JWT、Basic Auth |
| 基础 URL： | https://tenantxyz.api.saastagetik.com/basic https://tenantxyz.api.saastagetik.com/jwt https://tenantxyz.api.saastagetik.com/apikey https://tenantxyz.api.saastagetik.com/oauth2 |
前提条件¶
请求格式：JSON
响应格式：JSON
共享标头
- Content-Type：application/json
- Authorisation：Bearer
。
URL¶
| 操作 | Http 方法 | 请求体 | 路径变量 | 查询字符串参数 | 响应体 | HTTP 响应体 | 响应状态（异常） |
|---|---|---|---|---|---|---|---|
| 创建 | POST | 数据集分区 | 数据集分区 | 201（已创建） | 405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求） | ||
| 读取 | GET | 数据集分区 ID | 数据集分区 | 200（OK） | 405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） | ||
| 搜索 | GET | filter sort skip take （可选参数） | 数据集分区列表 | 200（OK） | 405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求） | ||
| 搜索大小 | GET | filter sort skip take （可选参数） | 数据集分区的数量 | 200（OK） | 405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求） | ||
| 批量删除异步 | POST | 分区 ID 数据集 | ID 数据处理 | 202（已接受） | 405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求） |
"filter' 接受字段 'id、process.id、process.description、scenario.id、scenario.description、period.id、period.description、entity.id、entity.description、typology.id、typology.description 和 status'。
请求中支持的字段¶
| 分区字段 | 支持的基数 | 支持的值 |
|---|---|---|
| process.id | - | string |
| scenario.id | - | string |
| period.id | - | string |
| entity.id | - | string |
| typology.id | - | string |
¶
响应中的附加字段¶
| *分区* 字段 | 支持的值 |
|---|---|
| process.description | string |
| scenario.description | string |
| period.description | string |
| entity.description | string |
| typology.description | string |
| status | ONLINE、OFFLINE、UPGRADE_IN_PROGRESS |
| id | string |
| physicalTableName | string |
请求示例¶
显示数据集中所有分区的列表
| 方法 | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasets/000001/partitions |
| 请求体 | - |
| 响应示例 | [ { "id": "000001", "physicalTableName": "AW_EFG_P00003_000001", "status": "ONLINE", "process": { "id": "BDG", "description": "BDG" }, "scenario": { "id": "$", "description": null }, "period": { "id": "$", "description": null }, "entity": { "id": "EN_00", "description": "New York xx" }, "typology": { "id": "$", "description": null } }, { "id": "000002", "physicalTableName": "AW_EFG_P00003_000002", "status": "ONLINE", "process": { "id": "SFT", "description": "Chiusura Leggera" }, "scenario": { "id": "2019ACT", "description": "2019 Actuals" }, "period": { "id": "11", "description": "Novembre" }, "entity": { "id": "EN_00", "description": "New York xx" }, "typology": { "id": "$", "description": null } } ] |
显示数据集的特定分区
| 方法 | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasets/000001/partitions/000001 |
| 请求体 | - |
| 响应示例 | { "id": "000001", "physicalTableName": "AW_EFG_000001_000001", "status": "ONLINE", "process": { "id": "BDG", "description": "BDG" }, "scenario": { "id": "$", "description": null }, "period": { "id": "$", "description": null }, "entity": { "id": "EN_00", "description": "New York xx" }, "typology": { "id": "$", "description": null } } |
显示分区的数量
| 方法 | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasets/000001/partitions-count |
| 请求体 | - |
| 响应示例 | 12 |
创建新分区
| 方法 | POST |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasets/000001/partitions |
| 请求体 | { "process": { "id": "BDG" }, "entity": { "id": "EN_00" }, "typology": { "id": "TIP" } } |
| 响应示例 | { "id": "000001", "physicalTableName": "AW_EFG_000001_000001", "status": "ONLINE", "process": { "id": "BDG", "description": "BDG" }, "scenario": { "id": "$", "description": null }, "period": { "id": "$", "description": null }, "entity": { "id": "EN_00", "description": "New York xx" }, "typology": { "id": "$", "description": null } } |
删除分区
| 方法 | POST |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasets/123459/partitions-bulk-delete-async |
| 请求体 | [ { "id": "000001" } ] |
| 响应示例 | { "dataProcessingId": "2C980CE49BD9F03A019BDC638CE7545B" } |