跳转至

API 货币维度

此 API 支持提取信息，以及创建、修改和删除 Tagetik 应用程序的币种（Currency）维度元素。
API 标题： AIH Currency openapi 3.0.3
描述： 币种维度元素的
版本： 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}/currency/elements Currency Element Currency 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}/currency/elements/{id} Currency Element 200 (OK) 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised)
PUT /api/aih/dimensions/v1/{dbID}/currency/elements/{id} Currency Element Currency 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}/currency/elements filter sort skip take （可选参数） List of Currency 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}/currency/elements-count filter sort skip take （可选参数） Amount of Currency 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}/currency/elements-fetch properties filter sort skip take （properties 为必填，其他参数可选） List of Currency Elements with selected properties only 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}/currency/elements/{id} Currency Element Currency 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}/currency/elements-bulk Currency 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}/currency/elements-bulk-delete-async List of Currency 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}/currency/elements-bulk-delete-async 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}/currency/elements-bulk-delete-async 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（一个必填）
preferred - true/false
decimalNumbers - integer（必填）
referenceCurrency.id - string
referenceCurrency.coefficient - true/false
percentageDifference - string（必填）
xbrlContent - string

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

响应中的附加字段

币种字段 支持的值
updateInfo.user string
updateInfo.date date
updateInfo.origin INPUT_WEB,

请求示例

创建币种元素
方法 POST
端点 /api/aih/dimensions/v1/{dbID}/currency/elements
正文 { "id": "TEST", "description": "TEST", "preferred": false, "xbrlContent": "content", "decimalNumbers": 0, "referenceCurrency": { "id": "EUR", "coefficient": "1" }, "percentageDifference": "0.5000" }
响应示例 { "id": "TEST", "description": "TEST", "preferred": false, "xbrlContent": "content", "updateInfo": { "user": "USER", "date": "2026-03-20T15:04:44.022+0000", "origin": "INPUT_WEB" }, "decimalNumbers": 0, "referenceCurrency": { "id": "EUR", "coefficient": "1" }, "percentageDifference": "0.5000" }

创建特定币种元素
方法 GET
端点 /api/aih/dimensions/v1/{dbID}/currency/elements/TEST
正文 -
响应示例 { "id": "TEST", "description": "TEST", "preferred": false, "xbrlContent": "content", "updateInfo": { "user": "USER", "date": "2026-03-20T15:04:44.022+0000", "origin": "INPUT_WEB" }, "decimalNumbers": 0, "referenceCurrency": { "id": "EUR", "coefficient": "1" }, "percentageDifference": "0.5000" }

录入币种元素
方法 PUT
端点 /api/aih/dimensions/v1/{dbID}/currency/elements/TEST
正文 { "id": "TEST", "description": "Inserted", "preferred": false, "xbrlContent": "content", "decimalNumbers": 0, "referenceCurrency": { "id": "EUR", "coefficient": "1" }, "percentageDifference": "0.5000" }
响应示例 { "id": "TEST", "description": "Inserted", "preferred": false, "xbrlContent": "content", "updateInfo": { "user": "USER", "date": "2026-03-20T15:04:44.022+0000", "origin": "INPUT_WEB" }, "decimalNumbers": 0, "referenceCurrency": { "id": "EUR", "coefficient": "1" }, "percentageDifference": "0.5000" }

所有币种元素的列表
方法 GET
端点 /api/aih/dimensions/v1/{dbID}/currency/elements
正文 -
响应示例 [ { "id": "TEST", "description": "Default currency", "preferred": false, "xbrlContent": null, "updateInfo": { "user": "USER", "date": "2024-08-12T07:31:17.686+0000", "origin": "INPUT_WEB" }, "decimalNumbers": 2, "referenceCurrency": { "id": null, "coefficient": "1" }, "percentageDifference": "0.0000" }, { "id": "AUD", "description": "Australian Dollar", "preferred": false, "xbrlContent": null, "updateInfo": { "user": "USER", "date": "2023-09-19T14:30:53.038+0000", "origin": "INPUT_WEB" }, "decimalNumbers": 0, "referenceCurrency": { "id": null, "coefficient": "1" }, "percentageDifference": "0.0000" } ]

币种元素数量
方法 GET
端点 /api/aih/dimensions/v1/{dbID}/currency/elements-count
请求体 -
响应示例 12

显示仅包含 ID 和 description 字段的币种元素列表
方法 GET
端点 /api/aih/dimensions/v1/{dbID}/currency/elements-fetch?properties=id,description
请求体 -
响应示例 [ { "id": "010", "descriptions": "currency" }, { "id": "011", "descriptions": "currencyy2" } ]

编辑币种元素
方法 PATCH
端点 /api/aih/dimensions/v1/{dbID}/currency/elements/TEST
请求体 { "id": "TEST", "description": "Edited", "preferred": false, "xbrlContent": "content", "decimalNumbers": 0, "referenceCurrency": { "id": "EUR", "coefficient": "1" }, "percentageDifference": "0.5000" }
响应示例 { "id": "TEST", "description": "Edited", "preferred": false, "xbrlContent": "content", "updateInfo": { "user": "USER", "date": "2026-03-20T15:04:44.022+0000", "origin": "INPUT_WEB" }, "decimalNumbers": 0, "referenceCurrency": { "id": "EUR", "coefficient": "1" }, "percentageDifference": "0.5000" }

创建一个元素，插入另一个元素，编辑另一个元素
方法 POST
端点 /api/aih/dimensions/v1/{dbID}/currency/elements-bulk
请求体 { "saveMode": "LOOSE", "post": [ { "id": "BULPO", "description": "BULPO-post", "preferred": false, "decimalNumbers": 2, "percentageDifference": "0.000", "xbrlContent": "string", "referenceCurrency": { "id": "USD", "coefficient": "500" } } ], "put": [ { "id": "BULPU", "description": "BULPU-post", "preferred": false, "decimalNumbers": 2, "percentageDifference": "0.000", "xbrlContent": "string", "referenceCurrency": { "id": "USD", "coefficient": "500" } } ], "patch": [ { "key": { "id": "BULPA" }, "data": { "description": "BULPA-post", "preferred": false, "decimalNumbers": 2, "percentageDifference": "0.000", "xbrlContent": "string", "referenceCurrency": { "id": "USD", "coefficient": "500" } } } ] }
响应示例 { "code": "SUCCESS" }

删除币种元素列表
方法 POST
端点 /api/aih/dimensions/v1/{dbID}/currency/elements-bulk-delete-async
请求体 [ { "id": "012" }, { "id": "013" } ]
响应示例 { "dataProcessingId": "2C98F135918DD37A1D9D1F84BF1B3CF8" }

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

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