Adhoc 12.7 API Documentation

This is a description of the RESTful application programming interface (API) for this web resource. It is produced automatically by introspection of the Python source code.

The design of the web resource is such that the set of URLs is the same for the API and for the human user agents (browsers). This reduces complexity and increases clarity. Usually, browsers request HTML representations, while the JSON representation is intended for programmatic user agents. The different representations contain the same logical data.

Resource URL Description
Home /

The Adhoc home page.

File /static/{filepath:path}

Return the specified file from a predefined server directory.

Task list /tasks

Display list of tasks.

Task list account /tasks/{account}

Display list of tasks for an account.

Task /task/{iui:uuid}

Display the task.

Task status /task/{iui:uuid}/status

Return the task status.

Task query /task/{iui:uuid}/query

Return the task query.

Task output /task/{iui:uuid}/output

Return the task output.

Account list /accounts

Display information on all accounts.

Account /account/{account}

Display account information.

Documentation About /about

About page, describing the system software.

Documentation API /doc/API

Produce the documentation for the web resource API by introspection.

Documentation file /doc/{filename}

Return a static documentation page.

Login /login

Perform login to an account. Basic Authentication.

Tool blastn /blastn

Blastn tool: nucleotide query against a nucleotide database.

Tool blastp /blastp

Blastp task: protein query against a protein database.

Tool blastx /blastx

Blastp task: translated nucleotide query against a protein database.

Tool tblastn /tblastn

Tblastn task: protein query against a translated nucleotide database.

Tool tblastx /tblastx

Tblastx task: translated nucleotide query against a translated nucleotide database.

Home: /

The Adhoc home page.

GET

The Adhoc home page.

File: /static/{filepath:path}

Return the specified file from a predefined server directory.

GET

Return the specified file from a predefined server directory.

Task list: /tasks

Display list of tasks.

GET

Display list of tasks.

Task list account: /tasks/{account}

Display list of tasks for an account.

GET

Display list of tasks for an account.

Task: /task/{iui:uuid}

Display the task.

GET

Display the task.

DELETE

Delete the task.

Task status: /task/{iui:uuid}/status

Return the task status.

GET

Return the task status.

Task query: /task/{iui:uuid}/query

Return the task query.

GET

Return the task query.

Task output: /task/{iui:uuid}/output

Return the task output.

GET

Return the task output.

Account list: /accounts

Display information on all accounts.

GET

Display information on all accounts.

Account: /account/{account}

Display account information.

GET

Display account information.

Documentation About: /about

About page, describing the system software.

GET

About page, describing the system software.

Documentation API: /doc/API

Produce the documentation for the web resource API by introspection.

GET

Produce the documentation for the web resource API by introspection.

Documentation file: /doc/{filename}

Return a static documentation page.

GET

Return a static documentation page.

Login: /login

Perform login to an account. Basic Authentication.

GET

Perform login to an account. Basic Authentication.

Tool blastn: /blastn

Blastn tool: nucleotide query against a nucleotide database.

GET

Blastn tool: nucleotide query against a nucleotide database.

POST

Create and start execution of a 'blastn' task.

Tool blastp: /blastp

Blastp task: protein query against a protein database.

GET

Blastp task: protein query against a protein database.

POST

Create and start execution of a 'blastp' task.

Tool blastx: /blastx

Blastp task: translated nucleotide query against a protein database.

GET

Blastp task: translated nucleotide query against a protein database.

POST

Create and start execution of a 'blastx' task.

Tool tblastn: /tblastn

Tblastn task: protein query against a translated nucleotide database.

GET

Tblastn task: protein query against a translated nucleotide database.

POST

Create and start execution of a 'tblastn' task.

Tool tblastx: /tblastx

Tblastx task: translated nucleotide query against a translated nucleotide database.

GET

Tblastx task: translated nucleotide query against a translated nucleotide database.

POST

Create and start execution of a 'tblastx' task.

Documentation
About
API
API tutorial
Alternative representations
jsonJSON

Adhoc 12.7 SciLifeLab tools Per Kraulis (per.kraulis@scilifelab.se)