Dataset Fields Management API
This API enables the extraction of information, creation, modification and deletion of fields in a Tagetik application Dataset.
| API title: | AIH Dataset swagger openapi 3.0.3 |
| Description: | API for Dataset 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 | Dataset Field | Dataset Field | 201 (Created) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| Read | GET | Dataset Field ID | Dataset Field | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) | ||
| Delete | DELETE | Dataset Field ID | Dataset Field | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) | ||
| Replace | PUT | Dataset Field | Dataset Field ID | Dataset 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 Dataset 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 Dataset Fields | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| Update | PATCH | Dataset Field | Dataset Field ID | Dataset Field | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | |
| Bulk | POST | Dataset Field(s) | Success | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) |
"filter" accetta i campi "id, descriptions.[language], fieldType, formatType, personalDataProtection, encoded, timeDimensionRollup, conversionType, dimensionType, hierarchyId, values.dictionary.id, mandatory, key, editability, referenceType, updateInfo.user, updateInfo.date and updateInfo.origin
Supported Fields in Request¶
| Dataset Field | Supported cardinality | Supported Values |
|---|---|---|
| id | - | string (mandatory) |
| oid | - | string |
| descriptions.[lingua] | - | string (one mandatory) |
| fieldType | - | TEXT_MEASURE, NUMBER_MEASURE, DATE_MEASURE, COMMENTS_AND_ATTACHMENTS_MEASURE, LEAF_DIMENSION, HIERARCHY_NODE_DIMENSION, HIERARCHY_LEVEL_DIMENSION (mandatory) |
| position | - | integer |
| mandatory | - | true/false |
| key | - | true/false |
| editable | - | EDITABLE, EDITABLE_ONLY_ON_NEW_ROWS, READ_ONLY |
| referenceType | - | ATTRIBUTE, CONDITION, LEVEL, FILTER |
| 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_DESCRIPTIO |
| dimensionType | - | string |
| hierarchyId | - | 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
The 'index' and 'sort' fields only accept values corresponding to fields in the dataset itself
The 'values.dictionary.id' field only accepts values that correspond to Dictionaries existing in the AW
Additional Fields in Response¶
| Dataset Field | Supported Values |
| status | IDLE, IN_USE, OFFLINE, OFFLINE_IN_PROGRESS, UPDATING, VERSION_UPGRADING, INCONSISTENT |
| updateInfo.user | string |
| updateInfo.date | date |
| updateInfo.origin | INPUT_WEB |
Examples of requests¶
Show list of all Fields in a Dataset
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasets/123459/fields |
| Body | - |
| Example of response | [ { "id": "AAAAA", "oid": "IVQFZGZDRRVVVIK", "fieldType": "TEXT_MEASURE", "values": { "dictionary": { "id": null, "queryCodeField": null, "queryDescriptionField": null, "outOfDictionaryAllowed": false }, "displayMode": "CODE" }, "mandatory": false, "key": false, "position": 36, "editability": "EDITABLE", "referenceType": null, "sortType": "ASC", "sortPosition": null, "updateInfo": { "user": "USER1", "date": "2025-10-28T15:52:14.563+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "AAAA", "en": null, "ja": null, "aa": null }, "formatType": "PLAIN", "personalDataProtection": false, "encoded": false, "length": 255, "defaultValue": null, "maxDictMultiselectable": null }, { "id": "DIMENSION", "oid": "SLJMNDXDZJFBFSQ", "fieldType": "LEAF_DIMENSION", "values": { "dictionary": { "id": null, "queryCodeField": null, "queryDescriptionField": null, "outOfDictionaryAllowed": false }, "displayMode": "CODE" }, "mandatory": false, "key": false, "position": 31, "editability": "EDITABLE", "referenceType": null, "sortType": "DESC", "sortPosition": "10", "updateInfo": { "user": "USER1", "date": "2025-08-28T13:18:21.761+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "ADDEL", "en": "ADDEL", "ja": null, "aa": null }, "dimensionType": "ADDEL" } ] |
Show a specific Field in a Dataset
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasets/123459/fields/AAAAA |
| Body | - |
| Example of response | { "id": "AAAAA", "oid": "IVQFZGZDRRVVVIK", "fieldType": "TEXT_MEASURE", "values": { "dictionary": { "id": null, "queryCodeField": null, "queryDescriptionField": null, "outOfDictionaryAllowed": false }, "displayMode": "CODE" }, "mandatory": false, "key": false, "position": 36, "editability": "EDITABLE", "referenceType": null, "sortType": "ASC", "sortPosition": null, "updateInfo": { "user": "USER1", "date": "2025-10-28T15:52:14.563+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "AAAA", "en": null, "ja": null, "aa": null }, "formatType": "PLAIN", "personalDataProtection": false, "encoded": false, "length": 255, "defaultValue": null, "maxDictMultiselectable": null } |
Show the number of fields
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasets/123459/fields-count |
| Body | - |
| Example of response | 12 |
Create a new Field
| Method | POST |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasets/123459/fields |
| Body | { "id": "TESTF", "descriptions": { "it": "RFTEST-it", "en": "RFTEST-en" }, "fieldType": "TEXT_MEASURE", "position": 0, "sortType": "ASC", "sortPosition": "1" } |
| Example of response | { "id": "TESTF", "oid": "MDQXDUARCMZIYBX", "fieldType": "TEXT_MEASURE", "values": { "dictionary": { "id": null, "queryCodeField": null, "queryDescriptionField": null, "outOfDictionaryAllowed": false }, "displayMode": null }, "mandatory": false, "key": false, "position": 0, "editability": "EDITABLE", "referenceType": null, "sortType": "ASC", "sortPosition": "1", "updateInfo": { "user": "USERT", "date": "2026-01-16T16:22:30.339+0000", "origin": "INPUT_WEB" }, "descriptions": { "en": "CREATED", "it": "CREATO", "ja": null, "aa": null }, "formatType": "PLAIN", "personalDataProtection": false, "encoded": false, "length": 255, "defaultValue": null, "maxDictMultiselectable": null } |
Edit a Field
| Method | PATCH |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasets/123459/fields/TESTF |
| Body | { "id": "TESTF", "descriptions": { "it": "MODIFIED", "en": "MODIFICATO" }, "position": 0, "sortType": "ASC", "sortPosition": "1" } |
| Example of response | { "id": "TESTF", "oid": "MDQXDUARCMZIYBX", "fieldType": "TEXT_MEASURE", "values": { "dictionary": { "id": null, "queryCodeField": null, "queryDescriptionField": null, "outOfDictionaryAllowed": false }, "displayMode": null }, "mandatory": false, "key": false, "position": 0, "editability": "EDITABLE", "referenceType": null, "sortType": "ASC", "sortPosition": "1", "updateInfo": { "user": "USERT", "date": "2026-01-16T16:22:30.339+0000", "origin": "INPUT_WEB" }, "descriptions": { "en": "MODIFIED", "it": "MODIFICATO", "ja": null, "aa": null }, "formatType": "PLAIN", "personalDataProtection": false, "encoded": false, "length": 255, "defaultValue": null, "maxDictMultiselectable": null } |
Create a Field, edit another Field and delete another Field
| Method | POST |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasets/123459/fields-bulk |
| Body | { "saveMode": "LOOSE", "post": [ { "id": "DFIELD4", "descriptions": { "it": "Dataset Field post created", "en": "Field Dataset post created" }, "fieldType": "TEXT_MEASURE" }, { "id": "DFIELD5", "descriptions": { "it": "Dataset Field post created", "en": "Field Dataset post created" }, "fieldType": "TEXT_MEASURE" } ], "patch": [ { "key": { "id": "DFIELD1" }, "data": { "descriptions": { "it": "UpdatePatchBulk", "en": "PatchUpdateBulk" }, "fieldType": "TEXT_MEASURE" } } ], "delete": [ { "id": "DFIELD6" } ] } |
| Example of response | { "code": "SUCCESS" } |