跳转至

API 类别维度

此 API 支持提取信息，以及创建、修改和删除 Tagetik 应用程序的类别（Category）维度元素。
API 标题： AIH Category openapi 3.0.3
描述： 用于管理类别维度元素的 API
版本： 1.000
身份验证： OAuth2、API Key、JWT、Basic Auth

前提条件

要使用这些 API，用户必须通过为 [CCH Tagetik] 选择的身​​份验证模式进行身份验证。

此外，还必须在存储库中启用 API。对于反向代理，还需要进行其他设置。它们可以同时使用 http 和 https 协议。

有关身份验证和启用的更多详细信息，请参阅启用 REST API。

请求格式：JSON

响应格式：JSON

Http 方法 端点 请求正文 查询字符串参数 应答正文 HTTP 响应正文 响应状态（异常）
POST /api/aih/dimensions/v1/{dbID}/category/elements Category Element Category Element 201 (Created) 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request)
GET /api/aih/dimensions/v1/{dbID}/category/elements/{id} Category Element 200 (OK) 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised)
PUT /api/aih/dimensions/v1/{dbID}/category/elements/{id} Category Element Category Element 200 (OK) 201 (Created) 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request)
GET /api/aih/dimensions/v1/{dbID}/category/elements filter sort skip take （可选参数） List of Category Elements 200 (OK) 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request)
GET /api/aih/dimensions/v1/{dbID}/category/elements-count filter sort skip take （可选参数） Quantity of Category Element 200 (OK) 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request)
GET /api/aih/dimensions/v1/{dbID}/category/elements-fetch properties filter sort skip take （properties 为必填，其他参数可选） List of Category Elements with only the selected properties 200 (OK) 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request)
PATCH /api/aih/dimensions/v1/{dbID}/category/elements/{id} Category Element Category Element 200 (OK) 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request)
POST /api/aih/dimensions/v1/{dbID}/category/elements-bulk Category element(s) Success 200 (OK) 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request)
POST /api/aih/dimensions/v1/{dbID}/category/elements-bulk-delete-async List of Category Element IDs Dataprocessing ID 202 (Accepted) 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request)
GET /api/aih/dimensions/v1/{dbID}/category/elements-bulk-delete-async/{dataprocessingID} Date and time of request, dataprocessing status, parameters 200 (OK) 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request)
DELETE /api/aih/dimensions/v1/{dbID}/category/elements-bulk-delete-async/{dataprocessingID} Dataprocessing ID 202 (Accepted) 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request)

“filter”接受除“oid”之外的所有字段

“properties”接受所有响应字段，外加显示数据库默认语言描述的“description”字段。（必填）

post-bulk 调用接受 post、patch 和 put 操作。

请求中支持的字段（可能出现在请求正文中的字段）

类别字段 支持的基数 支持的值
id string（必填）
oid string
descriptions.[lingua] string（一个必填）
categoryType AMOUNT, CONSOLIDATOR_AMOUNT, ENTITY_JOURNAL, CONSOLIDATOR_ENTITY_JOURNAL, CONSOLIDATION_JOURNAL （必填）
defaultForJournal.periodic true/false
defaultForJournal.enableCarryForward
defaultForJournal.excludeReclassificationsAndNER true/false
defaultForJournal.taxCalculationMethod NONE, MASTER_ENTITY, MASTER_ENTITY_INVERT_CREDIT_DEBIT, SLAVE_ENTITY, SLAVE_ENTITY_INVERT_CREDIT_DEBI
defaultForJournal.reverseJournalType NONE, BS_TO_0, BS_TO_0_PL_WRITE_OFF, BS_AND_VARIATION_TO_0_PL_WRITE_OFF
advanced.handleAsAJournal string
advanced.runnableCategory string
advanced.childCategory string
advanced.referenceCategoryForChild.id string
advanced.monthlySplittingType string
bankingData.notifyIndividualData true/false
bankingData.notify36381 true/false
bankingData.notifyOtherIntergroupItems true/false

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

响应中的附加字段（可能出现在响应正文中的字段）

类别字段 支持的值
defaultForConsolidationJournals.overrideCtpSegmentSetEqualToEntity. true/false
defaultForConsolidationJournals.proportionalCalculationMethod NONE, LESSER, GREATER, ENTITY_1, ENTITY_1_X_ENTITY_2
defaultForConsolidationJournals.equityEvaluationMethod NONE, ELIMINATE, EVALUATE_IF_SINGLE_ENTITY, EVALUATE_IF_ENTITY_2_EQUITY
defaultForConsolidationJournals.minoritiesCalculationMethod NONE, BASED_ON_ENTITY_1, ADVANCED, NORMAL
defaultForConsolidationJournals.minoritiesCalculationMethodOnEntity1 NONE, BASED_ON_ENTITY_1, BASED_ON_ENTITY_2
defaultForConsolidationJournals.minoritiesCalculationMethodOnEntity2 NONE, BASED_ON_ENTITY_1, BASED_ON_ENTITY_2
updateInfo.user string
updateInfo.date date
updateInfo.origin INPUT_WEB,

