{"_id":"5b0e13ffc4664e0003c75c5f","__v":0,"user":"554340dfb7f4540d00fcef1d","parentDoc":null,"project":"5b0e13ffc4664e0003c75a66","category":{"_id":"5b0e13ffc4664e0003c75a75","project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":32,"slug":"api","title":"API Reference"},"version":{"_id":"5b0e13ffc4664e0003c75a67","project":"5b0e13ffc4664e0003c75a66","__v":4,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["5b0e13ffc4664e0003c75a68","5b0e13ffc4664e0003c75a69","5b0e13ffc4664e0003c75a6a","5b0e13ffc4664e0003c75a6b","5b0e13ffc4664e0003c75a6c","5b0e13ffc4664e0003c75a6d","5b0e13ffc4664e0003c75a6e","5b0e13ffc4664e0003c75a6f","5b0e13ffc4664e0003c75a70","5b0e13ffc4664e0003c75a71","5b0e13ffc4664e0003c75a72","5b0e13ffc4664e0003c75a73","5b0e13ffc4664e0003c75a74","5b0e13ffc4664e0003c75a75","5b0e13ffc4664e0003c75a76","5b0e13ffc4664e0003c75a77","5b0e13ffc4664e0003c75a89","5b0e13ffc4664e0003c75a8a","5b0e13ffc4664e0003c75a9d","5b0e13ffc4664e0003c75a9e","5b0e13ffc4664e0003c75a9f","5b0e13ffc4664e0003c75aa0","5b0e13ffc4664e0003c75aa1","5b0e13ffc4664e0003c75aa2","5b0e13ffc4664e0003c75aa3","5b0e13ffc4664e0003c75aa4","5b0e13ffc4664e0003c75aa5","5b0e13ffc4664e0003c75aa6","5b0e13ffc4664e0003c75aa7","5b0e13ffc4664e0003c75aa8","5b0e13ffc4664e0003c75aa9","5b0e13ffc4664e0003c75aaa","5b0e13ffc4664e0003c75aab","5b0e13ffc4664e0003c75aac","5b0e13ffc4664e0003c75aad","5b0e13ffc4664e0003c75aae","5b0e13ffc4664e0003c75aaf","5b0e13ffc4664e0003c75ab2","5bb3374f4306ad0003eb18e7","5bbf3c5373e72a000318362b","5bc065567d1cb0000384c649","5cbf19a5f9181f0033fbb968"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":["56a7344351cacd1900464486"],"next":{"pages":[],"description":""},"createdAt":"2015-10-29T21:29:18.862Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[]},"method":"post","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":75,"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://f4c-api.sbgenomics.com/v2/tasks/{task_id}/actions/run\",\n      \"language\": \"text\",\n      \"name\": \"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: f4c-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://f4c-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 [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\": \"`use_interruptible_instances`\",\n    \"1-1\": \"boolean\",\n    \"1-2\": \"This field can be true or false. Set this field to true to allow the use of [spot instances](doc:about-spot-instances).\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n##Response\n\n[See a list of 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://f4c-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\\\": true,\\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]","excerpt":"/tasks/{task_id}/actions/run","slug":"perform-an-action-on-a-specific-task","type":"endpoint","title":"Run a task"}

postRun a task

/tasks/{task_id}/actions/run

This call runs (executes) the specified task. Only tasks whose status is `"DRAFT"` may be run. [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/tasks/{task_id}/actions/run", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "POST /v2/tasks/b0bbeda6-153b-4801-92ad-82bc0e58bdb6/actions/run\" HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X POST \"https://f4c-api.sbgenomics.com/v2/tasks/b0bbeda6-153b-4801-92ad-82bc0e58bdb6/actions/run\"", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`X-SBG-Auth-Token`\n_required_", "0-1": "Your [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Path parameters [block:parameters] { "data": { "0-0": "`task_id`", "h-0": "Name", "h-1": "Description", "0-1": "The ID of the task you are acting on." }, "cols": 2, "rows": 1 } [/block] ###Query parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Description", "0-0": "`fields`", "0-1": "string", "0-2": "Selector specifying a subset of fields to include in the response.", "1-0": "`use_interruptible_instances`", "1-1": "boolean", "1-2": "This field can be true or false. Set this field to true to allow the use of [spot instances](doc:about-spot-instances)." }, "cols": 3, "rows": 2 } [/block] ##Response [See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body [block:code] { "codes": [ { "code": "{\n \"href\": \"https://f4c-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\": true,\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}", "language": "json" } ], "sidebar": true } [/block]