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 响应体 | 响应状态（异常） |
|---|---|---|---|---|---|---|---|
| Create | POST | 数据集 ID 列表 | 分析工作区 ID | 数据处理 ID | 201 (Created) | 405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） 400（无效请求） | |
| Read | GET | 数据处理 ID | 数据处理信息 | 200 (OK) | 405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） | ||
| Delete | 数据处理 ID | 数据处理 ID 的停止消息 | 200 (OK) | 405（方法不允许） 404（未找到） 403（访问未授权资源） 401（未授权） |
"filter' 接受字段 'id, process.id, process.description, scenario.id, scenario.description, period.id, period.description, entity.id, entity.description, typology.id, typology.description 和 status'。
请求中支持的字段¶
| 分区字段 | 支持的基数 | 支持的值 |
|---|---|---|
| datasets | 分析工作区数据集的数量 | string |
¶
响应中的附加字段¶
| *分区*字段 | 支持的值 |
|---|---|
| dataprocessingId | string |
| requestDateTime | date |
| status | RUNNING, FAILED, COMPLETED |
| parameters | string |
请求示例¶
显示特定数据处理的状态
| 方法 | GET |
| URL | /api/aih/setonline/v1/{dbID}/2C98FD249BDE7D25019BE12F29473052 |
| 请求体 | - |
| 响应示例 | { "requestDateTime": "2026-01-21T15:32:03.244+0000", "status": "COMPLETED", "parameters": {} } |
将分析工作区的特定数据集置为在线
| 方法 | POST |
| URL | /api/aih/setonline/v1/{dbID}/AWN |
| 请求体 | { "datasets": [ "ABC", "BBB" ] } |
| 响应示例 | { "dataprocessingId": "2C98FD249BDE7D25019BE12F29473052" } |
停止数据处理
| 停止数据处理 | |
| 方法 | DELETE |
| URL | /api/aih/setonline/v1/{dbID}/2C98FD249BDE7D25019BE12F29473052 |
| 请求体 | - |
| 响应示例 | { "message": "Stop on dataprocessingOid 2C98FD249BDE7D25019BE12F29473052" } |