{ "swagger": "2.0", "info": { "title": "BioBB REST API", "license": { "name": "MIT License" }, "version": "1.5.0", "description": "
Tools are executed in asynchronous mode, as the time to completion is usually unknown and will depend on the tool and the available resources. Thus, endpoints should be called in three steps: launch, poll and data retrieval.
Below there is a list with the generic endpoints of the BioBB REST API. To take a look to all the endpoints available for the complete list of packages and tools, please go to the Tools Endpoints section.
" }, "host": "mmb.irbbarcelona.org", "basePath": "\/biobb-dev\/biobb-api\/public\/rest\/v1", "schemes": [ "https", "http" ], "consumes": [ "application\/json" ], "produces": [ "application\/json", "text\/plain", "application\/octet-stream", "application\/application\/x-gzip", "application\/zip" ], "tags": [ { "name": "List of Services", "description": "Provide all the information related to packages and tools" }, { "name": "Launch Tool", "description": "GET and POST operations for launching a tool" }, { "name": "Retrieve", "description": "Operations for retrieve the status of a job and the data generated by this job" }, { "name": "Sample Files", "description": "Access to all the available sample files" } ], "paths": { "\/launch": { "get": { "tags": [ "List of Services" ], "summary": "Get list of all available packages", "description": "Gets all the packages and tools available for executing through the REST API", "operationId": "getPckgList", "produces": [ "application\/json" ], "responses": { "200": { "description": "Successful operation", "schema": { "properties": { "packages": { "description": "List of all the BioBB packages available", "type": "array", "items": { "$ref": "#\/definitions\/Package" } } } } }, "503": { "description": "Database Not Found", "schema": { "$ref": "#\/definitions\/Status" } } }, "deprecated": false, "security": [ { "bearer": [] } ] } }, "\/launch\/{package}": { "get": { "tags": [ "List of Services" ], "summary": "Get list of all available tools for a given package", "description": "Gets all the packages and tools available for executing through the REST API", "operationId": "getToolsList", "produces": [ "application\/json" ], "parameters": [ { "name": "package", "in": "path", "description": "Package identifier", "required": true, "type": "string", "default": "biobb_io" } ], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#\/definitions\/Package" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#\/definitions\/Status" } }, "503": { "description": "Database Not Found", "schema": { "$ref": "#\/definitions\/Status" } } }, "deprecated": false, "security": [ { "bearer": [] } ] } }, "\/launch\/{package}\/{tool}": { "get": { "tags": [ "Launch Tool" ], "summary": "Get information for a given tool", "description": "Gets id, description and all the arguments (required or not) for a given tool / package", "operationId": "getLaunchTool", "produces": [ "application/json" ], "parameters": [ { "name": "package", "in": "path", "description": "Package identifier", "required": true, "type": "string", "default": "biobb_analysis" }, { "name": "tool", "in": "path", "description": "Tool identifier", "required": true, "type": "string", "default": "cpptraj_average" } ], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#\/definitions\/Tool" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#\/definitions\/Status" } }, "503": { "description": "Database Not Found", "schema": { "$ref": "#\/definitions\/Status" } } }, "deprecated": false, "security": [ { "bearer": [] } ] }, "post": { "tags": [ "Launch Tool" ], "summary": "Launch a new job with a given tool", "description": "Launches a new job uploading a series of files. Click here for getting all the sample files for this tool in a compressed .zip file.