API 分析维度
简介¶
CCH Tagetik 还允许通过 OPEN RESTful API 管理分析维度。
| API 标题： | Analytical Dimension openapi 3.0.3 | |
| 描述： | 用于管理分析维度的 API | |
| 版本： | 1.000 | |
| 身份验证： | OAuth2、API Key、JWT、Basic Auth |
前提条件¶
要使用这些 API，用户必须通过为 [CCH Tagetik] 所选的身份验证模式进行身份验证。
此外，还必须在 Repository 中启用 API。对于反向代理，还需要进行额外设置。它们可同时用于 http 和 https 协议。
有关身份验证和启用的更多详细信息，请参阅 启用 REST API 和 API 身份验证。
请求格式：JSON
响应格式：JSON
URL¶
| Http 方法 | 端点 | 请求体 | 查询字符串参数 | 响应体 | HTTP 响应体 | 响应状态（异常） |
|---|---|---|---|---|---|---|
| GET | 分析维度 | 200 (OK) | 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) |
响应中的字段¶
| 数据集字段 | 支持的值 |
|---|---|
| id | string |
| descriptions.[lingua] | string |
| validity.startDate | date |
| validity.endDate | date |
| updateInfo.user | string |
| updateInfo.date | date |
| updateInfo.origin | string |
¶
'descriptions' 字段由一个键值数组组成，其中键是某种语言的缩写措辞，值是一个字符串
请求示例¶
| 方法 | GET |
| 端点 | |
| 请求体 | - |
| 响应示例 | { "id": "01", "descriptions": { "en": "Customer", "it": "Customer", "es": null, "fr": null }, "validity": { "startDate": "2025-12-01T00:00:00.000+0000", "endDate": "2025-12-18T00:00:00.000+0000" }, "updateInfo": { "user": "USER_BS", "date": "2025-12-11T16:17:48.807+0000", "origin": "INPUT_WEB" } } |