Table 1: Required REST Input Parameters [back]

    Remarks
URI /restapi/job JobSubmission
Operation CREATE  
Method HTTP POST  
Data Fields
  • datafile
  • configfile (optional)
  • email
  • analysis
  • tool
  • datatype (Only required for FASTA file)

Please visit rest api help for more info on how to select the valid analysis and tool,
and to configure the parameters file

  • email
    your email address
  • datatype (Only required for FASTA file)
    DNA_DATATYPE
    RNA_DATATYPE
    AA_DATATYPE
  • datafile
    accepts file in nexus, phylip, Hennig86 or FASTA format
    For help with file formats, see File formats and CIPRES PORTAL
  • analysis and tool
    analysis and tool specify the job you want to submit to the portal.
    The valid values are based on the datatype and the number of taxa in your uploaded data file.
    Please see Tool Selection Table for more information.
  • configfile (optional)
    This file is optional, and is needed only if you want to change the default parameters.
    For a list of the default parameters, visit:
    GARLI
    PAUP
    RAxML
Request Body POST / HTTP/1.1
User-Agent: Jakarta Commons-HttpClient/3.1-rc1
Host:127.0.0.1:3333 Content-Length: 452
Content-Type: multipart/form-data; boundary=---------------------------29772313742745

-----------------------------29772313742745
Content-Disposition: form-data; name="datafile"; filename="datafile.nex"
Content-Type: applicaiton/octent-stream; charset=ISO-8859-1
Content-Transfer-Encoding:binary
[content of datafile here....]
-----------------------------29772313742745
Content-Disposition: form-data; name="configfile"; filename="configfile.xml"
Content-Type: applicaiton/octent-stream; charset=ISO-8859-1
Content-Transfer-Encoding:binary
[content of configfile here....]
-----------------------------29772313742745
Content-Disposition: form-data; name=""email""
Content-Type:text/plain; charset=US-ASCII
Content-Transfer-Encoding:8bit
lcchan@sdsc.edu
-----------------------------29772313742745
Content-Disposition: form-data; name="datatype"
Content-Type:text/plain; charset=US-ASCII
Content-Transfer-Encoding:8bit
DNA_DATATYPE
-----------------------------29772313742745
Content-Disposition: form-data; name="analysis"
Content-Type:text/plain; charset=US-ASCII
Content-Transfer-Encoding:8bit
MP
-----------------------------29772313742745
Content-Disposition: form-data; name="tool"
Content-Type:text/plain; charset=US-ASCII
Content-Transfer-Encoding:8bit
PAUP
-----------------------------29772313742745--
 Note some of the fields shown are optional
Response
  • 201 Created and XML
    <?xml version="1.0" encoding="utf-8">
    <JobSubmission status="OK">
       <StatusURL>.../restapi/job/[jobid]</StatusURL>
    </JobSubmission>
  • 400 Bad Request and XML
    <?xml version="1.0" encoding="utf-8">
    <JobSubmission status="ERROR">
       <error code=[error_code] message=[error_message]/>
    </JobSubmission>
Error Code; Error Message:
  • 1: Request is not a mulitipart message
  • 2: Data file is missing or empty
  • 3: Configuration file is empty
  • 4: Email is missing or invalid
  • 5: Analysis name is missing or invalid
  • 6: Tool name is missing or invalid
  • 7: Failed to convert file to nexus format
  • 8: Failed to parse uploaded file by RunNexusReader()
  • 9: datatype for FASTA file is missing or invalid