API to export a dataset to file

Runs the Export data processing on a file of a dataset identified by the workspace_code/dataset_code pair belonging to the Analytical Workspace and the DB identified by the database_id.

The setup used for the export is as defined in the data target mapping file identified by the dtm_code, the selected type is reporting layer ($).

IMPORTANT: APIs do not support the running of data processing for the Export of a dataset to a file in which the download of the same file to the client/browser has been configured; therefore, at runtime, the following error will be returned: { "code": 400, "message": "Invalid file location - local download is not supported" }.

.

Method¶

POST

URL¶

api-root>/aih/dtm/v1/database_id/workspace_code/dataset_code/dtm_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 export.	-
scenario	Only required for processes with submission by scenario and period. No scenario must be selected for export , in the case of a single submission process.	-
period	Only required for processes with submission by scenario and period. No period must be selected for export , in the case of a single submission process.	-
entity	Mandatory. Entity or node selected for export.	- To indicate the entity, send the entity code (e.g. A01) - To indicate a node, send the string made up of "GER

Examples

Copy

Export for Entity A01 with process CAV1 and scenario/period 2020sp/07

{
    "process": "CAV1",
    "scenario":"2020sp",
    "period":"07",
    "entity":"A01"
}

Copy

Export for node 01 with process CAV1 and scenario/period equal to 2020sp/07

{
    "process": "CAV1",
    "scenario": "2020sp",
    "period": "07",
    "entity": "GER|01"
}

Data returned¶

The response returns the following ID in JSON format:

dataprocessingId = data processing ID.

Copy

{
    "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB"
}

API for checking export status of a dataset to file¶

Returns the export process status.

Method¶

GET

URL¶

/aih/dtm/v1/dataprocessingId

Data returned¶

The response returns the data processing status in JSON format:

status: RUNNING/FAILED/COMPLETED

Status	Description
RUNNING	Running
FAILED	Failed
COMPLETED	Completed successfully

Copy

{
    "requestDateTime": "2021-06-25T10:56:42.850+0000",
    "status": "COMPLETED",
    "parameters": []
}

API for stopping the export of a dataset to file¶

Stops the export.

Method¶

DELETE

URL¶

/aih/dtm/v1/dataprocessingId

Data returned¶

The response returns the following ID 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 still running

Copy

{
    "message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"
}