Datasource Fields Management API
This API enables the extraction of information, creation, modification and deletion of fields in a Tagetik application's Datasource.
| API title: | AIH Dataset swagger openapi 3.0.3 |
| Description: | API for Datasource Fields Management 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 | Datasource field | Datasource field | 201 (Created) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| Read | GET | Datasource Field ID | Datasource field | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) | ||
| Delete | DELETE | Datasource Field ID | Datasource field | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) | ||
| Replace | PUT | Datasource field | Datasource Field ID | Datasource field | 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 Datasource Fields | 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 Datasource Fields | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| Update | PATCH | Datasource field | Datasource Field ID | Datasource field | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | |
| Bulk | POST | Datasource Field(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], fieldType, updateInfo.user, updateInfo.date and updateInfo.origin"
Supported Fields in Request¶
| Datasource Field | Supported cardinality | Supported Values |
|---|---|---|
| id | - | string (mandatory) |
| oid | - | string |
| descriptions.[lingua] | - | string (one mandatory) |
| fieldType | - | TEXT_MEASURE, NUMBER_MEASURE, DATE_MEASURE, LEAF_DIMENSION (mandatory) |
| encoded | - | true/false |
| sortPosition | - | string |
| sortType | - | string |
| values.dictionary.id | - | string |
| values.dictionary.queryCodeField | - | string |
| values.dictionary.queryDescriptionField | string | |
| values.dictionary.outOfDictionaryAllowed | - | string |
| values.displayMode | - | CODE, DESCRIPTION, CODE_AND_DESCRIPTION |
| timeDimensionRollup | - | SUM, LAST |
| conversionType | - | NONE, AVERAGE, PERIOD_AVERAGE, FINAL |
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
The 'values.dictionary.id' field only accepts values that correspond to Dictionaries existing in the AW
Additional Fields in Response¶
| Datasource Field | Supported Values |
|---|---|
| updateInfo.user | string |
| updateInfo.date | date |
| updateInfo.origin | INPUT_WEB |
Examples of requests¶
Show the list of all fields in a Datasource
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasources/123459/fields |
| Body | - |
| Example of response | [ { "id": "FLAG_ESECUZIONE_DISTRIBUITA", "oid": "ABYXJVVKAJSIXEI", "fieldType": "NUMBER_MEASURE", "values": null, "mandatory": false, "sortType": null, "sortPosition": null, "updateInfo": { "user": "USERT", "date": "2026-01-20T15:34:15.884+0000", "origin": "INPUT_WEB" }, "timeDimensionRollup": "SUM", "conversionType": "NONE", "descriptions": { "it": "FLAG_ESECUZIONE_DISTRIBUITA-it", "en": "FLAG_ESECUZIONE_DISTRIBUITA-en", "ja": null, "aa": null } }, { "id": "GDPR_CHECK_RESULT_DATE", "oid": "IBQKFPGJFESDSNO", "fieldType": "DATE_MEASURE", "values": null, "mandatory": false, "sortType": null, "sortPosition": null, "updateInfo": { "user": "USERT", "date": "2026-01-20T15:34:16.796+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "GDPR_CHECK_RESULT_DATE-it", "en": "GDPR_CHECK_RESULT_DATE-en", "ja": null, "aa": null } } ] |
Display a specific Field in a Datasource
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasources/123459/fields/ID_OWS |
| Body | - |
| Example of response | { "id": "ID_OWS", "oid": "EYAWSUSMMTLMVKB", "fieldType": "TEXT_MEASURE", "values": null, "mandatory": false, "sortType": null, "sortPosition": null, "updateInfo": { "user": "CLAUDIO", "date": "2026-01-20T16:04:49.654+0000", "origin": "INPUT_WEB" }, "encoded": false, "descriptions": { "it": "ID_OWS-it", "en": "ID_OWS-en", "ja": null, "aa": null } } |
Show the number of fields
| Show the number of fields | |
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasources/123459/fields-count |
| Body | - |
| Example of response | 12 |
Create a new Field
| Method | POST |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasources/123459/fields |
| Body | { "id": "ID_OWS", "descriptions": { "it": "ID_OWS-it", "en": "ID_OWS-en" }, "fieldType": "TEXT_MEASURE", "encoded": true, "values": { "dictionary": { "id": "DICT", "queryCodeField": "ID_OWS", "queryDescriptionField": "ID_OWS", "outOfDictionaryAllowed": false }, "displayMode": "CODE" }, "sortType": "ASC", "sortPosition": "1" } |
| Example of response | { "id": "ID_OWS", "oid": "PWUYEVRSTIDYTNU", "fieldType": "TEXT_MEASURE", "values": { "dictionary": { "id": "DICT", "queryCodeField": "ID_OWS", "queryDescriptionField": "ID_OWS", "outOfDictionaryAllowed": false }, "displayMode": "CODE" }, "mandatory": false, "sortType": "ASC", "sortPosition": "1", "updateInfo": { "user": "USERT", "date": "2026-01-20T16:26:07.382+0000", "origin": "INPUT_WEB" }, "encoded": true, "descriptions": { "it": "ID_OWS-it", "en": "ID_OWS-en", "ja": null, "aa": null } } |
Edit a Field
| Method | PATCH |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasources/123459/fields/ID_OWS |
| Body | { "id": "ID_OWS", "descriptions": { "it": "Modifica", "en": "Modified" }, "fieldType": "TEXT_MEASURE", "encoded": true, "values": { "dictionary": { "id": "DICT", "queryCodeField": "ID_OWS", "queryDescriptionField": "ID_OWS", "outOfDictionaryAllowed": false }, "displayMode": "CODE" }, "sortType": "ASC", "sortPosition": "1" } |
| Example of response | { "id": "ID_OWS", "oid": "PWUYEVRSTIDYTNU", "fieldType": "TEXT_MEASURE", "values": { "dictionary": { "id": "DICT", "queryCodeField": "ID_OWS", "queryDescriptionField": "ID_OWS", "outOfDictionaryAllowed": false }, "displayMode": "CODE" }, "mandatory": false, "sortType": "ASC", "sortPosition": "1", "updateInfo": { "user": "USERT", "date": "2026-01-20T16:26:07.382+0000", "origin": "INPUT_WEB" }, "encoded": true, "descriptions": { "it": "Modifica", "en": "Modified", "ja": null, "aa": null } } |
Create a Field, edit another Field and delete another Field
| Method | POST |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasources/123459/fields-bulk |
| Body | { "saveMode": "LOOSE", "post": [ { "id": "ID_OWS", "descriptions": { "it": "ID_OWS-it", "en": "ID_OWS-en" }, "fieldType": "TEXT_MEASURE", "encoded": true, "timeDimensionRollup": "SUM", "conversionType": "AVERAGE" } ], "delete": [ { "id": "GDPR_CHECK_RESULT_DATE" } ], "patch": [ { "key": { "id": "DESC_OWS1" }, "data": { "descriptions": { "it": "DESC_OWS0-italiano", "en": "DESC_OWS0-english" }, "fieldType": "TEXT_MEASURE", "encoded": true, "timeDimensionRollup": "SUM", "conversionType": "AVERAGE" } } ] } |
| Example of response | { "code": "SUCCESS" } |