HOPEX Power Studio (EN) : Using APIs : HOPEX Web Service API : Dataset export
   
Dataset export
 
DataSet export request
DataSet export job progress request
DataSet export job result
DataSet export request
{REPOSITORYBASEURL} = {WEBSERVICEURL}/environments/{env_id}/repositories/{rep_id}/profiles/{prof_id}
 
Where:
o {env_id}: environment identifier
o {rep_id}: repository identifier
o {prof_id}: profile identifier
± http GET {REPOSITORYBASEURL}/datasets/{dataset_id}?{parameters}
Authorization: ...
 
{parameters}:
- regenerate
o activate recalculation of the whole dataset
o type :
- boolean
o optional (default : yes)
 
Response:
HTTP/1.1 202 Accepted
Location: /datasets/{dataset_id}/job/<job_id>
 
{"job_id": "<job_id>"}
DataSet export job progress request
± http GET {REPOSITORYBASEURL}/datasets/{dataset_id}/job/<job_id>
Authorization: ...
 
The following responses are possible:
• Response 1 (in progress)
HTTP/1.1 202 Accepted
 
{ "job_status": "RUNNING", "job_info": « message renvoyé par le générateur de json pour les listview de cdb » }
 
• Response 2 (done)
HTTP/1.1 202 Accepted
 
{ "job_status": "TERMINATED", "job_info": { "reason": "DONE", "result": "result.xmg" }}
 
• Response 3 (error)
HTTP/1.1 202 Accepted
 
{ "job_status": "TERMINATED", "job_info": { "reason": "ERROR", "errmsg": "Does not work!!!" }}
 
DataSet export job result
Available if job progress is DONE.
± http GET {REPOSITORYBASEURL}/datasets/{dataset_id}/job/<job_id>/result?{parameters}
Authorization: ...
NB: management of parameters is not implemented for HOPEX V2. This is a project for a next version.
Where {parameters}:
- firstLine
o first dataset line to export
o type :
- int
o optional (default :0)
- lineCount
o number of dataset lines from the firstLine to export
o type :
- int
o optional (default :0 (it means all))
 
Response:
HTTP/1.1 202 Accepted
 
………… file content ……………