请求示例

创建类别元素
方法 POST
端点 /api/aih/dimensions/v1/{dbID}/category/elements
正文 { "id": "011", "descriptions": { "en": "011", "it": null, "ja": null, "aa": null }, "categoryType": "ENTITY_JOURNAL", "advanced": { "handleAsAJournal": null, "runnableCategory": true, "childCategory": false, "referenceCategoryForChild": null, "monthlySplittingType": "BASED_ON_ACCOUNT" }, "consolidation": { "defaultForJournal": { "periodicJournal": false, "enableCarryForward": false, "exludeReclassificationAndNER": false, "taxCalculationMethod": "NONE", "reverseJournalType": "NONE" }, "bankingData": { "notifyIndividualData": false, "notify36381": false, "notifyIntragroupItems": false } } }
响应示例 { "id": "011", "descriptions": { "en": "011", "it": null, "ja": null, "aa": null }, "categoryType": "ENTITY_JOURNAL", "advanced": { "handleAsAJournal": null, "runnableCategory": true, "childCategory": false, "referenceCategoryForChild": null, "monthlySplittingType": "BASED_ON_ACCOUNT" }, "consolidation": { "defaultForJournal": { "periodicJournal": false, "enableCarryForward": false, "exludeReclassificationAndNER": false, "taxCalculationMethod": "NONE", "reverseJournalType": "NONE" }, "bankingData": { "notifyIndividualData": false, "notify36381": false, "notifyIntragroupItems": false } }, "updateInfo": { "user": "USER", "date": "2023-10-04T15:57:15.361+0000", "origin": "INPUT_WEB" } }

创建特定类别元素
方法 GET
端点 /api/aih/datamodel/v1/{dbID}/workspaces/api/aih/dimensions/v1/{dbID}/category/elements/011
正文 -
响应示例 { "id": "011", "descriptions": { "en": "011", "it": null, "ja": null, "aa": null }, "categoryType": "ENTITY_JOURNAL", "advanced": { "handleAsAJournal": null, "runnableCategory": true, "childCategory": false, "referenceCategoryForChild": null, "monthlySplittingType": "BASED_ON_ACCOUNT" }, "consolidation": { "defaultForJournal": { "periodicJournal": false, "enableCarryForward": false, "exludeReclassificationAndNER": false, "taxCalculationMethod": "NONE", "reverseJournalType": "NONE" }, "bankingData": { "notifyIndividualData": false, "notify36381": false, "notifyIntragroupItems": false } }, "updateInfo": { "user": "USER", "date": "2023-10-04T15:57:15.361+0000", "origin": "INPUT_WEB" } }

录入类别元素
方法 PUT
端点 /api/aih/dimensions/v1/{dbID}/category/elements/011
正文 { "id": "011", "descriptions": { "en": "Inserted", "it": null, "ja": null, "aa": null }, "categoryType": "ENTITY_JOURNAL", "advanced": { "handleAsAJournal": null, "runnableCategory": true, "childCategory": false, "referenceCategoryForChild": null, "monthlySplittingType": "BASED_ON_ACCOUNT" }, "consolidation": { "defaultForJournal": { "periodicJournal": false, "enableCarryForward": false, "exludeReclassificationAndNER": false, "taxCalculationMethod": "NONE", "reverseJournalType": "NONE" }, "bankingData": { "notifyIndividualData": false, "notify36381": false, "notifyIntragroupItems": false } } }
响应示例 { "id": "011", "descriptions": { "en": "Inserted", "it": null, "ja": null, "aa": null }, "categoryType": "ENTITY_JOURNAL", "advanced": { "handleAsAJournal": null, "runnableCategory": true, "childCategory": false, "referenceCategoryForChild": null, "monthlySplittingType": "BASED_ON_ACCOUNT" }, "consolidation": { "defaultForJournal": { "periodicJournal": false, "enableCarryForward": false, "exludeReclassificationAndNER": false, "taxCalculationMethod": "NONE", "reverseJournalType": "NONE" }, "bankingData": { "notifyIndividualData": false, "notify36381": false, "notifyIntragroupItems": false } }, "updateInfo": { "user": "USER", "date": "2023-10-04T15:57:15.361+0000", "origin": "INPUT_WEB" } }

