数据模型（实验性）
数据模型 REST API¶
CCH Tagetik 通过使用基于 OData v4（Open Data Protocol）标准实现的 RESTful API，公开数据模型维度的层次（层级和平面）。
另外还提供两个用于实体和科目设置的 REST OpenAPI，可通过它们查询和更改相关配置。
| 状态 | SWAGGER | |
| ACTIVE | <api root>/datamodel/swagger-ui/index.html |
|
| 格式 | 根端点 | |
| REST / OpenAPI OData（平面层次） | <api root>/datamodel/v0 |
授权¶
要访问数据模型 API，必须启用以下功能：
- 0000205- Setup & Admin - Data model - Dimensions - Settings - General
- 0004077 - Analytical workspace: OData services（用于与平面表相关的 API）。
分析维度¶
平面层次¶
与分析维度层次的服务根相关的 URL 为：
<api-root>/datamodel/v0/analyticaldimension/database_id/analytical_dimension_id/hierarchies/hierarchy_code/
实体¶
平面层次¶
RESTful API OData 层次的服务根 URL 为：
<api-root>/datamodel/v0/entity/database_id/hierarchies/hierarchy_code/
设置¶
RESTful OpenAPI 的实体设置服务根 URL 为：
<api-root>/datamodel/v0/entity/database_id/config/
使用此 URL，可以调用实体维度设置的 GET 和 PATCH 方法。
科目¶
层次¶
OData RESTful API 的科目层次服务根 URL 为：
<api-root>/datamodel/v0/account/database_id/hierarchies/hierarchy_code/
设置¶
RESTful OpenAPI 科目层次的服务根 URL 为：
<api-root>/datamodel/v0/account/database_id/config/
使用此 URL，可以针对科目维度设置调用 GET 和 PATCH 方法。
自定义维度¶
层次¶
与自定义维度层次的服务根相关的 URL 为：
<api-root>/datamodel/v0/customdimension/database_id/custom_dimension_number/hierarchies/hierarchy_code/
层级¶
在 URL 中添加 Levels，可通过 levelsNumber 属性公开层次的最大层级数。
例如，使用以下 URL：
<api-root>/datamodel/v0/analyticaldimension/TGK_APP/CUSTOMER/hierarchies/001/Levels
返回 levelsNumber=2。
平铺¶
在 URL 中添加 Flat 会以平铺格式公开层次。构成结果轨迹的属性包括：
- 分析维度名称/Entity/Accunt/自定义维度 n：显示元素的代码
- 分析维度名称/Entity/Accunt/自定义维度 nDescription：显示元素的描述
- hierarchy：显示层次的代码
- hierarchyDescription：显示层次的描述
- level1/nome_livello_1：显示层次第一层级的代码（与根相关的节点）。
- level1/nome_livello_1Description**：显示层次第一层级的描述（与根相关的节点）。
- leveln/nome_livello_n：显示层次第 n 层级的代码。
- leveln/nome_livello_nDescription：显示层次第 n 层级的描述。
最后一个层级（第 n+1 层级）显示最低层级元素的代码及其描述。
与层级及其描述相关的属性名称（包括第 n+1 层级）可以通过在应用程序中定义层次的层级名称来自定义。
例如，使用层次的层级作为名称：
- 1：根
- 2：节点
- 3：叶子
URL
<api-root>/datamodel/v0/analyticaldimension/TGK_APP/CUSTOMER/hierarchies/001/Flat
返回：
| Customer | Customer Description | hierarchy | hierarchy Description | Root | Root Description | Node | Node Descript. | Leaf | Leaf Descript. |
|---|---|---|---|---|---|---|---|---|---|
| 0001 | ABC Electronics | 01 | Customer Segments | 01 | Customer Segments | 02_EL | Electric and Electronics | 00001 | ABC Electronics |
| 0002 | Elettro LTD | 01 | Customer Segments | 01 | Customer Segments | 00002 | Elettro LTD | ||
| 0013 | AIR Aviation | 01 | Customer Segments | 01 | Customer Segments | 02_AV | Aviation | 00013 | AIR Aviation |
注意¶
对于 OData API，通过在服务根的 URL 中添加 $metadata，可以显示元数据。