Analytical Workspace Management API
This API enables the extraction of information, creation, modification and deletion of the Tagetik application's Analytical Workspaces.
| API Title: | AIH Analytical Workspace swagger openapi 3.0.3 |
| Description: | API for Analytical Workspace 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 | Analytical Workspaces | Analytical Workspaces | 201 (Created) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| Read | GET | Analytical Workspace ID | Analytical Workspaces | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) | ||
| Delete | DELETE | Analytical Workspace ID | Analytical Workspaces | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) | ||
| Replace | PUT | Analytical Workspaces | Analytical Workspace ID | Analytical Workspaces | 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 Analytical Workspaces | 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 Analytical Workspaces | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| Search Properties | GET | properties filter sort skip take (properties mandatory, other parameters optional) | List of Analytical Workspaces with only selected properties | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| Update | PATCH | Analytical Workspaces | Analytical Workspace ID | Analytical Workspaces | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | |
| Bulk | POST | Workspace(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], online, version, updateInfo.user, updateInfo.date and updateInfo.origin"
"properties" accepts all response fields,as well as the "description" field showing the description in the default language of the DB.a (mandatory)
Supported Fields in Request¶
| oid | - | string |
|---|---|---|
| descriptions.[lingua] | - | string (one mandatory) |
| dimensions | unlimited | string |
| online | - | true/false |
| database | - | string |
| distributedExecution | - | true/false |
¶
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 'dimension' field only accepts values that correspond to existing dimensions
The 'database' field only accepts values that correspond to existing databases
Additional Fields in Response¶
| Analytical Workspace field | Supported Values |
|---|---|
| gdpr.checkResult | NOT_CHECKED, NOT_PROTECTED, INCORRECTLY_PROTECTED, ALL_PROTECTED |
| gdpr.checkResultDate | date |
| updateInfo.user | string |
| updateInfo.date | date |
| updateInfo.origin | INPUT_WEB, |
Examples of requests¶
List of all users
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces |
| Body | - |
| Example of response | [ { "id": "BXE", "oid": "ALGKYCEPHPESLCH", "dimensions": [], "online": true, "database": null, "gdpr": { "checkResult": "NOT_CHECKED", "checkResultDate": null }, "distributedExecution": false, "updateInfo": { "user": "UTENTE2", "date": "2025-11-28T16:37:49.269+0000", "origin": "INPUT_WEB" }, "descriptions": { "en": "AW Dataset", "it": null, "ja": null, "aa": null, "zh": null, "sq": null, "hy": null, "be": null, "ar": null, "am": null, "as": null } }, { "id": "061", "oid": "MXYZPIFUFSDHUBU", "dimensions": [], "online": true, "database": null, "gdpr": { "checkResult": "NOT_CHECKED", "checkResultDate": null }, "distributedExecution": false, "updateInfo": { "user": "UTENTEPROVA", "date": "2025-06-19T12:57:17.509+0000", "origin": "INPUT_WEB" }, "descriptions": { "en": "DESC1", "it": "DESC2", "ja": null, "aa": null, "zh": null, "sq": null, "hy": null, "be": null, "ar": null, "am": null, "as": null } }, ] |
Show a specific Analytical Workspace
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/UUU |
| Body | - |
| Example of response | { "id": "UUU", "oid": "SORXILAQRQKRKMQ", "dimensions": [], "online": true, "database": null, "gdpr": { "checkResult": "NOT_CHECKED", "checkResultDate": null }, "distributedExecution": false, "updateInfo": { "user": "USER2", "date": "2026-01-15T15:18:20.792+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "TEST", "en": "TEST", "ja": null, "aa": null, "zh": null } } |
Show the number of Analytical Workspaces
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces-count |
| Body | - |
| Example of response | 12 |
Show ids of all Analytical Workspaces
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces-fetch?properties:id |
| Body | - |
| Example of response | [ { "id": "UUU" }, { "id": "UUV" }, { "id": "UUX" } ] |
Create a new Analytical Workspace
| Method | POST |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces |
| Body | { "id": "UUU", "descriptions": { "it": "TEST2", "en": "TEST2" }, "online": true } |
| Example of response | { "id": "UUU", "oid": "SORXILAQRQKRKMQ", "dimensions": [], "online": true, "database": null, "gdpr": { "checkResult": "NOT_CHECKED", "checkResultDate": null }, "distributedExecution": false, "updateInfo": { "user": "USER2", "date": "2026-01-15T15:18:20.792+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "TEST2", "en": "TEST2", "ja": null, "aa": null, "zh": null } } |
Edit an Analytical Workspace
| Method | PATCH |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/UUU |
| Body | { "id": "UUU", "descriptions": { "it": "TEST", "en": "TESTMODIF" }, "distributedExecution": true } |
| Example of response | { "id": "UUU", "oid": "SORXILAQRQKRKMQ", "dimensions": [], "online": true, "database": null, "gdpr": { "checkResult": "NOT_CHECKED", "checkResultDate": null }, "distributedExecution": true, "updateInfo": { "user": "USER2", "date": "2026-01-15T15:18:20.792+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "TEST", "en": "TESTMODIF", "ja": null, "aa": null, "zh": null } } |
Create an Analytical Workspace, edit another Analytical Workspace and delete another Analytical Workspace
| Method | POST |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces-bulk |
| Body | { "saveMode": "LOOSE", "post": [ { "id": "UUU", "descriptions": { "it": "CREA", "en": "CREATE" }, "online": true } ], "patch": [ { "key": { "id": "UUX" }, "data": { "descriptions": { "it": "MODIFICA", "en": "EDIT" }, "dimensions": [], "online": true, "distributedExecution": false } } ], "delete": [ { "id": "UXV" } ] } |
| Example of response | { "code": "SUCCESS" } |