{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","examples":{"codes":[]},"settings":"","results":{"codes":[]},"method":"post","params":[]},"next":{"description":"","pages":[]},"title":"Rerun a task","type":"endpoint","slug":"rerun-a-task","excerpt":"/tasks/{task_id}/actions/clone\n\nFor general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).","body":"This call reruns the specified task. Once rerun, the task can either be in draft mode or immediately ran, using the `action` query parameter (see below).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/tasks/{task_id}/actions/clone\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example request\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v2/tasks/b0bbeda6-153b-4801-92ad-82bc0e58bdb6/actions/clone\\\" HTTP/1.1\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\",\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://cgc-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 rerunning 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\": \"`action`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Set this to `run` in order to create a draft task and execute it immediately.\",\n    \"1-0\": \"`batch`\",\n    \"1-1\": \"boolean\",\n    \"1-2\": \"Set this to `false` to disable the default batching for this task.\",\n    \"2-0\": \"`use_interruptible_instances`\",\n    \"2-1\": \"boolean\",\n    \"2-2\": \"This field can be `true` or `false`.\\n\\nSet this field to `true` to allow the use of [spot instances](doc:about-spot-instances).\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\n[See a list of CAVATICA-specific response codes that may be contained in the body of the response.](ref:api-status-codes)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example response body\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/tasks/79ef6004-4529-4801-a86d-64cef2b4f2e8\\\",\\n    \\\"id\\\": \\\"79ef6004-4529-3801-a86d-61cef5b4f2e8\\\",\\n    \\\"name\\\": \\\"VarsScan2 WF from BAM test\\\",\\n    \\\"status\\\": \\\"DRAFT\\\",\\n    \\\"project\\\": \\\"rfranklin/rfranklin-s-demo-project\\\",\\n    \\\"app\\\": \\\"rfranklin/rfranklin-s-demo-project/varscan2-workflow-from-bam-v2-3-9/0\\\",\\n    \\\"type\\\": \\\"v2\\\",\\n    \\\"created_by\\\": \\\"rfranklin\\\",\\n    \\\"start_time\\\": \\\"2018-07-03T14:24:10Z\\\",\\n    \\\"batch\\\": false,\\n    \\\"use_interruptible_instances\\\": false,\\n    \\\"errors\\\": [],\\n    \\\"warnings\\\": [],\\n    \\\"inputs\\\": {\\n        \\\"input_fasta_file\\\": {\\n            \\\"path\\\": \\\"5b311652f890e8dfeb24ab2b\\\",\\n            \\\"class\\\": \\\"File\\\"\\n        },\\n        \\\"Normal_BAM\\\": {\\n            \\\"path\\\": \\\"5b311652f890e8dfeb24aaf7\\\",\\n            \\\"class\\\": \\\"File\\\"\\n        },\\n        \\\"Tumor_BAM\\\": {\\n            \\\"path\\\": \\\"5b311652f890e8dfeb24aae1\\\",\\n            \\\"class\\\": \\\"File\\\"\\n        }\\n    },\\n    \\\"outputs\\\": {\\n        \\\"High_Confidence_INDELs\\\": {},\\n        \\\"empty_contigs\\\": {},\\n        \\\"High_Confidence_SNPs\\\": {}\\n    },\\n    \\\"created_time\\\": \\\"2018-07-03T14:24:10Z\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","updates":[],"order":105,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b4f497c9711cc0003430356","project":"5773dcfc255e820e00e1cd4d","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","6024033e2b2f6f004dfe994c","60a7a12f9a06c70052b7c4db","60a7ab97266a4700161507c4","60b0c84babba720010a8b0b5"],"_id":"5773dcfc255e820e00e1cd50","__v":39,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"CAVATICA API","slug":"api","order":22,"from_sync":false,"reference":false,"_id":"5773df36904b0c0e00ef05ff","createdAt":"2016-06-29T14:46:14.277Z","version":"5773dcfc255e820e00e1cd50","__v":1,"project":"5773dcfc255e820e00e1cd4d"},"user":"566590c83889610d0008a253","createdAt":"2018-07-18T14:06:52.103Z","githubsync":"","__v":0,"parentDoc":null}

