HOPEX Power Studio (EN) : Using APIs : HOPEX Web Service API : Object export
   
Object export
 
Export request
Export job progress request
Export job result
Export request
± http GET {REPOSITORYBASEURL}/export?{parameters}
Authorization: ...
 
Where {parameters}:
• objects
o root object list
o type :
- string
- list of coma separated object identifiers (base 64)
o mandatory
• format
o export format (see standard export documentation)
o type :
- string
- possible values : “XMG”, “MGR”
o mandatory
• propagate
o activate propagation (see standard export documentation)
o type :
- boolean
o optional (default : yes)
• perimeter
o perimeter identifier (see standard export documentation)
o type :
- string (idabs base 64)
o optional (default defined by default perimeter option)
• export_transfered_objects
o activate propagation objets transfer (see standard export documentation)
o type : boolean
o optional (default : yes)
• continue_on_confidential
o does not stop propagation in case of confidential object (see standard export documentation)
o type :
- boolean
o optional (default : false)
 
Note: for information regarding standard export, see HOPEX Power Studio - Export Tool API (to Export) documentation.
 
 
Response:
HTTP/1.1 202 Accepted
Location: /export/job/<job_id>
 
{"job_id": "<job_id>"}
Export job progress request
± http GET {REPOSITORYBASEURL}/export/job/<job_id>
Authorization: ...
 
The following responses are possible:
• Response 1 (in progress)
HTTP/1.1 202 Accepted
 
{ "job_status": "RUNNING", "job_info": { "step":"Writing objects", "nb_objects_collected":102, "nb_objects_written":50, "time_ellapsed":4 }}
 
• 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!!!" }}
Export job result
Available if job progress is DONE.
± http GET {REPOSITORYBASEURL}/export/job/<job_id>/result
Authorization: ...
 
 
Response:
HTTP/1.1 202 Accepted
 
………… file content ……………