Data processing APIs for loading data onto Analytical Workspaces
URL¶
API for loading data onto an Analytical Workspace dataset¶
Loads the data from an external source onto the dataset defined on the Analytical Workspace identified by the workspace_code/dataset_code pair belonging to the DB identified by the database_id, on the type identified by the typology code ($ for the reporting layer). The setup used for loading corresponds to the one defined in the datasource mapping identified by the code dsm_code.
Method¶
POST
URL¶
Property¶
The following properties related to the execution context can be included in JSON format in the body of the request:
| Property | Description | Options |
|---|---|---|
| process | Mandatory. Process selected for loading. | - |
| scenario | Only required for processes with submission by scenario and period, but not needed for single submission processes. | - |
| period | Only required for processes with submission by scenario and period, but not needed for single submission processes. | - |
| entity | Mandatory. Entity or node selected for loading. | - To indicate the entity, the entity code (e.g. A01) - To indicate a node, the string made up of "GER |
Examples¶
{ "process":"CAV1", "scenario":"2020sp", "period":"07", "entity":"A01"} - load for entity A01 with process CAV1 and scenario/period equal to 2020sp/07
{ "process":"CAV1", "scenario":"2020sp", "period":"07", "entity":"GER|01"} - loading for node 01 with process CAV1 and scenario/period equal to 2020sp/07
Data returned¶
In the response, the following ID will be returned in JSON format:
dataprocessingId: data processing ID.
E.g.: { "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB" }
API for checking the status of data loading onto an Analytical Workspace dataset¶
Returns the status of the loading data process.
Method¶
GET
URL¶
Data returned¶
In the response, the data processing status will be returned in JSON format:
status: RUNNING/FAILED/COMPLETED
| Status | Description |
|---|---|
| RUNNING | Running |
| FAILED | Failed |
| COMPLETED | Completed successfully |
E.g.: {"requestDateTime": "2021-06-25T10:56:42.850+0000", "status": "COMPLETED"}
API for stopping the loading of data onto an Analytical Workspace dataset¶
Method¶
DELETE
URL¶
Data returned¶
In the response, the following ID will be returned in JSON format:
message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"
| Message | Description |
|---|---|
| Stop on dataprocessingOid | Data Processing was stopped |
| Notify on dataprocessingOid | Data processing requested to be stopped but still in progress |
E.g.: {"message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"}