Run a task

/tasks/{task_id}/actions/run

This call runs (executes) the specified task. Only tasks whose status is "DRAFT" may be run.

Path

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/tasks/{task_id}/actions/run

Request

Example request

HTTP

POST /v2/tasks/723c949a-789c-12b3-45b6-b2dd0d8d0021/actions/run" HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

cURL

curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X POST "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/tasks/723c949a-789c-12b3-45b6-b2dd0d8d0021/actions/run"

Header Fields

Name	Description
X-SBG-Auth-Token required	Your authentication token.

Path parameters

Name	Description
task_id	The ID of the task you are acting on.

Query parameters

Name	Data type	Description
fields	string	Selector specifying a subset of fields to include in the response.
use_interruptible_instances	boolean	This field can be true or false. Set this field to true to allow the use of spot instances.

Response

See a list of response codes that may be contained in the body of the response.

Example response body

JSON

{
  "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/tasks/723c949a-789c-12b3-45b6-b2dd0d8d0021",
  "id": "723c949a-789c-12b3-45b6-b2dd0d8d0021",
  "name": "new name for my task",
  "description": "re-describing the task",
  "status": "RUNNING",
  "project": "RFranklin/my-project",
   "use_interruptible_instances": true,
  "app": "RFranklin/my-project/new/0",
  "type": "v2",
  "created_by": "RFranklin",
  "executed_by": "RFranklin",
  "start_time": "2016-01-12T18:39:30Z",
  "execution_status": {
    "message": "Initializing..."
  },
  "inputs": {
    "dispersion_threshold": null,
    "cuffdiff_zip": {
      "class": "File",
      "path": "567890abc3d8130ea4047731",
      "name": "example_human_known_indels.vcf"
    },
    "density_threshold": null,
    "thresholds_off": null
  },
  "outputs": {
    "archive": null,
    "html": null
  }
}