Get started

Tutorials

CAVATICA Projects

Find apps

Find files

Add files to a project

Bring data to CAVATICA

Set metadata associated with a file

Collaborate securely

BRING YOUR TOOLS

Docker

Developer tools

EDIT AN APP

Tool wrapping tips and tricks

Describe your tool (Legacy)

Browse public datasets

Run an analysis

Task Execution

Review a task

INTERACTIVE ANALYSIS

Kids First studies

CAVATICA Datasets

CAVATICA API

Connect cloud storage

SBFS (Beta)

BULK API ACTIONS

ASYNC BULK ACTIONS

DRS API

WES API

CAVATICA DATASETS API (Advanced Access)

Data Cruncher

SBFS (Beta)

SBFS Command reference

postRerun a task

/tasks/{task_id}/actions/clone For general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).
This call reruns the specified task. Once rerun, the task can either be in draft mode or immediately ran, using the `action` query parameter (see below). [block:api-header] { "type": "basic", "title": "Request" } [/block] [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/tasks/{task_id}/actions/clone", "language": "text", "name": "Path" } ] } [/block] [block:api-header] { "type": "basic", "title": "Example request", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "POST /v2/tasks/b0bbeda6-153b-4801-92ad-82bc0e58bdb6/actions/clone\" HTTP/1.1\nHost: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X POST \"https://cgc-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 CAVATICA [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 rerunning on." }, "cols": 2, "rows": 1 } [/block] ###Query parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Description", "0-0": "`action`", "0-1": "string", "0-2": "Set this to `run` in order to create a draft task and execute it immediately.", "1-0": "`batch`", "1-1": "boolean", "1-2": "Set this to `false` to disable the default batching for this task.", "2-0": "`use_interruptible_instances`", "2-1": "boolean", "2-2": "This field can be `true` or `false`.\n\nSet this field to `true` to allow the use of [spot instances](doc:about-spot-instances)." }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Response" } [/block] [See a list of CAVATICA-specific response codes that may be contained in the body of the response.](ref:api-status-codes) [block:api-header] { "type": "basic", "title": "Example response body", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/tasks/79ef6004-4529-4801-a86d-64cef2b4f2e8\",\n \"id\": \"79ef6004-4529-3801-a86d-61cef5b4f2e8\",\n \"name\": \"VarsScan2 WF from BAM test\",\n \"status\": \"DRAFT\",\n \"project\": \"rfranklin/rfranklin-s-demo-project\",\n \"app\": \"rfranklin/rfranklin-s-demo-project/varscan2-workflow-from-bam-v2-3-9/0\",\n \"type\": \"v2\",\n \"created_by\": \"rfranklin\",\n \"start_time\": \"2018-07-03T14:24:10Z\",\n \"batch\": false,\n \"use_interruptible_instances\": false,\n \"errors\": [],\n \"warnings\": [],\n \"inputs\": {\n \"input_fasta_file\": {\n \"path\": \"5b311652f890e8dfeb24ab2b\",\n \"class\": \"File\"\n },\n \"Normal_BAM\": {\n \"path\": \"5b311652f890e8dfeb24aaf7\",\n \"class\": \"File\"\n },\n \"Tumor_BAM\": {\n \"path\": \"5b311652f890e8dfeb24aae1\",\n \"class\": \"File\"\n }\n },\n \"outputs\": {\n \"High_Confidence_INDELs\": {},\n \"empty_contigs\": {},\n \"High_Confidence_SNPs\": {}\n },\n \"created_time\": \"2018-07-03T14:24:10Z\"\n}", "language": "json" } ], "sidebar": true } [/block]