REST API - Results
Table 4: Result File Retrieval for a specified email address
[back]
Note: You must have proper authorization to access this operation
| |
|
Remarks |
| URI |
/restapi/result/email/{email} |
return list of ResultURLs for {email} |
| Operation |
GET: list of result files for {email} |
|
| Method |
HTTP GET |
|
| Request Body |
GET /restapi/result/job/{id}/file/{filename} HTTP/1.1
Authorization: Basic Y2lxxxxxx...................
|
HTTP Basic Authentication is required |
| Response |
- Status Code: 200 (OK)
<?xml version="1.0" encoding="utf-8">
<JobResult status={Number of Links} >
<ResultURL>[.../cipres-web/ViewResultAction.do?sessinoId=xxx&sesscionCount=xxx&tool=xxx]</ResultURL>
<ResultURL>[.../cipres-web/ViewResultAction.do?sessinoId=xxx&sesscionCount=xxx&tool=xxx]</ResultURL>
<ResultURL>[.../cipres-web/ViewResultAction.do?sessinoId=xxx&sesscionCount=xxx&tool=xxx]</ResultURL>
<ResultURL>[.../cipres-web/ViewResultAction.do?sessinoId=xxx&sesscionCount=xxx&tool=xxx]</ResultURL>
....
</JobResult>
- Status Code: 401 (Unauthroized)
username and password are required to retrieve job links for email
- Status Code: 400 (Bad Request)
<?xml version="1.0" encoding="UTF-8"?>
<JobResult status="INVALID_EMAIL">
<error>Invalid EMAIL: Invalid Email or no job returned for given email </error>
</JobResult>
|
|
Note:
- &s are not escaped for readability, but will be escaped in the returned XML file in response.
- Each <ResultURL> is the link to access result files on the Cipres Portal Server;
- <ResultURL>s do not include jobs older than 7 days because of our purge policy on result files;
- <ResultURL>s only include jobs submitted via REST api (i.e jobs submitted directly on our portal are not included)
|
