Organization Acknowledgements
Senior Personnel Postdocs/Grad Students All Personnel by Institution
Collaborations
Presentations Publications
Community Software Morphology Databases Sequence Databases ATol

REST API - Status

Table 2: JobStatus Retrieval [back]

    Remarks
URI /restapi/job/{id} StatusURL returned from POST request in step 1
Operation GET JobStatus
Method HTTP GET  
Request Body GET /restapi/job/{id} HTTP/1.1  
Response
  • 200 OK and XML
    <?xml version="1.0" encoding="utf-8">
    <JobStatus status="COMPLETED">
       <ResultURL>[.../restapi/result/job{jobid}/file/{filename.1}]</ResultURL>
       <ResultURL>[.../restapi/result/job{jobid}/file/{filename.2}]</ResultURL>
       ....
    </JobStatus>
  • 200 OK and XML
    <?xml version="1.0" encoding="utf-8">
    <JobStatus status="IN_PROGRESS">
       <ResultURL>[.../restapi/result/job{jobid}/file/{filename.1}]</ResultURL>
       <ResultURL>[.../restapi/result/job{jobid}/file/{filename.2}]</ResultURL>
       ....
    </JobStatus>
  • 200 OK and XML
    <?xml version="1.0" encoding="utf-8">
    <JobStatus status="TIMEOUT">
       <ResultURL>[.../restapi/result/job{jobid}/file/{filename}]</ResultURL>
    </JobStatus>
  • 200 OK and XML
    <?xml version="1.0" encoding="utf-8">
    <JobStatus status="ERROR">
       <error>[error message from cipres framework]<error/>
    </JobStatus>
  • 400 Bad Request
    <?xml version="1.0" encoding="utf-8">
    <JobStatus status="INVALID_URL">
       <error>[Unable to retrieve requested information]<error/>
    </JobStatus>

COMPLETE
Multiple <ResultURL> links might be returned. Each contains a result file from the
requested job including any intermediate temporary file.

IN_PROGRESS
Multiple <ResultURL> links might be returned. Each contains an intermediate result file from the
requested job. Intermediate tmp.* files are updated every 5 minutes

TIMEOUT
Job is terminated due to timeout. <ResultURL> contains link to
retrieve the temporary file from the requested job.

ERROR
The request was accepted, but the requested job fails to complete.

INVALID_URL
Bad Request: The request URL was invalid.