Virtual Dataset Field Management API
This API enables the extraction of information, creation, modification and deletion of fields in the Virtual Datasets of the Tagetik application.
| API title: | AIH Virtual Dataset Fields swagger openapi 3.0.3 |
| Description: | API for managing Virtual Dataset fields 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 | Virtual Dataset field | Virtual Dataset field | 201 (Created) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| Read | GET | Virtual Dataset Field ID | Virtual Dataset field | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) | ||
| Delete | DELETE | Virtual Dataset Field ID | Virtual Dataset field | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) | ||
| Replace | PUT | Virtual Dataset field | Virtual Dataset Field ID | Virtual 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 Virtual 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 Virtual Dataset Fields | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| Update | PATCH | Virtual Dataset field | Virtual Dataset Field ID | Virtual Dataset field | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | |
| Bulk | POST | Virtual Dataset 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], updateInfo.user, updateInfo.date and updateInfo.origin"
Supported Fields in Request¶
| Virtual Dataset field | Supported cardinality | Supported Values |
|---|---|---|
| id | - | string (mandatory) |
| oid | - | string |
| descriptions.[lingua] | - | string (one mandatory) |
| fieldType | - | FORMULA, DATASET_FIELD (mandatory) |
| formula | - | string (mandatory for fieldType=formula) |
| sortType | - | ASC, DESC |
| sortPosition | - | integer |
| sourceField.id | - | string |
| sourceField.sourceDataset.id | - | 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¶
| Virtual Dataset field | Supported Values |
| values.dictionary.id | string |
| values.dictionary.queryCodeField | string |
| values.dictionary.queryDescriptionField | string |
| values.dictionary.outOfDictionaryAllowed | true/false |
| values.dictionary.displayMode | CODE, DESCRIPTION, CODE_AND_DESCRIPTION |
| updateInfo.user | string |
| updateInfo.date | date |
| updateInfo.origin | INPUT_WEB |
Examples of requests¶
Show list of all Virtual Datasets
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/virtualdatasets/{virtualdatasetID}/fields |
| Body | - |
| Example of response | [ { "sortType": null, "sortPosition": null, "id": "ANDIM", "oid": "CGFJAHKFSYFTGLI", "descriptions": { "it": "Andim", "en": "Andim", "ja": null, "aa": null }, "fieldType": "DATASET_FIELD", "updateInfo": { "user": "USERT", "date": "2024-12-18T16:45:28.900+0000", "origin": "INPUT_WEB" }, "sourceField": { "id": "ANDIM", "sourceDataset": { "id": "345678" } }, "values": { "dictionary": { "id": null, "queryCodeField": null, "queryDescriptionField": null, "outOfDictionaryAllowed": false }, "displayMode": "CODE" } }, { "sortType": null, "sortPosition": null, "id": "DAT", "oid": "KFJBQSDVUYKEFKO", "descriptions": { "it": "FORMULA", "en": "FORMULA", "ja": null, "aa": null }, "fieldType": "FORMULA", "updateInfo": { "user": "USERT", "date": "2024-12-18T16:51:26.407+0000", "origin": "INPUT_WEB" }, "formula": ".", "timeDimensionRollup": "LAST", "conversionType": "PERIOD_AVERAGE" } ] |
Shows a specific Virtual Dataset
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/virtualdatasets/{virtualdatasetID}/fields/FIELD |
| Body | - |
| Example of response | { "sortType": "ASC", "sortPosition": "20", "id": "FIELD", "oid": "NLOLREXNRMACLOK", "descriptions": { "it": "Internal Field", "en": "Campo Interno", "ja": "Campo Interno", "aa": "Campo Interno" }, "fieldType": "FORMULA", "updateInfo": { "user": "USERT", "date": "2025-10-28T16:11:32.762+0000", "origin": "INPUT_WEB" }, "formula": ".", "timeDimensionRollup": "LAST", "conversionType": "FINAL" } |
Show the number of Virtual Datasets
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/virtualdatasets/{virtualdatasetID}/fields-count |
| Body | - |
| Example of response | 12 |
Create a new Virtual Dataset
| Method | POST |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/virtualdatasets/{virtualdatasetID}/fields |
| Body | { "id": "FIEL", "oid": "DXKZFNPRJJABH01", "descriptions": { "it": "Campo", "en": "Field" }, "fieldType": "DATASET_FIELD", "sourceField": { "id": "FIEL", "sourceDataset": { "id": "345608" } } } |
| Example of response | { "sortType": null, "sortPosition": null, "id": "FIEL", "oid": "DXKZFNPRJJABH01", "descriptions": { "it": "Campo", "en": "Field", "ja": null, "aa": null }, "fieldType": "DATASET_FIELD", "updateInfo": { "user": "USERT", "date": "2026-01-19T14:58:21.539+0000", "origin": "INPUT_WEB" }, "sourceField": { "id": "FIEL", "sourceDataset": { "id": "345608" } }, "values": { "dictionary": { "id": null, "queryCodeField": null, "queryDescriptionField": null, "outOfDictionaryAllowed": false }, "displayMode": "CODE" } } |
Edit a Virtual Dataset
| Method | PATCH |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/virtualdatasets/{virtualdatasetID}/fields/FIEL |
| Body | { "id": "FIEL", "descriptions": { "it": "Campo Modificato", "en": "Edited Field" }, "fieldType": "DATASET_FIELD", "sourceField": { "id": "FIEL", "sourceDataset": { "id": "345608" } } } |
| Example of response | { "sortType": null, "sortPosition": null, "id": "FIEL", "oid": "DXKZFNPRJJABH01", "descriptions": { "it": "Campo", "en": "Field", "ja": null, "aa": null }, "fieldType": "DATASET_FIELD", "updateInfo": { "user": "USERT", "date": "2026-01-19T14:58:21.539+0000", "origin": "INPUT_WEB" }, "sourceField": { "id": "FIEL", "sourceDataset": { "id": "345608" } }, "values": { "dictionary": { "id": null, "queryCodeField": null, "queryDescriptionField": null, "outOfDictionaryAllowed": false }, "displayMode": "CODE" } } |
Create a Virtual Dataset, edit another Virtual Dataset and delete another Virtual Dataset
| Method | POST |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/virtualdatasets/{virtualdatasetID}/fields-bulk |
| Body | { "saveMode": "LOOSE", "post": [ { "id": "POSTBU", "descriptions": { "en": "Post Bulk", "it": "Bulk Post" }, "fieldType": "DATASET_FIELD", "sourceField": { "id": "ENT", "sourceDataset": { "id": "345678" } } } ], "patch": [ { "key": { "id": "PATCHB" }, "data": { "descriptions": { "en": "Patch Bulk", "it": "Bulk Patch" }, "fieldType": "DATASET_FIELD", "sourceField": { "id": "READONLY", "sourceDataset": { "id": "345678" } } } } ], "delete": [ { "id": "DELETB" } ] } |
| Example of response | { "code": "SUCCESS" } |