API Entity Dimension
This API enables the extraction of information, creation, modification and deletion of the Entity dimension elements of the Tagetik application.
| API Title: | AIH Entity openapi 3.0.3 | |
| Description: | API for the Entity dimension's elements | |
| 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 | Entity's Element | Entity's Element | 201 (Created) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| GET | Entity's Element | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) | |||
| PUT | Entity's Element | Entity's 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 Entity 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 Entity 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 Entity Elements | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| PATCH | Entity's Element | Entity's Element | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| POST | Entity Element(s) | Success | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| POST | IDs list of Entity Elements | 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)¶
| Entity Field | Supported cardinality | Supported Values |
|---|---|---|
| id | - | string (mandatory) |
| oid | - | string |
| descriptions.[lingua] | - | string (one mandatory) |
| validity.startDate | - | date |
| validity.endDate | - | date |
| sorting | - | string |
| documentation | - | string |
| additionalInfo.businessName | - | EDITABLE, EDITABLE_ONLY_ON_NEW_ROWS, READ_ONLY |
| additionalInfo.legalHQLocation | - | ATTRIBUTE, CONDITION, LEVEL, FILTER |
| additionalInfo.legalHQ | - | string |
| additionalInfo.administrativeHQLocation | - | string |
| additionalInfo.administrativeHQ | - | string |
| additionalInfo.mainOffice | - | string |
| additionalInfo.manager | string | |
| additionalInfo.icMatchingManagers | - | string |
| additionalInfo.email | - | CODE, DESCRIPTION, CODE_AND_DESCRIPTIO |
| additionalInfo.phone | - | string |
| customAttributes.[attributeDescription] | - | string |
| currency.id | - | string (Currency ID) |
| defaultCustomDimension1.id | - | string (CustomDimensionElement ID) |
| defaultCustomDimension2.id | - | string (CustomDimensionElement ID) |
| defaultCustomDimension3.id | - | string (CustomDimensionElement ID) |
| defaultCustomDimension4.id | - | string (CustomDimensionElement ID) |
| defaultCustomDimension5.id | - | string (CustomDimensionElement ID) |
| restrictionCustomDimension1.restriction | - | RESTRICTED, NONE |
| restrictionCustomDimension2.restriction | - | RESTRICTED, NONE |
| restrictionCustomDimension3.restriction | - | RESTRICTED, NONE |
| restrictionCustomDimension4.restriction | - | RESTRICTED, NONE |
| restrictionCustomDimension5.restriction | - | RESTRICTED, NONE |
| rules.fiscalPolicy.id | - | string |
| rules.consolidation.consolidationMethod | - | COST, EQUITY, LINEBYLINE, PROPORTIONAL |
| rules.consolidation.deconsolidationMethod | - | NOTTODECONSOLIDATE,ONLYINITIALBALANCE,FROMPREVIOUSPERIOD,FROMCURRENTPERIOD |
| rules.consolidation.percConsolidation | - | number |
| rules.consolidation.generateCtpElimination | - | ALLELIMINATIONLOGICS, EXCLUDECTPELIMINATIONLOGICS, NEVER |
| rules.consolidation.onlyCtp | - | true/false |
| rules.consolidation.onlyConsolidatorData | - | true/false |
| rules.consolidation.icMatching | - | MANDATORY, OPTIONAL, AUTOMATIC |
| rules.consolidation.excludeAndUseReferenceEntity | - | true/false |
| rules.consolidation.referenceEntity.id | - | string (Entity ID) |
| rules.taxAndCashManagement.runAsEntity | - | true/false |
| rules.taxAndCashManagement.runAsSubentity | - | 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)¶
| Entity Field | Supported Values |
|---|---|
| currency.description | string |
| defaultCustomDimension1.dimensionName | string |
| defaultCustomDimension1.description | string |
| defaultCustomDimension2.dimensionName | string |
| defaultCustomDimension2.description | string |
| defaultCustomDimension3.dimensionName | string |
| defaultCustomDimension3.description | string |
| defaultCustomDimension4.dimensionName | string |
| defaultCustomDimension4.description | string |
| defaultCustomDimension5.dimensionName | string |
| defaultCustomDimension5.description | string |
| restrictionCustomDimension1.dimensionName | string |
| restrictionCustomDimension2.dimensionName | string |
| restrictionCustomDimension3.dimensionName | string |
| restrictionCustomDimension4.dimensionName | string |
| restrictionCustomDimension5.dimensionName | string |
| bankingData.constitutionDate | date |
| bankingData.abiCode | number |
| bankingData.bankGroupRegistrationDate | date |
| bankingData.bankitReportingCode | string |
| bankingData.assignmentDate | date |
| bankingData.centralCreditRiskCode | string |
| bankingData.iso | string |
| bankingData.individualDataSignaling | true/false |
| bankingData.intragroupSignaling | true/false |
| bankingData.excludeFinInvAutomaticInput | true/false |
| updateInfo.user | string |
| updateInfo.date | date |
| updateInfo.origin | INPUT_WEB, |
Examples of requests¶
Create an Entity Element
| Method | POST |
| Endpoint | /api/aih/dimensions/v1/{dbID}/entities/elements |
| Body | { "id": "TESTENT", "descriptions": { "it": "TESTENT-it", "en": "TESTENT-en" }, "sorting": "Asc", "documentationLink": "www.documentation.com", "additionalInfo": { "businessName": "Business name", "legalHQLocation": "Legal HQ Location", "administrativeHQLocation": "Administrative HQ Location", "administrativeHQ": "Legal administrative HQ", "LegalHqLocation": "Legal HQ Location", "mainOffice": "main office", "manager": "manager", "email": "entity@email.com", "phone": "+393332215478", "icMatchingManagers": "ic matching managers" }, "customAttributes": { "Country": "Italy", "Entering group": "1090", "Leaving group": "1088", "Other custom attribute": "Other" }, "currency": { "id": "EUR" }, "defaultCustomDimension1": { "id": "CC_500" }, "defaultCustomDimension2": { "id": "PD_500" }, "defaultCustomDimension3": { "id": "CM_500" }, "defaultCustomDimension4": { "id": "ABC1" }, "defaultCustomDimension5": { "id": "ABC_03" }, "restrictionCustomDimension1": { "restriction": "RESTRICTED" }, "restrictionCustomDimension2": { "restriction": "RESTRICTED" }, "restrictionCustomDimension3": { "restriction": "NONE" }, "restrictionCustomDimension4": { "restriction": "NONE" }, "restrictionCustomDimension5": { "restriction": "NONE" } } |
| Example of response | { "id": "TESTENT", "validity": null, "sorting": "Asc", "documentationLink": "www.documentation.com", "additionalInfo": { "businessName": "Business name", "administrativeHQLocation": "Administrative HQ Location", "administrativeHQ": "Legal administrative HQ", "legalHQLocation": "Legal HQ Location", "legalHQ": null, "mainOffice": "main office", "manager": "manager", "email": "entity@email.com", "phone": "+393332215478", "icMatchingManagers": "ic matching managers" }, "customAttributes": { "Country": "Italy", "Entering Group": null, "Leaving Group": null, "SP Result DEV-82317": null }, "currency": { "id": "EUR", "description": "Euro" }, "defaultCustomDimension1": { "id": "CC_500", "dimensionName": "Cost Centers", "description": "Generic Cost Center" }, "defaultCustomDimension2": { "id": "PD_500", "dimensionName": "Products", "description": "Generic Product" }, "defaultCustomDimension3": { "id": "CM_500", "dimensionName": "Customers en", "description": "Generic Customer" }, "defaultCustomDimension4": { "id": "ABC1", "dimensionName": "Employees", "description": "Generic Employee" }, "defaultCustomDimension5": { "id": "ABC_03", "dimensionName": "Miscellaneous", "description": "Product Packaging" }, "restrictionCustomDimension1": { "dimensionName": "Cost Centers", "restriction": "RESTRICTED" }, "restrictionCustomDimension2": { "dimensionName": "Products", "restriction": "RESTRICTED" }, "restrictionCustomDimension3": { "dimensionName": "Customers en", "restriction": "NONE" }, "restrictionCustomDimension4": { "dimensionName": "Employees", "restriction": "NONE" }, "restrictionCustomDimension5": { "dimensionName": "Miscellaneous", "restriction": "NONE" }, "rules": { "fiscalPolicy": { "id": null, "description": null }, "consolidation": { "consolidationMethod": "COST", "deconsolidationMethod": "NOTTODECONSOLIDATE", "percConsolidation": null, "generateCtpElimination": "ALLELIMINATIONLOGICS", "onlyCtp": false, "onlyConsolidatorData": false, "icMatching": "MANDATORY", "excludeAndUseReferenceEntity": false, "referenceEntity": null }, "taxAndCashManagement": { "runAsEntity": true, "runAsSubentity": false } }, "bankingData": { "constitutionDate": null, "abiCode": null, "bankGroupRegistrationDate": null, "bankitReportingCode": null, "assignmentDate": null, "centralCreditRiskCode": null, "iso": null, "individualDataSignaling": false, "intragroupSignaling": false, "excludeFinInvAutomaticInput": false }, "updateInfo": { "user": "USER", "date": "2026-02-27T16:05:01.512+0000", "origin": "INPUT_WEB" }, "descriptions": { "en": "TESTENT-en", "it": "TESTENT-it", "ja": null, "aa": null } } |
specific element of the Entity
| Method | GET |
| Endpoint | /api/aih/dimensions/v1/{dbID}/entities/elements/TESTENT |
| Body | - |
| Example of response | { "id": "TESTENT", "validity": null, "sorting": "Asc", "documentationLink": "www.documentation.com", "additionalInfo": { "businessName": "Business name", "administrativeHQLocation": "Administrative HQ Location", "administrativeHQ": "Legal administrative HQ", "legalHQLocation": "Legal HQ Location", "legalHQ": null, "mainOffice": "main office", "manager": "manager", "email": "entity@email.com", "phone": "+393332215478", "icMatchingManagers": "ic matching managers" }, "customAttributes": { "Country": "Italy", "Entering Group": null, "Leaving Group": null, "SP Result DEV-82317": null }, "currency": { "id": "EUR", "description": "Euro" }, "defaultCustomDimension1": { "id": "CC_500", "dimensionName": "Cost Centers", "description": "Generic Cost Center" }, "defaultCustomDimension2": { "id": "PD_500", "dimensionName": "Products", "description": "Generic Product" }, "defaultCustomDimension3": { "id": "CM_500", "dimensionName": "Customers en", "description": "Generic Customer" }, "defaultCustomDimension4": { "id": "ABC1", "dimensionName": "Employees", "description": "Generic Employee" }, "defaultCustomDimension5": { "id": "ABC_03", "dimensionName": "Miscellaneous", "description": "Product Packaging" }, "restrictionCustomDimension1": { "dimensionName": "Cost Centers", "restriction": "RESTRICTED" }, "restrictionCustomDimension2": { "dimensionName": "Products", "restriction": "RESTRICTED" }, "restrictionCustomDimension3": { "dimensionName": "Customers en", "restriction": "NONE" }, "restrictionCustomDimension4": { "dimensionName": "Employees", "restriction": "NONE" }, "restrictionCustomDimension5": { "dimensionName": "Miscellaneous", "restriction": "NONE" }, "rules": { "fiscalPolicy": { "id": null, "description": null }, "consolidation": { "consolidationMethod": "COST", "deconsolidationMethod": "NOTTODECONSOLIDATE", "percConsolidation": null, "generateCtpElimination": "ALLELIMINATIONLOGICS", "onlyCtp": false, "onlyConsolidatorData": false, "icMatching": "MANDATORY", "excludeAndUseReferenceEntity": false, "referenceEntity": null }, "taxAndCashManagement": { "runAsEntity": true, "runAsSubentity": false } }, "bankingData": { "constitutionDate": null, "abiCode": null, "bankGroupRegistrationDate": null, "bankitReportingCode": null, "assignmentDate": null, "centralCreditRiskCode": null, "iso": null, "individualDataSignaling": false, "intragroupSignaling": false, "excludeFinInvAutomaticInput": false }, "updateInfo": { "user": "USER", "date": "2026-02-27T16:05:01.512+0000", "origin": "INPUT_WEB" }, "descriptions": { "en": "TESTENT-en", "it": "TESTENT-it", "ja": null, "aa": null } } |
Enter an Entity element
| Method | PUT |
| Endpoint | /api/aih/dimensions/v1/{dbID}/entities/elements/TESTENT |
| Body | { "id": "TESTENT", "descriptions": { "it": null, "en": "Inserted" }, "sorting": "Asc", "documentationLink": "www.documentation.com", "additionalInfo": { "businessName": "Business name", "legalHQLocation": "Legal HQ Location", "administrativeHQLocation": "Administrative HQ Location", "administrativeHQ": "Legal administrative HQ", "LegalHqLocation": "Legal HQ Location", "mainOffice": "main office", "manager": "manager", "email": "entity@email.com", "phone": "+393332215478", "icMatchingManagers": "ic matching managers" }, "customAttributes": { "Country": "Italy", "Entering group": "1090", "Leaving group": "1088", "Other custom attribute": "Other" }, "currency": { "id": "EUR" }, "defaultCustomDimension1": { "id": "CC_500" }, "defaultCustomDimension2": { "id": "PD_500" }, "defaultCustomDimension3": { "id": "CM_500" }, "defaultCustomDimension4": { "id": "ABC1" }, "defaultCustomDimension5": { "id": "ABC_03" }, "restrictionCustomDimension1": { "restriction": "RESTRICTED" }, "restrictionCustomDimension2": { "restriction": "RESTRICTED" }, "restrictionCustomDimension3": { "restriction": "NONE" }, "restrictionCustomDimension4": { "restriction": "NONE" }, "restrictionCustomDimension5": { "restriction": "NONE" } } - |
| Example of response | { "id": "TESTENT", "validity": null, "sorting": "Asc", "documentationLink": "www.documentation.com", "additionalInfo": { "businessName": "Business name", "administrativeHQLocation": "Administrative HQ Location", "administrativeHQ": "Legal administrative HQ", "legalHQLocation": "Legal HQ Location", "legalHQ": null, "mainOffice": "main office", "manager": "manager", "email": "entity@email.com", "phone": "+393332215478", "icMatchingManagers": "ic matching managers" }, "customAttributes": { "Country": "Italy", "Entering Group": null, "Leaving Group": null, "SP Result DEV-82317": null }, "currency": { "id": "EUR", "description": "Euro" }, "defaultCustomDimension1": { "id": "CC_500", "dimensionName": "Cost Centers", "description": "Generic Cost Center" }, "defaultCustomDimension2": { "id": "PD_500", "dimensionName": "Products", "description": "Generic Product" }, "defaultCustomDimension3": { "id": "CM_500", "dimensionName": "Customers en", "description": "Generic Customer" }, "defaultCustomDimension4": { "id": "ABC1", "dimensionName": "Employees", "description": "Generic Employee" }, "defaultCustomDimension5": { "id": "ABC_03", "dimensionName": "Miscellaneous", "description": "Product Packaging" }, "restrictionCustomDimension1": { "dimensionName": "Cost Centers", "restriction": "RESTRICTED" }, "restrictionCustomDimension2": { "dimensionName": "Products", "restriction": "RESTRICTED" }, "restrictionCustomDimension3": { "dimensionName": "Customers en", "restriction": "NONE" }, "restrictionCustomDimension4": { "dimensionName": "Employees", "restriction": "NONE" }, "restrictionCustomDimension5": { "dimensionName": "Miscellaneous", "restriction": "NONE" }, "rules": { "fiscalPolicy": { "id": null, "description": null }, "consolidation": { "consolidationMethod": "COST", "deconsolidationMethod": "NOTTODECONSOLIDATE", "percConsolidation": null, "generateCtpElimination": "ALLELIMINATIONLOGICS", "onlyCtp": false, "onlyConsolidatorData": false, "icMatching": "MANDATORY", "excludeAndUseReferenceEntity": false, "referenceEntity": null }, "taxAndCashManagement": { "runAsEntity": true, "runAsSubentity": false } }, "bankingData": { "constitutionDate": null, "abiCode": null, "bankGroupRegistrationDate": null, "bankitReportingCode": null, "assignmentDate": null, "centralCreditRiskCode": null, "iso": null, "individualDataSignaling": false, "intragroupSignaling": false, "excludeFinInvAutomaticInput": false }, "updateInfo": { "user": "USER", "date": "2026-02-27T16:05:01.512+0000", "origin": "INPUT_WEB" }, "descriptions": { "en": "Inserted", "it": null, "ja": null, "aa": null } } |
List of all elements of the Entity
| Method | GET |
| Endpoint | /api/aih/dimensions/v1/{dbID}/entities/elements |
| Body | - |
| Example of response | [ { "id": "TESTENT", "validity": null, "sorting": "Asc", "documentationLink": "www.documentation.com", "additionalInfo": { "businessName": "Business name", "administrativeHQLocation": "Administrative HQ Location", "administrativeHQ": "Legal administrative HQ", "legalHQLocation": "Legal HQ Location", "legalHQ": null, "mainOffice": "main office", "manager": "manager", "email": "entity@email.com", "phone": "+393332215478", "icMatchingManagers": "ic matching managers" }, "customAttributes": { "Country": "Italy", "Entering Group": null, "Leaving Group": null, "SP Result DEV-82317": null }, "currency": { "id": "EUR", "description": "Euro" }, "defaultCustomDimension1": { "id": "CC_500", "dimensionName": "Cost Centers", "description": "Generic Cost Center" }, "defaultCustomDimension2": { "id": "PD_500", "dimensionName": "Products", "description": "Generic Product" }, "defaultCustomDimension3": { "id": "CM_500", "dimensionName": "Customers en", "description": "Generic Customer" }, "defaultCustomDimension4": { "id": "ABC1", "dimensionName": "Employees", "description": "Generic Employee" }, "defaultCustomDimension5": { "id": "ABC_03", "dimensionName": "Miscellaneous", "description": "Product Packaging" }, "restrictionCustomDimension1": { "dimensionName": "Cost Centers", "restriction": "RESTRICTED" }, "restrictionCustomDimension2": { "dimensionName": "Products", "restriction": "RESTRICTED" }, "restrictionCustomDimension3": { "dimensionName": "Customers en", "restriction": "NONE" }, "restrictionCustomDimension4": { "dimensionName": "Employees", "restriction": "NONE" }, "restrictionCustomDimension5": { "dimensionName": "Miscellaneous", "restriction": "NONE" }, "rules": { "fiscalPolicy": { "id": null, "description": null }, "consolidation": { "consolidationMethod": "COST", "deconsolidationMethod": "NOTTODECONSOLIDATE", "percConsolidation": null, "generateCtpElimination": "ALLELIMINATIONLOGICS", "onlyCtp": false, "onlyConsolidatorData": false, "icMatching": "MANDATORY", "excludeAndUseReferenceEntity": false, "referenceEntity": null }, "taxAndCashManagement": { "runAsEntity": true, "runAsSubentity": false } }, "bankingData": { "constitutionDate": null, "abiCode": null, "bankGroupRegistrationDate": null, "bankitReportingCode": null, "assignmentDate": null, "centralCreditRiskCode": null, "iso": null, "individualDataSignaling": false, "intragroupSignaling": false, "excludeFinInvAutomaticInput": false }, "updateInfo": { "user": "USER", "date": "2026-02-27T16:05:01.512+0000", "origin": "INPUT_WEB" }, "descriptions": { "en": "TESTENT-en", "it": "TESTENT-it", "ja": null, "aa": null } } ][ { "id": "010", "descriptions": "category" }, { "id": "011", "descriptions": "category2" } ] |
Number of Entity Elements
| Method | GET |
| Endpoint | /api/aih/dimensions/v1/{dbID}/category/elements-count |
| Body | - |
| Example of response | 12 |
Shows a list of Entity elements with only the ID and description fields
| Method | GET |
| Endpoint | /api/aih/dimensions/v1/{dbID}/entity/elements-fetch?properties=id,description |
| Body | - |
| Example of response | [ { "id": "010", "descriptions": "category" }, { "id": "011", "descriptions": "category2" } ] |
Edit an Entity Element
| Method | PATCH |
| Endpoint | /api/aih/dimensions/v1/{dbID}/entities/elements/TESTENT |
| Body | { "id": "TESTENT", "descriptions": { "it": null, "en": "Edited" }, "sorting": "Asc", "documentationLink": "www.documentation.com", "additionalInfo": { "businessName": "Business name", "legalHQLocation": "Legal HQ Location", "administrativeHQLocation": "Administrative HQ Location", "administrativeHQ": "Legal administrative HQ", "LegalHqLocation": "Legal HQ Location", "mainOffice": "main office", "manager": "manager", "email": "entity@email.com", "phone": "+393332215478", "icMatchingManagers": "ic matching managers" }, "customAttributes": { "Country": "Italy", "Entering group": "1090", "Leaving group": "1088", "Other custom attribute": "Other" }, "currency": { "id": "EUR" }, "defaultCustomDimension1": { "id": "CC_500" }, "defaultCustomDimension2": { "id": "PD_500" }, "defaultCustomDimension3": { "id": "CM_500" }, "defaultCustomDimension4": { "id": "ABC1" }, "defaultCustomDimension5": { "id": "ABC_03" }, "restrictionCustomDimension1": { "restriction": "RESTRICTED" }, "restrictionCustomDimension2": { "restriction": "RESTRICTED" }, "restrictionCustomDimension3": { "restriction": "NONE" }, "restrictionCustomDimension4": { "restriction": "NONE" }, "restrictionCustomDimension5": { "restriction": "NONE" } } - |
| Example of response | { "id": "TESTENT", "validity": null, "sorting": "Asc", "documentationLink": "www.documentation.com", "additionalInfo": { "businessName": "Business name", "administrativeHQLocation": "Administrative HQ Location", "administrativeHQ": "Legal administrative HQ", "legalHQLocation": "Legal HQ Location", "legalHQ": null, "mainOffice": "main office", "manager": "manager", "email": "entity@email.com", "phone": "+393332215478", "icMatchingManagers": "ic matching managers" }, "customAttributes": { "Country": "Italy", "Entering Group": null, "Leaving Group": null, "SP Result DEV-82317": null }, "currency": { "id": "EUR", "description": "Euro" }, "defaultCustomDimension1": { "id": "CC_500", "dimensionName": "Cost Centers", "description": "Generic Cost Center" }, "defaultCustomDimension2": { "id": "PD_500", "dimensionName": "Products", "description": "Generic Product" }, "defaultCustomDimension3": { "id": "CM_500", "dimensionName": "Customers en", "description": "Generic Customer" }, "defaultCustomDimension4": { "id": "ABC1", "dimensionName": "Employees", "description": "Generic Employee" }, "defaultCustomDimension5": { "id": "ABC_03", "dimensionName": "Miscellaneous", "description": "Product Packaging" }, "restrictionCustomDimension1": { "dimensionName": "Cost Centers", "restriction": "RESTRICTED" }, "restrictionCustomDimension2": { "dimensionName": "Products", "restriction": "RESTRICTED" }, "restrictionCustomDimension3": { "dimensionName": "Customers en", "restriction": "NONE" }, "restrictionCustomDimension4": { "dimensionName": "Employees", "restriction": "NONE" }, "restrictionCustomDimension5": { "dimensionName": "Miscellaneous", "restriction": "NONE" }, "rules": { "fiscalPolicy": { "id": null, "description": null }, "consolidation": { "consolidationMethod": "COST", "deconsolidationMethod": "NOTTODECONSOLIDATE", "percConsolidation": null, "generateCtpElimination": "ALLELIMINATIONLOGICS", "onlyCtp": false, "onlyConsolidatorData": false, "icMatching": "MANDATORY", "excludeAndUseReferenceEntity": false, "referenceEntity": null }, "taxAndCashManagement": { "runAsEntity": true, "runAsSubentity": false } }, "bankingData": { "constitutionDate": null, "abiCode": null, "bankGroupRegistrationDate": null, "bankitReportingCode": null, "assignmentDate": null, "centralCreditRiskCode": null, "iso": null, "individualDataSignaling": false, "intragroupSignaling": false, "excludeFinInvAutomaticInput": false }, "updateInfo": { "user": "USER", "date": "2026-02-27T16:05:01.512+0000", "origin": "INPUT_WEB" }, "descriptions": { "en": "Edited", "it": null, "ja": null, "aa": null } } |
Create an element, insert another element, edit another element
| Method | POST |
| Endpoint | /api/aih/dimensions/v1/{dbID}/entity/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 Entity elements
| Method | POST |
| Endpoint | /api/aih/dimensions/v1/{dbID}/entity/elements-bulk-delete-async |
| Body | [ { "id": "012" }, { "id": "013" } ] |
| Example of response | { "dataProcessingId": "2C98F135918DD37A1D4D1F84BF1B3CF8" } |
Check the status of a deletion data processing
| Method | GET |
| Endpoint | /api/aih/dimensions/v1/{dbID}/entity/elements-bulk-delete-async/2C98F135918DD37A1D4D1F84BF1B3CF8 |
| 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}/entity/elements-bulk-delete-async/2C98F135918DD37A1D4D1F84BF1B3CF8 |
| Body | - |
| Example of response | { "message": "Stop on dataprocessingOid 2C98ACE49D28242F019D29C846712CA9" } |