API 实体维度
此 API 支持提取、创建、修改和删除 Tagetik 应用程序的实体(Entity)维度元素的信息。
| API 标题: | AIH Entity openapi 3.0.3 | |
| 描述: | 用于实体维度元素的 API | |
| 版本: | 1.000 | |
| 身份验证: | OAuth2、API Key、JWT、Basic Auth |
前提条件¶
要使用这些 API,用户必须通过为 [CCH Tagetik] 选择的身验证模式进行身份验证。
此外,还必须在 Repository 中启用 API。对于反向代理,还需要进行其他设置。它们可同时用于 http 和 https 协议。
有关身份验证和启用的更多详细信息,请参阅启用 REST API。
请求格式:JSON
响应格式:JSON
| Http 方法 | 端点 | 请求体 | 查询字符串参数 | 应答体 | HTTP 响应体 | 响应状态(异常) |
|---|---|---|---|---|---|---|
| POST | 实体元素 | 实体元素 | 201(已创建) | 405(方法不允许) 404(未找到) 403(访问未授权资源) 401(未授权) 400(无效请求) | ||
| GET | 实体元素 | 200(OK) | 405(方法不允许) 404(未找到) 403(访问未授权资源) 401(未授权) | |||
| PUT | 实体元素 | 实体元素 | 200(OK) 201(已创建) | 405(方法不允许) 404(未找到) 403(访问未授权资源) 401(未授权) 400(无效请求) | ||
| GET | filter sort skip take (可选参数) | 实体元素列表 | 200(OK) | 405(方法不允许) 404(未找到) 403(访问未授权资源) 401(未授权) 400(无效请求) | ||
| GET | filter sort skip take (可选参数) | 实体元素数量 | 200(OK) | 405(方法不允许) 404(未找到) 403(访问未授权资源) 401(未授权) 400(无效请求) | ||
| GET | properties filter sort skip take (properties 为必填,其他参数可选) | 实体元素列表 | 200(OK) | 405(方法不允许) 404(未找到) 403(访问未授权资源) 401(未授权) 400(无效请求) | ||
| PATCH | 实体元素 | 实体元素 | 200(OK) | 405(方法不允许) 404(未找到) 403(访问未授权资源) 401(未授权) 400(无效请求) | ||
| POST | 实体元素 | 成功 | 200(OK) | 405(方法不允许) 404(未找到) 403(访问未授权资源) 401(未授权) 400(无效请求) | ||
| POST | 实体元素的 ID 列表 | 数据处理 ID | 202(已接受) | 405(方法不允许) 404(未找到) 403(访问未授权资源) 401(未授权) 400(无效请求) | ||
| GET | 请求的日期和时间、数据处理状态、参数 | 200(OK) | 405(方法不允许) 404(未找到) 403(访问未授权资源) 401(未授权) 400(无效请求) | |||
| DELETE | 数据处理 ID | 202(已接受) | 405(方法不允许) 404(未找到) 403(访问未授权资源) 401(未授权) 400(无效请求) |
"filter" 接受除 "oid" 之外的所有字段
"properties" 接受所有响应字段,外加显示数据库默认语言描述的 "description" 字段。(必填)
post-bulk 调用接受 post、patch 和 put 操作。
请求中支持的字段(请求体中可能出现的字段)¶
| 实体字段 | 支持的基数 | 支持的值 |
|---|---|---|
| id | - | 字符串(必填) |
| oid | - | 字符串 |
| descriptions.[lingua] | - | 字符串(必填一个) |
| validity.startDate | - | 日期 |
| validity.endDate | - | 日期 |
| sorting | - | 字符串 |
| documentation | - | 字符串 |
| additionalInfo.businessName | - | EDITABLE、EDITABLE_ONLY_ON_NEW_ROWS、READ_ONLY |
| additionalInfo.legalHQLocation | - | ATTRIBUTE、CONDITION、LEVEL、FILTER |
| additionalInfo.legalHQ | - | 字符串 |
| additionalInfo.administrativeHQLocation | - | 字符串 |
| additionalInfo.administrativeHQ | - | 字符串 |
| additionalInfo.mainOffice | - | 字符串 |
| additionalInfo.manager | 字符串 | |
| additionalInfo.icMatchingManagers | - | 字符串 |
| additionalInfo.email | - | CODE、DESCRIPTION、CODE_AND_DESCRIPTIO |
| additionalInfo.phone | - | 字符串 |
| customAttributes.[attributeDescription] | - | 字符串 |
| currency.id | - | 字符串(币种 ID) |
| defaultCustomDimension1.id | - | 字符串(自定义维度元素 ID) |
| defaultCustomDimension2.id | - | 字符串(自定义维度元素 ID) |
| defaultCustomDimension3.id | - | 字符串(自定义维度元素 ID) |
| defaultCustomDimension4.id | - | 字符串(自定义维度元素 ID) |
| defaultCustomDimension5.id | - | 字符串(自定义维度元素 ID) |
| restrictionCustomDimension1.restriction | - | RESTRICTED、NONE |
| restrictionCustomDimension2.restriction | - | RESTRICTED、NONE |
| restrictionCustomDimension3.restriction | - | RESTRICTED、NONE |
| restrictionCustomDimension4.restriction | - | RESTRICTED、NONE |
| restrictionCustomDimension5.restriction | - | RESTRICTED、NONE |
| rules.fiscalPolicy.id | - | 字符串 |
| rules.consolidation.consolidationMethod | - | COST、EQUITY、LINEBYLINE、PROPORTIONAL |
| rules.consolidation.deconsolidationMethod | - | NOTTODECONSOLIDATE、ONLYINITIALBALANCE、FROMPREVIOUSPERIOD、FROMCURRENTPERIOD |
| rules.consolidation.percConsolidation | - | 数字 |
| 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 | - | 字符串(实体 ID) |
| rules.taxAndCashManagement.runAsEntity | - | true/false |
| rules.taxAndCashManagement.runAsSubentity | - | true/false |
¶
'descriptions' 字段由键值数组组成,其中键是语言的缩写形式,值是字符串
响应中的附加字段(响应体中可能出现的字段)¶
| 实体字段 | 支持的值 |
|---|---|
| currency.description | 字符串 |
| defaultCustomDimension1.dimensionName | 字符串 |
| defaultCustomDimension1.description | 字符串 |
| defaultCustomDimension2.dimensionName | 字符串 |
| defaultCustomDimension2.description | 字符串 |
| defaultCustomDimension3.dimensionName | 字符串 |
| defaultCustomDimension3.description | 字符串 |
| defaultCustomDimension4.dimensionName | 字符串 |
| defaultCustomDimension4.description | 字符串 |
| defaultCustomDimension5.dimensionName | 字符串 |
| defaultCustomDimension5.description | 字符串 |
| restrictionCustomDimension1.dimensionName | 字符串 |
| restrictionCustomDimension2.dimensionName | 字符串 |
| restrictionCustomDimension3.dimensionName | 字符串 |
| restrictionCustomDimension4.dimensionName | 字符串 |
| restrictionCustomDimension5.dimensionName | 字符串 |
| bankingData.constitutionDate | 日期 |
| bankingData.abiCode | 数字 |
| bankingData.bankGroupRegistrationDate | 日期 |
| bankingData.bankitReportingCode | 字符串 |
| bankingData.assignmentDate | 日期 |
| bankingData.centralCreditRiskCode | 字符串 |
| bankingData.iso | 字符串 |
| bankingData.individualDataSignaling | true/false |
| bankingData.intragroupSignaling | true/false |
| bankingData.excludeFinInvAutomaticInput | true/false |
| updateInfo.user | 字符串 |
| updateInfo.date | 日期 |
| updateInfo.origin | INPUT_WEB、 |
请求示例¶
创建实体元素
| 方法 | POST |
| 端点 | /api/aih/dimensions/v1/{dbID}/entities/elements |
| 请求体 | { "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" } } |
| 响应示例 | { "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 } } |
实体的特定元素
| 方法 | GET |
| 端点 | /api/aih/dimensions/v1/{dbID}/entities/elements/TESTENT |
| 请求体 | - |
| 响应示例 | { "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 } } |
录入实体元素
| 方法 | PUT |
| 端点 | /api/aih/dimensions/v1/{dbID}/entities/elements/TESTENT |
| 请求体 | { "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" } } - |
| 响应示例 | { "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 } } |
实体的所有元素列表
| 方法 | GET |
| 端点 | /api/aih/dimensions/v1/{dbID}/entities/elements |
| 请求体 | - |
| 响应示例 | [ { "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" } ] |
实体元素数量
| 方法 | GET |
| 端点 | /api/aih/dimensions/v1/{dbID}/category/elements-count |
| 请求体 | - |
| 响应示例 | 12 |
显示仅包含 ID 和 description 字段的实体元素列表
| 方法 | GET |
| 端点 | /api/aih/dimensions/v1/{dbID}/entity/elements-fetch?properties=id,description |
| 请求体 | - |
| 响应示例 | [ { "id": "010", "descriptions": "category" }, { "id": "011", "descriptions": "category2" } ] |
编辑实体元素
| 方法 | PATCH |
| 端点 | /api/aih/dimensions/v1/{dbID}/entities/elements/TESTENT |
| 请求体 | { "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" } } - |
| 响应示例 | { "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 } } |
创建一个元素,插入另一个元素,编辑另一个元素
| 方法 | POST |
| 端点 | /api/aih/dimensions/v1/{dbID}/entity/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}/entity/elements-bulk-delete-async |
| 请求体 | [ { "id": "012" }, { "id": "013" } ] |
| 响应示例 | { "dataProcessingId": "2C98F135918DD37A1D4D1F84BF1B3CF8" } |
检查删除数据处理的状态
| 方法 | GET |
| 端点 | /api/aih/dimensions/v1/{dbID}/entity/elements-bulk-delete-async/2C98F135918DD37A1D4D1F84BF1B3CF8 |
| 请求体 | - |
| 响应示例 | { "requestDateTime": "2026-03-23T11:04:46.772+0000", "status": "COMPLETED", "parameters": {} } |
中止删除数据处理
| 方法 | DELETE |
| 端点 | /api/aih/dimensions/v1/{dbID}/entity/elements-bulk-delete-async/2C98F135918DD37A1D4D1F84BF1B3CF8 |
| 请求体 | - |
| 响应示例 | { "message": "Stop on dataprocessingOid 2C98ACE49D28242F019D29C846712CA9" } |