REST API

Cipres Portal Web Server REST API
The REST API provides web services for end users to submit a job to the portal programmatically. Currently, only one job submission is allowed for each request.
The REST API provides the same functionality as those provided by the browser-based service

URI	HTTP Method	CRUD Operation	Description	Status Codes	Description
/restapi/job	POST	CREATE	submit a job to server	201(OK),400(Bad Request)	[more details]
/restapi/job/{id}	GET	READ	query submitted job status	200(OK),400(Bad Request),404(Not Found)	[more details]
/restapi/result/job/{id}/file/{filename}	GET	READ	retrieve submitted job result file	200(OK),400(Bad Request),404(Not Found)	[more details]
/restapi/result/email/{email}	GET	READ	retrieve list of URLs to job result files for {email}	200(OK),400(Bad Request),401(Unauthorized)	[more details]

Flow of the request from job submission to result retrieval:

1. CLIENT sends POST to submit a job;
   SERVLET returns URL for job status retrieval
2. CLIENT sends GET to retrieve job status using URL from 1;
   SERVLET returns URL to retrieve tmp file or result file;
3. CLIENT sends GET to retrieve content of tmpfile or result file;
   SERVLET returns content of requested file;

CIPRES is a Collaboration of the Following Institutions:
American Museum of Natural History, Florida State University, New Jersey Institute of Technology, North Carolina State University, Rice University, San Diego Supercomputer Center, Texas A&M, University of Arizona, University of British Columbia, University of California at Berkeley, University of California at San Diego, University of Connecticut, University of Pennsylvania, Univ. of South Carolina, University of Texas at Austin, and Yale University. xhtml | css