Partition Management API
This API enables the extraction of information, creation and deletion of Partitions from a Tagetik application Dataset.
| API title: | AIH Dataset swagger openapi 3.0.3 |
| Description: | API for Partition 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 Partition | Dataset Partition | 201 (Created) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| Read | GET | Dataset Partition ID | Dataset Partition | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) | ||
| Search | GET | filter sort skip take (optional parameters) | List of Dataset Partitions | 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 Partitions | 200 (OK) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) | ||
| Bulk-Delete-Async | POST | Partition ID(s) Dataset | ID Data Processing | 202 (Accepted) | 405 (Method not permitted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Invalid request) |
"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 |
|---|---|---|
| process.id | - | string |
| scenario.id | - | string |
| period.id | - | string |
| entity.id | - | string |
| typology.id | - | string |
¶
Additional Fields in Response¶
| *Partition* Field | Supported Values |
|---|---|
| process.description | string |
| scenario.description | string |
| period.description | string |
| entity.description | string |
| typology.description | string |
| status | ONLINE, OFFLINE, UPGRADE_IN_PROGRESS |
| id | string |
| physicalTableName | string |
Examples of requests¶
Show the list of all Partitions in a Dataset
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasets/000001/partitions |
| Body | - |
| Example of response | [ { "id": "000001", "physicalTableName": "AW_EFG_P00003_000001", "status": "ONLINE", "process": { "id": "BDG", "description": "BDG" }, "scenario": { "id": "$", "description": null }, "period": { "id": "$", "description": null }, "entity": { "id": "EN_00", "description": "New York xx" }, "typology": { "id": "$", "description": null } }, { "id": "000002", "physicalTableName": "AW_EFG_P00003_000002", "status": "ONLINE", "process": { "id": "SFT", "description": "Chiusura Leggera" }, "scenario": { "id": "2019ACT", "description": "2019 Actuals" }, "period": { "id": "11", "description": "Novembre" }, "entity": { "id": "EN_00", "description": "New York xx" }, "typology": { "id": "$", "description": null } } ] |
Shows a specific Partition of a Dataset
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasets/000001/partitions/000001 |
| Body | - |
| Example of response | { "id": "000001", "physicalTableName": "AW_EFG_000001_000001", "status": "ONLINE", "process": { "id": "BDG", "description": "BDG" }, "scenario": { "id": "$", "description": null }, "period": { "id": "$", "description": null }, "entity": { "id": "EN_00", "description": "New York xx" }, "typology": { "id": "$", "description": null } } |
Show the number of Partitions
| Method | GET |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasets/000001/partitions-count |
| Body | - |
| Example of response | 12 |
Create a new Partition
| Method | POST |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasets/000001/partitions |
| Body | { "process": { "id": "BDG" }, "entity": { "id": "EN_00" }, "typology": { "id": "TIP" } } |
| Example of response | { "id": "000001", "physicalTableName": "AW_EFG_000001_000001", "status": "ONLINE", "process": { "id": "BDG", "description": "BDG" }, "scenario": { "id": "$", "description": null }, "period": { "id": "$", "description": null }, "entity": { "id": "EN_00", "description": "New York xx" }, "typology": { "id": "$", "description": null } } |
Delete a Partition
| Method | POST |
| URL | /api/aih/datamodel/v1/{dbID}/workspaces/{awID}/datasets/123459/partitions-bulk-delete-async |
| Body | [ { "id": "000001" } ] |
| Example of response | { "dataProcessingId": "2C980CE49BD9F03A019BDC638CE7545B" } |