API Category Dimension
This API enables the extraction of information, creation, modification and deletion of the Category dimension elements of the Tagetik application.
| API Title: | AIH Category openapi 3.0.3 | |
| Description: | API for managing elements of the Category dimension | |
| Version: | 1.000 | |
| Authentication: | OAuth2, API Key, JWT, Basic Auth |
Prerequisites¶
In order to use these APIs, the user must authenticate through the authentication mode chosen for [CCH Tagetik].
Moreover, APIs must also be enabled in the Repository. For reverse proxies, further settings are necessary. They can be used with both http and https protocols.
For more details on authentication and enabling, see Enabling REST API.
Request format: JSON
Response format: JSON
| Http Method | Endpoint | Body of the request | Query string parameters | Body of the answer | HTTP response body | Response Status (Exception) |
|---|---|---|---|---|---|---|
| POST | Category Element | Category Element | 201 (Created) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| GET | Category Element | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) | |||
| PUT | 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 | filter sort skip take (optional parameters) | List of Category Elements | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| GET | filter sort skip take (optional parameters) | Quantity of Category Element | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| GET | properties filter sort skip take (properties mandatory, other parameters optional) | 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 | Category Element | Category Element | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| POST | Category element(s) | Success | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| POST | 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 | 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 | Dataprocessing ID | 202 (Accepted) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) |
"filter" accepts all fields except "oid"
"properties" accepts all response fields, plus the "description" field displaying the description in the DB's default language. (mandatory)
The post-bulk call accepts post, patch and put operations.
Supported Fields in Request (fields that may be present in the body of the request)¶
| Category field | Supported cardinality | Supported Values |
|---|---|---|
| id | string (mandatory) | |
| oid | string | |
| descriptions.[lingua] | string (one mandatory) | |
| categoryType | AMOUNT, CONSOLIDATOR_AMOUNT, ENTITY_JOURNAL, CONSOLIDATOR_ENTITY_JOURNAL, CONSOLIDATION_JOURNAL (mandatory) | |
| 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 |
¶
The 'descriptions' field consists of a key-value array where the key is the abbreviated wording of a language and the value is a string
Additional Fields in Response (fields that may be present in the body of the response)¶
| Category field | Supported Values |
|---|---|
| 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, |
Examples of requests¶
Create a Category Element
| Method | POST |
| Endpoint | /api/aih/dimensions/v1/{dbID}/category/elements |
| Body | { "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 } } } |
| Example of response | { "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" } } |
Create a specific Category Element
| Method | GET |
| Endpoint | /api/aih/datamodel/v1/{dbID}/workspaces |
| Body | - |
| Example of response | { "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" } } |
Enter a Category element
| Method | PUT |
| Endpoint | /api/aih/dimensions/v1/{dbID}/category/elements/011 |
| Body | { "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 } } } |
| Example of response | { "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" } } |
List of all Category elements
| Method | GET |
| Endpoint | /api/aih/dimensions/v1/{dbID}/category/elements |
| Body | - |
| Example of response | [ { "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" } } ] |
Number of Category Elements
| Method | GET |
| Endpoint | /api/aih/dimensions/v1/{dbID}/category/elements-count |
| Body | - |
| Example of response | 12 |
Show a list of Category elements with only the ID and description fields
| Method | GET |
| Endpoint | /api/aih/dimensions/v1/{dbID}/category/elements-fetch?properties=id,description |
| Body | - |
| Example of response | [ { "id": "010", "descriptions": "category" }, { "id": "011", "descriptions": "category2" } ] |
Edit a Category Element
| Method | PATCH |
| Endpoint | /api/aih/dimensions/v1/{dbID}/category/elements/011 |
| Body | { "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 } } } |
| Example of response | { "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" } } |
Create an element, insert another element, edit another element
| Method | POST |
| Endpoint | /api/aih/dimensions/v1/{dbID}/category/elements-bulk |
| Body | { "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" } } } ] } |
| Example of response | { "code": "SUCCESS" } |
Delete a list of Category elements
| Method | POST |
| Endpoint | /api/aih/dimensions/v1/{dbID}/category/elements-bulk-delete-async |
| Body | [ { "id": "012" }, { "id": "013" } ] |
| Example of response | { "dataProcessingId": "2C98F135918DD37A1D9D1F84BF1B3CF8" } |
Check the status of a deletion data processing
| Method | GET |
| Endpoint | /api/aih/dimensions/v1/{dbID}/category/elements-bulk-delete-async/2C98F135918DD37A1D9D1F84BF1B3CF8 |
| Body | - |
| Example of response | { "requestDateTime": "2026-03-23T11:04:46.772+0000", "status": "COMPLETED", "parameters": {} } |
Abort a deletion data processing
| Method | DELETE |
| Endpoint | /api/aih/dimensions/v1/{dbID}/category/elements-bulk-delete-async/2C98F135918DD37A1D9D1F84BF1B3CF8 |
| Body | - |
| Example of response | { "message": "Stop on dataprocessingOid 2C98ACE49D28242F019D29C846712CA9" } |