{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","method":"post","params":[],"results":{"codes":[]},"settings":"","examples":{"codes":[]}},"next":{"description":"","pages":[]},"title":"Run a task","type":"endpoint","slug":"run-a-task","excerpt":"/tasks/{task_id}/actions/run\n\nFor general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).","body":"This call runs (executes) the specified task. Only tasks whose status is `\"DRAFT\"` may be run.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/tasks/{task_id}/actions/run\",\n      \"language\": \"text\",\n      \"name\": \"API path\"\n    }\n  ]\n}\n[/block]\n\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v2/tasks/b0bbeda6-153b-4801-92ad-82bc0e58bdb6/actions/run\\\" HTTP/1.1\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl  -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"content-type: application/json\\\" -X POST \\\"https://cavatica-api.sbgenomics.com/v2/tasks/b0bbeda6-153b-4801-92ad-82bc0e58bdb6/actions/run\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`X-SBG-Auth-Token`\\n_required_\",\n    \"0-1\": \"Your Cavatica [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`task_id`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The ID of the task you are acting on.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`fields`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Selector specifying a subset of fields to include in the response.\",\n    \"1-0\": \"`batch`\",\n    \"1-1\": \"boolean\",\n    \"1-2\": \"Set this to `False` to disable the default batching for this task.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n##Response\n\n[See a list of Cavatica-specific response codes that may be contained in the body of the response.](doc:api-status-codes) \n\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/tasks/234edb2d-a866-4828-a7c3-0aa757f991e7\\\",\\n  \\\"id\\\": \\\"234edb2d-a866-4828-a7c3-0aa757f991e7\\\",\\n  \\\"name\\\": \\\"new name for my task\\\",\\n  \\\"description\\\": \\\"re-describing the task\\\",\\n  \\\"status\\\": \\\"RUNNING\\\",\\n  \\\"project\\\": \\\"RFranklin/my-project\\\",\\n  \\\"use_interruptible_instances\\\": false,\\n  \\\"app\\\": \\\"RFranklin/my-project/new/0\\\",\\n  \\\"type\\\": \\\"v2\\\",\\n  \\\"created_by\\\": \\\"RFranklin\\\",\\n  \\\"executed_by\\\": \\\"RFranklin\\\",\\n  \\\"start_time\\\": \\\"2016-01-12T18:39:30Z\\\",\\n  \\\"execution_status\\\": {\\n    \\\"message\\\": \\\"Initializing...\\\"\\n  },\\n  \\\"inputs\\\": {\\n    \\\"dispersion_threshold\\\": null,\\n    \\\"cuffdiff_zip\\\": {\\n      \\\"class\\\": \\\"File\\\",\\n      \\\"path\\\": \\\"562785e6e4b00a1d67a8b1aa\\\",\\n      \\\"name\\\": \\\"example_human_known_indels.vcf\\\"\\n    },\\n    \\\"density_threshold\\\": null,\\n    \\\"thresholds_off\\\": null\\n  },\\n  \\\"outputs\\\": {\\n    \\\"archive\\\": null,\\n    \\\"html\\\": null\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n \n<hr>","updates":[],"order":77,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5774fafaece8a00e00a1595d","parentDoc":null,"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5773dcfc255e820e00e1cd51","5773df36904b0c0e00ef05ff","577baf92451b1e0e006075ac","577bb183b7ee4a0e007c4e8d","577ce77a1cf3cb0e0048e5ea","577d11865fd4de0e00cc3dab","578e62792c3c790e00937597","578f4fd98335ca0e006d5c84","578f5e5c3d04570e00976ebb","57bc35f7531e000e0075d118","57f801b3760f3a1700219ebb","5804d55d1642890f00803623","581c8d55c0dc651900aa9350","589dcf8ba8c63b3b00c3704f","594cebadd8a2f7001b0b53b2","59a562f46a5d8c00238e309a","5a2aa096e25025003c582b58","5a2e79566c771d003ca0acd4","5a3a5166142db90026f24007","5a3a52b5bcc254001c4bf152","5a3a574a2be213002675c6d2","5a3a66bb2be213002675cb73","5a3a6e4854faf60030b63159","5c8a68278e883901341de571","5cb9971e57bf020024523c7b","5cbf1683e2a36d01d5012ecd","5dc15666a4f788004c5fd7d7","5eaff69e844d67003642a020","5eb00899b36ba5002d35b0c1","5eb0172be179b70073dc936e","5eb01b42b36ba5002d35ebba","5eb01f202654a20136813093","5eb918ef149186021c9a76c8","5f0839d3f4b24e005ebbbc29","5f893e508c9862002d0614a9"],"_id":"5773dcfc255e820e00e1cd50","__v":35,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"createdAt":"2016-06-30T10:56:58.461Z","project":"5773dcfc255e820e00e1cd4d","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Cavatica API","slug":"api","order":18,"from_sync":false,"reference":false,"_id":"5773df36904b0c0e00ef05ff","createdAt":"2016-06-29T14:46:14.277Z","version":"5773dcfc255e820e00e1cd50","__v":0,"project":"5773dcfc255e820e00e1cd4d"},"githubsync":"","user":"575e85ac41c8ba0e00259a44","__v":4}