API 自定义维度

简介

CCH Tagetik 还允许通过 OPEN RESTful API 管理自定义维度。

API 标题：		Custom 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

/dimensions/v1/{dbID}/{customDimIdentifier}/elements/{id}

Http 方法	端点	请求正文	查询字符串参数	应答正文	HTTP 响应正文	响应状态（异常）
GET	/dimensions/v1/{dbID}/{customDimIdentifier}/elements/{id}			自定义维度	200 (OK)	404 (未找到) 403 (访问未授权资源) 401 (未授权)

响应中的字段

数据集字段	支持的值
id	string
descriptions.[lingua]	string
validity.startDate	date
validity.endDate	date
customAttributes	string
updateInfo.user	string
updateInfo.date	date
updateInfo.origin	string

'descriptions' 字段由一个键值数组组成，其中键是某种语言的缩写，值是字符串

请求示例

方法	GET
端点	/dimensions/v1/{dbID}/{customDimIdentifier}/elements/{id}
正文	-
响应示例	{ "id": "AU", "descriptions": { "en": "Innsbruck", "it": "Innsbruck", "es": "Innsbruck", "fr": "Innsbruck" }, "validity": { "startDate": "2025-11-03T00:00:00.000+0000", "endDate": "2025-11-26T00:00:00.000+0000" }, "customAttributes": null, "updateInfo": { "user": "USER_BS", "date": "2025-11-24T11:29:22.561+0000", "origin": "INPUT_WEB" } }