Datasource Management API
This API enables the extraction of information, creation, modification and deletion of Tagetik application's Datasources.
| API title: | AIH Datasources swagger openapi 3.0.3 |
| Description: | Datasource management API in 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 | Datasource | 201 (Created) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| Read | GET | ID Datasource | Datasource | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) | ||
| Delete | DELETE | ID Datasource | Datasource | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) | ||
| Replace | PUT | Dictionary | ID Datasource | Datasource | 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 Datasources | 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 Datasources | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| Update | PATCH | Datasource | ID Datasource | Datasource | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | |
| Bulk | POST | Datasource(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¶
| Datasource field | Supported cardinality | Supported Values |
|---|---|---|
| id | - | string (mandatory) |
| oid | - | string |
| descriptions.[lingua] | - | string (one mandatory) |
| customQuery.oracle | - | string |
| customQuery.sqlServer | - | string |
| customQuery.hana | - | string |
| customQuery.postgres | - | string |
| customQuery.others | - | string |
| sort | unlimited | string tuples |
| sort.field | - | string |
| sort.sortPosition | - | integer |
| sort.sortIndex | - | ASC, DESC |
| 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¶
| Datasource field | Supported Values |
|---|---|
| updateInfo.user | string |
| updateInfo.date | date |
| updateInfo.origin | INPUT_WEB |
Examples of requests¶
Shows the list of all Datasources
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasources |
| Body | - |
| Example of response | [ { "id": "133123", "oid": "OFWBDBIRCSYXLVC", "sort": [], "customQuery": { "sqlServer": null, "hana": null, "postgres": "select id_ows from ows", "others": null, "oracle": null }, "connection": "Current", "updateInfo": { "user": "USERT", "date": "2026-01-20T15:01:54.875+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "123123-it", "en": "123123-en", "ja": null, "aa": null, "zh": null } }, { "id": "133125", "oid": "YHIZSQGRMUZTHSH", "sort": [], "customQuery": { "sqlServer": null, "hana": null, "postgres": "select id_ows from ows", "others": null, "oracle": null }, "connection": "Current", "updateInfo": { "user": "USERT", "date": "2026-01-20T15:01:56.608+0000", "origin": "INPUT_WEB" }, "descriptions": { "it": "123125-it", "en": "123125-en", "ja": null, "aa": null, "zh": null } } ] |
Shows a specific Datasource
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasources/123123 |
| Body | - |
| Example of response | { "id": "123123", "oid": "OWHYWGRCDKWSAUY", "sort": [], "customQuery": { "sqlServer": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "hana": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "postgres": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "others": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "oracle": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA" }, "connection": "Current", "updateInfo": { "user": "USERT", "date": "2026-01-20T13:51:46.908+0000", "origin": "INPUT_WEB" }, "descriptions": { "en": "Update Test of Datasource", "it": "Aggiornamento Test di Datasource", "ja": null, "aa": null, "zh": null, "sq": null, "hy": null, "be": null, "ar": null, "am": null, "as": null } } |
Show the number of Datasources
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasources-count |
| Body | - |
| Example of response | 12 |
Creates a new Datasource
| Method | POST |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasources |
| Body | { "id": "123123", "descriptions": { "it": "Aggiornamento Test di Datasource", "en": "Update Test of Datasource" }, "customQuery": { "sqlServer": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "hana": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "postgres": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "others": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "oracle": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA" }, "connection": "Current" } |
| Example of response | { "id": "123123", "oid": "OWHYWGRCDKWSAUY", "sort": [], "customQuery": { "sqlServer": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "hana": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "postgres": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "others": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "oracle": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA" }, "connection": "Current", "updateInfo": { "user": "USERT", "date": "2026-01-20T13:51:46.908+0000", "origin": "INPUT_WEB" }, "descriptions": { "en": "Update Test of Datasource", "it": "Aggiornamento Test di Datasource", "ja": null, "aa": null, "zh": null, "sq": null, "hy": null, "be": null, "ar": null, "am": null, "as": null } } |
Modifies a Datasource
| Method | PATCH |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasources/SQL |
| Body | { "id": "123123", "descriptions": { "it": "Modificato", "en": "Modified" }, "customQuery": { "sqlServer": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "hana": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "postgres": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "others": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "oracle": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA" }, "connection": "Current" } |
| Example of response | { "id": "123123", "oid": "OWHYWGRCDKWSAUR", "sort": [], "customQuery": { "sqlServer": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "hana": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "postgres": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "others": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "oracle": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA" }, "connection": "Current", "updateInfo": { "user": "USERT", "date": "2026-01-20T13:51:46.908+0000", "origin": "INPUT_WEB" }, "descriptions": { "en": "Modified", "it": "Modificato", "ja": null, "aa": null, "zh": null, "sq": null, "hy": null, "be": null, "ar": null, "am": null, "as": null } } |
Create a Datasource, edit another Datasource and delete another Datasource
| Method | POST |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasources-bulk |
| Body | { "saveMode": "LOOSE", "post": [ { "id": "100012", "descriptions": { "en": "bulk-post-en", "it": "bulk-post-it" }, "customQuery": { "sqlServer": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "hana": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "postgres": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "others": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "oracle": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA" }, "connection": "Current" } ], "patch": [ { "key": { "id": "EXISTS" }, "data": { "sort": [], "descriptions": { "it": "EXISTS-it-patch-updated", "en": "EXISTS-en-patch-updated" }, "customQuery": { "sqlServer": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "hana": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "postgres": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "others": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA", "oracle": "SELECT COD_AZIENDA as AZ3, COD_AZIENDA as AZ1, COD_AZIENDA as AZ2 FROM AZIENDA" }, "connection": "Current" } } ], "delete": [ { "id": "EXIST1" } ] } |
| Example of response | { "code": "SUCCESS" } |