所有类别元素的列表
方法 GET
端点 /api/aih/dimensions/v1/{dbID}/category/elements
正文 -
响应示例 [ { "id": "010", "descriptions": { "en": "Original Data (En)", "it": "Original Data (It)", "ja": "Original Data", "aa": "Original Data" }, "categoryType": "AMOUNT", "advanced": { "handleAsAJournal": false, "runnableCategory": true, "childCategory": false, "referenceCategoryForChild": null, "monthlySplittingType": "BASED_ON_ACCOUNT" }, "consolidation": { "bankingData": { "notifyIndividualData": false, "notify36381": false, "notifyIntragroupItems": false } }, "updateInfo": { "user": "USER2", "date": "2024-03-04T13:26:13.018+0000", "origin": "INPUT_WEB" } }, { "id": "011", "descriptions": { "en": "011", "it": null, "ja": null, "aa": null }, "categoryType": "ENTITY_JOURNAL", "advanced": { "handleAsAJournal": null, "runnableCategory": true, "childCategory": false, "referenceCategoryForChild": null, "monthlySplittingType": "BASED_ON_ACCOUNT" }, "consolidation": { "defaultForJournal": { "periodicJournal": false, "enableCarryForward": false, "exludeReclassificationAndNER": false, "taxCalculationMethod": "NONE", "reverseJournalType": "NONE" }, "bankingData": { "notifyIndividualData": false, "notify36381": false, "notifyIntragroupItems": false } }, "updateInfo": { "user": "USER", "date": "2023-10-04T15:57:15.361+0000", "origin": "INPUT_WEB" } } ]

类别元素的数量
方法 GET
端点 /api/aih/dimensions/v1/{dbID}/category/elements-count
正文 -
响应示例 12

显示仅包含 ID 和 description 字段的类别元素列表
方法 GET
端点 /api/aih/dimensions/v1/{dbID}/category/elements-fetch?properties=id,description
正文 -
响应示例 [ { "id": "010", "descriptions": "category" }, { "id": "011", "descriptions": "category2" } ]

编辑类别元素
方法 PATCH
端点 /api/aih/dimensions/v1/{dbID}/category/elements/011
正文 { "id": "011", "descriptions": { "en": "Modified", "it": null, "ja": null, "aa": null }, "categoryType": "ENTITY_JOURNAL", "advanced": { "handleAsAJournal": null, "runnableCategory": true, "childCategory": false, "referenceCategoryForChild": null, "monthlySplittingType": "BASED_ON_ACCOUNT" }, "consolidation": { "defaultForJournal": { "periodicJournal": false, "enableCarryForward": false, "exludeReclassificationAndNER": false, "taxCalculationMethod": "NONE", "reverseJournalType": "NONE" }, "bankingData": { "notifyIndividualData": false, "notify36381": false, "notifyIntragroupItems": false } } }
响应示例 { "id": "011", "descriptions": { "en": "Modified", "it": null, "ja": null, "aa": null }, "categoryType": "ENTITY_JOURNAL", "advanced": { "handleAsAJournal": null, "runnableCategory": true, "childCategory": false, "referenceCategoryForChild": null, "monthlySplittingType": "BASED_ON_ACCOUNT" }, "consolidation": { "defaultForJournal": { "periodicJournal": false, "enableCarryForward": false, "exludeReclassificationAndNER": false, "taxCalculationMethod": "NONE", "reverseJournalType": "NONE" }, "bankingData": { "notifyIndividualData": false, "notify36381": false, "notifyIntragroupItems": false } }, "updateInfo": { "user": "USER", "date": "2023-10-04T15:57:15.361+0000", "origin": "INPUT_WEB" } }

创建一个元素、插入另一个元素、编辑另一个元素
方法 POST
端点 /api/aih/dimensions/v1/{dbID}/category/elements-bulk
正文 { "saveMode": "LOOSE", "post": [ { "id": "BULPO", "currency": { "id": "EUR" }, "descriptions": { "it": "BULPO-it", "en": "BULPO-en" } } ], "put": [ { "id": "BULPC", "currency": { "id": "EUR" }, "descriptions": { "it": "BULPC-it", "en": "BULPC-en" } } ], "patch": [ { "key": { "id": "BULPA" }, "data": { "currency": { "id": "AUD" }, "descriptions": { "it": "Patchato-it", "en": "Patched-en" } } } ] }
响应示例 { "code": "SUCCESS" }

删除类别元素列表
方法 POST
端点 /api/aih/dimensions/v1/{dbID}/category/elements-bulk-delete-async
正文 [ { "id": "012" }, { "id": "013" } ]
响应示例 { "dataProcessingId": "2C98F135918DD37A1D9D1F84BF1B3CF8" }

检查删除数据处理的状态
方法 GET
端点 /api/aih/dimensions/v1/{dbID}/category/elements-bulk-delete-async/2C98F135918DD37A1D9D1F84BF1B3CF8
正文 -
响应示例 { "requestDateTime": "2026-03-23T11:04:46.772+0000", "status": "COMPLETED", "parameters": {} }

中止删除数据处理
方法 DELETE
端点 /api/aih/dimensions/v1/{dbID}/category/elements-bulk-delete-async/2C98F135918DD37A1D9D1F84BF1B3CF8
正文 -
响应示例 { "message": "Stop on dataprocessingOid 2C98ACE49D28242F019D29C846712CA9" }