HOPEX Power Studio > Using APIs > HOPEX Web Service API > Dataset Export
Dataset Export
 
Asynchronous method
URL
Querystring filter
Result
Pooling your process
URL
Result
Get the dataset export result
URL
Result
Synchronous method
URL
Querystring filter
Result
As for the Import and Export file web services, you can call the Dataset Export web service in one of the following ways:
*Asynchronously in Rest
*Synchronously in Rest
*With SignalR
As for the Import, you need the environment and the repository id. These two parameters can be retrieved from the environments and repositories endpoints.
Asynchronous method
URL
http://<server>/restapi/v1/environments/<env_id>/repositories/<repo_id>/profiles/<prof_id>/datasets/<dataset_id>
Where:
*Server is the server url
*Env_id is the environment id
*Repo_id is the repository id
*Prof_id is the profile id
*Daatset_id is the id of the dataset to export
Querystring filter
 
Input
Description
Format
Parameter
regenerate
Activate recalculation of the whole dataset.
type: boolean
optional (default : true)
Parameters are set in the URL
Result
According to your Accept header, the result is in XML or Json format.
Pooling your process
As for the import asynchronous method, to pool your process you can call the endpoint.
URL
http://<server>/restapi/v1/environments/<env_id>/repositories/<repo_id>/profiles/<prof_id>/datasets/<dataset_id>/job/{job_id}
Result
The following responses are possible:
*Response 1 (in progress)
{ "job_status": "RUNNING" }
*Response 2 (done)
{ "job_status": "TERMINATED", "job_info": { "reason": "DONE", "result": "result.xmg" "rejects": false }}
*Response 3 (error)
{ "job_status": "TERMINATED", "job_info": { "reason": "ERROR", "errmsg": "Does not work!!!" "rejects": false }}
Example, if the Process is terminated.
Get the dataset export result
URL
http://<server>/restapi/v1/environments/<env_id>/repositories/<repo_id>/profiles/<prof_id>/datasets/<dataset_id>/job/{job_id}/result
Result
Note: The result is in JSON Format serialized in a string
 
Synchronous method
As for the Import web service, you can call the Dataset Export web service synchronously.
URL
http://<server>/restapi/v1/environments/<env_id>/repositories/<repo_id>/profiles/<prof_id>/datasets/<dataset_id>/syncexport?regenerate=<propagate>
Where:
*Server is the server url
*Env_id is the environment id
*Repo_id is the repository id
*Prof_id is the profile id
*Daatset_id is the id of the dataset to export
Querystring filter
 
Input
Description
Format
Parameter
regenerate
Activate recalculation of the whole dataset.
type: boolean
optional (default : true)
Parameters are set in the URL
Result
If the export is successful, you get the result in JSON Format serialized in a string.