Run a task

/tasks/{task_id}/actions/run

For general information on the API, including formatting, parameters, and pagination, please see the API Overview.

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

https://cavatica-api.sbgenomics.com/v2/tasks/{task_id}/actions/run

Request

Example request

POST /v2/tasks/723c949a-789c-12b3-45b6-b2dd0d8d0021/actions/run" HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X POST "https://cavatica-api.sbgenomics.com/v2/tasks/723c949a-789c-12b3-45b6-b2dd0d8d0021/actions/run"

Header Fields

NameDescription
X-SBG-Auth-Token
required
Your CAVATICA authentication token.

Path parameters

NameDescription
task_idThe ID of the task you are acting on.

Query parameters

NameData typeDescription
fieldsstringSelector specifying a subset of fields to include in the response.
batchbooleanSet this to False to disable the default batching for this task.

Response

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

Example response body

{
  "href": "https://cavatica-api.sbgenomics.com/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": false,
  "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": "567890abc8a5136ec6127063",
      "name": "example_human_known_indels.vcf"
    },
    "density_threshold": null,
    "thresholds_off": null
  },
  "outputs": {
    "archive": null,
    "html": null
  }
}

Language