Financial Workspace update processing API
URL¶
http://server:port/tagetikcpm/api/aih/updateaw/v1/
API for updating the Financial Workspace¶
Runs an update of the Financial Workspace based on a dataset defined on the Analytical Workspace and identified by the workspace_code / dataset_code pair belonging to the DB identified by the database_id on the Financial Workspace.
The setup used for loading will be as defined on the dataset using the dsm_code functionality.
Method¶
POST
URL¶
<api-root>/aih/updatefw/v1/database_id/workspace_code``/``dataset_code
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. Scenario selected for loading. | - |
| period | Only required for processes with submission by scenario and period, but not needed for single submission processes. Scenario selected for loading. | - |
| 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 Financial Workspace update status¶
Returns the update data processing status.
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 Financial Workspace update¶
Stops the update.
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"}