API Set Online Dataset
This API allows you to manage the operation for bringing a Dataset of the Tagetik application online.
| API title: | AIH Dataset swagger openapi 3.0.3 |
| Description: | API for managing the online activation of Datasets 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 | List of Dataset IDs | ID Analytical Workspace | Dataprocessing ID | 201 (Created) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | |
| Read | GET | Dataprocessing ID | Dataprocessing Info | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) | ||
| Delete | Dataprocessing ID | Stop message for the Dataprocessing ID | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) |
"filter' accepts the fields 'id, process.id, process.description, scenario.id, scenario.description, period.id, period.description, entity.id, entity.description, typology.id, typology.description and status'.
Supported Fields in Request¶
| Partition Field | Supported cardinality | Supported Values |
|---|---|---|
| datasets | Quantity of Analytical Workspace datasets | string |
¶
Additional Fields in Response¶
| *Partition* Field | Supported Values |
|---|---|
| dataprocessingId | string |
| requestDateTime | date |
| status | RUNNING, FAILED, COMPLETED |
| parameters | string |
Examples of requests¶
Shows the status of a specific data processing
| Method | GET |
| URL | /api/aih/setonline/v1/{dbID}/2C98FD249BDE7D25019BE12F29473052 |
| Body | - |
| Example of response | { "requestDateTime": "2026-01-21T15:32:03.244+0000", "status": "COMPLETED", "parameters": {} } |
Put specific datasets of an Analytical Workspace online
| Method | POST |
| URL | /api/aih/setonline/v1/{dbID}/AWN |
| Body | { "datasets": [ "ABC", "BBB" ] } |
| Example of response | { "dataprocessingId": "2C98FD249BDE7D25019BE12F29473052" } |
Stop dataprocessing
| Stop dataprocessing | |
| Method | DELETE |
| URL | /api/aih/setonline/v1/{dbID}/2C98FD249BDE7D25019BE12F29473052 |
| Body | - |
| Example of response | { "message": "Stop on dataprocessingOid 2C98FD249BDE7D25019BE12F29473052" } |