Dictionary Management API
This API enables the extraction of information, creation, modification and deletion of Tagetik application's Dictionaries.
| API title: | AIH Dictionaries swagger openapi 3.0.3 |
| Description: | API for managing Dictionaries in the AIH database application |
| Version: | 1.000 |
| Authentication: | OAuth2, API Key, JWT, Basic Auth |
| Base URL: | https://tenantxyz.api.saastagetik.com/basic https://tenantxyz.api.saastagetik.com/jwt https://tenantxyz.api.saastagetik.com/apikey https://tenantxyz.api.saastagetik.com/oauth2 |
Prerequisites¶
Request format: JSON
Response format: JSON
Shared headers
- Content-Type: application/json
- Authorisation: Bearer
.
URL¶
| Operation | Http Method | Body of the request | Path variable | Query string parameters | Body of the answer | HTTP response body | Response Status (Exception) |
|---|---|---|---|---|---|---|---|
| Create | POST | Dictionary | Dictionary | 201 (Created) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| Read | GET | Dictionary ID | Dictionary | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) | ||
| Delete | DELETE | Dictionary ID | Dictionary | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) | ||
| Replace | PUT | Dictionary | Dictionary ID | Dictionary | 200 (OK) 201 (Created) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | |
| Search | GET | filter sort skip take (optional parameters) | List of Dictionaries | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| Search Size | GET | filter sort skip take (optional parameters) | Quantity of Dictionaries | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| Update | PATCH | Dictionary | Dictionary ID | Dictionary | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | |
| Bulk | POST | Dictionary(s) | Success | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) |
"filter" accepts the fields "id, descriptions.[language], updateInfo.user, updateInfo.date and updateInfo.origin"
Supported Fields in Request¶
| Dictionary field | Supported cardinality | Supported Values |
|---|---|---|
| id | - | string (mandatory) |
| oid | - | string |
| descriptions.[lingua] | - | string (one mandatory) |
| queryBody.oracle | - | string |
| queryBody.sqlServer | - | string |
| queryBody.hana | - | string |
| queryBody.postgres | - | string |
| queryBody.others | - | string |
| personalDataManagement | unlimited | string |
| connection | - | string |
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¶
| Dictionary field | Supported Values |
|---|---|
| updateInfo.user | string |
| updateInfo.date | date |
| updateInfo.origin | INPUT_WEB |
Examples of requests¶
Show list of all dictionaries
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/dictionaries |
| Body | - |
| Example of response | [ { "id": "DICT", "oid": "MDSFDXVAAETKQNC", "queryBody": { "oracle": null, "sqlServer": null, "hana": null, "postgres": "select * from TABLENAME", "others": null }, "personalDataManagement": [], "connection": "DATABASE_CONNECTION", "updateInfo": { "user": "USERT", "date": "2025-04-03T13:44:42.279+0000", "origin": "MDM" }, "descriptions": { "it": "API_DIC", "en": null, "ja": null, "aa": null } }, { "id": "000012", "oid": "XMIOCXOJUXYCAPQ", "queryBody": { "oracle": null, "sqlServer": null, "hana": null, "postgres": "select COLUMN from TABLENAME", "others": null }, "personalDataManagement": [], "connection": "Current", "updateInfo": { "user": "USERT", "date": "2025-04-03T13:44:38.440+0000", "origin": "MDM" }, "descriptions": { "it": "API_DIC", "en": null, "ja": null, "aa": null } } ] |
Show a specific Dictionary
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/dictionaries/DICT |
| Body | - |
| Example of response | { "id": "DICT", "queryBody": { "oracle": null, "sqlServer": null, "hana": null, "postgres": "select COLUMN from TABLENAME", "others": null }, "personalDataManagement": [], "connection": null, "updateInfo": { "user": "USERT", "date": "2024-09-03T09:52:03.801+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "Dizionario", "en": "Dictionary", "ja": null, "aa": null } } |
Show the number of Dictionaries
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/dictionaries-count |
| Body | - |
| Example of response | 12 |
Create a new Dictionary
| Create a new Dictionary | |
| Method | POST |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/dictionaries |
| Body | { "id": "NEW", "queryBody": { "oracle": null, "sqlServer": "select * from TABLE", "hana": null, "postgres": null, "others": null }, "personalDataManagement": [], "connection": "SQL_DATABASE", "descriptions": { "it": "Sequel", "en": null, "ja": null, "aa": null } } |
| Example of response | { "id": "NEW", "oid": "WCIREDPBEPXVCQD", "queryBody": { "oracle": null, "sqlServer": "select * from TABLE", "hana": null, "postgres": null, "others": null }, "personalDataManagement": [], "connection": "SQL_DATABASE", "updateInfo": { "user": "USERT", "date": "2026-01-19T16:25:28.442+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "Sequel", "en": null, "ja": null, "aa": null } } |
Edit a Dictionary
| Method | PATCH |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/dictionaries/SQL |
| Body | { "id": "SQL", "queryBody": { "oracle": null, "secured-sqlServer": "select ELEM from TABLE", "hana": null, "postgres": null, "others": null }, "personalDataManagement": [], "connection": "SQL_DATABASE", "descriptions": { "it": "Sequel", "en": null, "ja": null, "aa": null } } |
| Example of response | { "id": "SQL", "oid": "JQKNFEQWHBIRVSD", "queryBody": { "oracle": null, "sqlServer": "select ELEM from TABLE", "hana": null, "postgres": null, "others": null }, "personalDataManagement": [], "connection": "SQL_DATABASE", "updateInfo": { "user": "USERT", "date": "2026-01-19T16:27:01.709+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "Sequel", "en": null, "ja": null, "aa": null } } |
Create a Dictionary, edit another Dictionary and delete another Dictionary
| Method | POST |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/dictionaries-bulk |
| Body | { "saveMode": "LOOSE", "post": [ { "id": "POSTBU", "queryBody": { "oracle": null, "sqlServer": null, "hana": null, "postgres": "select * from TABLE2", "others": null }, "personalDataManagement": [], "connection": null, "descriptions": { "it": "Bulk Post", "en": "Post Bulk", "ja": null, "aa": null } } ], "patch": [ { "key": { "id": "PATCHB" }, "data": { "queryBody": { "oracle": null, "sqlServer": null, "hana": null, "postgres": "select * from TABLE", "others": null }, "personalDataManagement": [], "connection": null, "descriptions": { "it": "Bulk Patch Edited", "en": "Edited Patch Bulk", "ja": null, "aa": null } } } ], "delete": [ { "id": "DELETB" } ] } |
| Example of response | { "code": "SUCCESS" } |