{"_id":"5774f603ece8a00e00a15933","user":"575e85ac41c8ba0e00259a44","__v":5,"category":{"_id":"5773df36904b0c0e00ef05ff","version":"5773dcfc255e820e00e1cd50","__v":0,"project":"5773dcfc255e820e00e1cd4d","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-06-29T14:46:14.277Z","from_sync":false,"order":12,"slug":"api","title":"Cavatica API"},"version":{"_id":"5773dcfc255e820e00e1cd50","__v":26,"project":"5773dcfc255e820e00e1cd4d","createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"githubsync":"","parentDoc":null,"project":"5773dcfc255e820e00e1cd4d","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-30T10:35:47.977Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[],"url":""},"isReference":false,"order":69,"body":"This call returns a list of tasks that you can access. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/tasks\",\n      \"language\": \"text\",\n      \"name\": \"API path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/tasks 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 GET \\\"https://cavatica-api.sbgenomics.com/v2/tasks\\\"\",\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\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\": \"`status`\",\n    \"1-1\": \"string\",\n    \"1-2\": \"You can filter the returned tasks by their status. Set the value of `status` to one of the following values:\\n`\\\"QUEUED\\\"`\\n`\\\"DRAFT\\\"`\\n`\\\"RUNNING\\\"`\\n`\\\"COMPLETED\\\"`\\n`\\\"ABORTED\\\"`\\n`\\\"FAILED\\\"`\",\n    \"2-0\": \"`parent`\",\n    \"2-1\": \"string\",\n    \"2-2\": \"Enter the task ID of the parent task to return all child tasks from that parent.\\n\\nA **parent task** is a task that specifies criteria by which to batch its inputs into a series of further sub-tasks, called **child tasks**.\\n\\nSee the documentation on [batching tasks](doc:perform-batch-analysis) for more details on how to run tasks in batches.\",\n    \"3-0\": \"`project`\",\n    \"3-1\": \"string\",\n    \"3-2\": \"Enter the project ID of the project you wish to list the tasks from.\",\n    \"4-0\": \"`created_from`\",\n    \"4-1\": \"string\",\n    \"4-2\": \"Enter the starting date for querying tasks created on the specified date and onwards (see below for more information).\",\n    \"5-0\": \"`created_to`\",\n    \"5-1\": \"string\",\n    \"5-2\": \"Enter the ending date for querying tasks created until the specified date. You can use it in combination with the created_from to specify a time interval.\",\n    \"6-0\": \"`started_from`\",\n    \"6-1\": \"string\",\n    \"6-2\": \"Enter the starting date for querying tasks started on the specified date and onwards (see below for more information).\",\n    \"7-0\": \"`started_to`\",\n    \"7-1\": \"string\",\n    \"7-2\": \"Enter the starting date for querying tasks started until the specified date (see below for more information).\",\n    \"8-0\": \"`ended_from`\",\n    \"8-1\": \"string\",\n    \"8-2\": \"Enter the starting date for querying tasks that ended on a specified date (see below for more information).\",\n    \"9-0\": \"`ended_to`\",\n    \"9-1\": \"string\",\n    \"9-2\": \"Enter the ending date for querying tasks that ended until a specified date.\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\n###Using the timestamps\n\nThe parameters `created_from`, `created_to`, `started_from`, `started_to`, `ended_from` and `ended_to` are timestamp parameters.\n\nThey can be used to query tasks that were created, started, or ended during a specified time interval. All query parameters can be combined.\n\nFor example, querying https://cavatica-api.sbgenomics.com/v2/tasks?fields=_all&started_from=2016-12-26T12:46:25&ended_to=2016-12-28 will return all tasks which ran between December 26, 2016 at 12:46:25 and December 28.\n\nFurthermore, the timestamp query parameters can be combined with other query parameters. For example, querying https://cavatica-api.sbgenomics.com/v2/tasks?fields=_all&created_from=2016-12-26T12:46:25&status=FAILED will return all tasks which were created from December 26 onwards and have failed.\n\n####Date format\n\nAll dates should be entered using the UTC format (ISO 8601). Allowed formats are:\n\n1. <yyyy-MM-dd>T<HH:mm:ss>+/-<HH:mm> (use this format to specify the UTC offset, see below)\n2. yyyy-MM-ddTHH:mm:ss\n3. yyyy-MM-dd (when this format is used, the implicit time is 00:00:00)\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`yyyy`\",\n    \"0-1\": \"4 digits for the year (e.g. 2017)\",\n    \"1-0\": \"`T`\",\n    \"1-1\": \"special character followed by hours and minutes\",\n    \"2-0\": \"`ss`\",\n    \"2-1\": \"2 digits for seconds (e.g. \\\"25)\",\n    \"3-0\": \"`MM`\",\n    \"3-1\": \"2 digits for a month (e.g. \\\"02\\\" for February)\",\n    \"4-0\": \"`mm`\",\n    \"4-1\": \"2 digits for minutes (e.g. \\\"45\\\")\",\n    \"5-0\": \"`HH`\",\n    \"5-1\": \"2 digits for an hour (e.g. \\\"23\\\")\",\n    \"6-0\": \"`dd`\",\n    \"6-1\": \"2 digits for a day (e.g. \\\"01\\\")\",\n    \"7-0\": \"-\",\n    \"7-1\": \"UTC - hh:mm\",\n    \"8-0\": \"+\",\n    \"8-1\": \"UTC + hh:mm\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]\n####UTC offset (HH:mm)\n\nThe hours and minutes should be entered the same way as for the date but are used to specify the time offset (e.g. -05:00 = UTC-5). This means you can use your local time to query but have to specify the UTC offset.\n\n**Examples:** \n\n1. 2016-04-01T14:25:50+01:00 - Fri Apr 01 13:25:50 UTC 2016\n2. 2016-04-01T14:25:50 - Fri Apr 01 14:25:50 UTC 2016\n3. 2016-04-01 - Fri Apr 01 00:00:00 UTC 2016\n\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  \\\"items\\\": [\\n    {\\n      \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/tasks/d14259c2-3fe3-4f87-b4eb-a54847681fc9\\\",\\n      \\\"id\\\": \\\"d14259c2-3fe3-4f87-b4eb-a54847681fc9\\\",\\n      \\\"name\\\": \\\"bwa run - 05-11-2015 10:30:59\\\",\\n      \\\"description\\\": \\\"\\\",\\n      \\\"status\\\": \\\"Completed\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n<hr>","excerpt":"/tasks\n\nFor general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).","slug":"list-tasks-you-can-access","type":"endpoint","title":"List tasks you can access (primary method)"}

getList tasks you can access (primary method)

/tasks For general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).

This call returns a list of tasks that you can access. [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/tasks", "language": "text", "name": "API path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/tasks 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 GET \"https://cavatica-api.sbgenomics.com/v2/tasks\"", "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] ###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": "`status`", "1-1": "string", "1-2": "You can filter the returned tasks by their status. Set the value of `status` to one of the following values:\n`\"QUEUED\"`\n`\"DRAFT\"`\n`\"RUNNING\"`\n`\"COMPLETED\"`\n`\"ABORTED\"`\n`\"FAILED\"`", "2-0": "`parent`", "2-1": "string", "2-2": "Enter the task ID of the parent task to return all child tasks from that parent.\n\nA **parent task** is a task that specifies criteria by which to batch its inputs into a series of further sub-tasks, called **child tasks**.\n\nSee the documentation on [batching tasks](doc:perform-batch-analysis) for more details on how to run tasks in batches.", "3-0": "`project`", "3-1": "string", "3-2": "Enter the project ID of the project you wish to list the tasks from.", "4-0": "`created_from`", "4-1": "string", "4-2": "Enter the starting date for querying tasks created on the specified date and onwards (see below for more information).", "5-0": "`created_to`", "5-1": "string", "5-2": "Enter the ending date for querying tasks created until the specified date. You can use it in combination with the created_from to specify a time interval.", "6-0": "`started_from`", "6-1": "string", "6-2": "Enter the starting date for querying tasks started on the specified date and onwards (see below for more information).", "7-0": "`started_to`", "7-1": "string", "7-2": "Enter the starting date for querying tasks started until the specified date (see below for more information).", "8-0": "`ended_from`", "8-1": "string", "8-2": "Enter the starting date for querying tasks that ended on a specified date (see below for more information).", "9-0": "`ended_to`", "9-1": "string", "9-2": "Enter the ending date for querying tasks that ended until a specified date." }, "cols": 3, "rows": 10 } [/block] ###Using the timestamps The parameters `created_from`, `created_to`, `started_from`, `started_to`, `ended_from` and `ended_to` are timestamp parameters. They can be used to query tasks that were created, started, or ended during a specified time interval. All query parameters can be combined. For example, querying https://cavatica-api.sbgenomics.com/v2/tasks?fields=_all&started_from=2016-12-26T12:46:25&ended_to=2016-12-28 will return all tasks which ran between December 26, 2016 at 12:46:25 and December 28. Furthermore, the timestamp query parameters can be combined with other query parameters. For example, querying https://cavatica-api.sbgenomics.com/v2/tasks?fields=_all&created_from=2016-12-26T12:46:25&status=FAILED will return all tasks which were created from December 26 onwards and have failed. ####Date format All dates should be entered using the UTC format (ISO 8601). Allowed formats are: 1. <yyyy-MM-dd>T<HH:mm:ss>+/-<HH:mm> (use this format to specify the UTC offset, see below) 2. yyyy-MM-ddTHH:mm:ss 3. yyyy-MM-dd (when this format is used, the implicit time is 00:00:00) [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "`yyyy`", "0-1": "4 digits for the year (e.g. 2017)", "1-0": "`T`", "1-1": "special character followed by hours and minutes", "2-0": "`ss`", "2-1": "2 digits for seconds (e.g. \"25)", "3-0": "`MM`", "3-1": "2 digits for a month (e.g. \"02\" for February)", "4-0": "`mm`", "4-1": "2 digits for minutes (e.g. \"45\")", "5-0": "`HH`", "5-1": "2 digits for an hour (e.g. \"23\")", "6-0": "`dd`", "6-1": "2 digits for a day (e.g. \"01\")", "7-0": "-", "7-1": "UTC - hh:mm", "8-0": "+", "8-1": "UTC + hh:mm" }, "cols": 2, "rows": 9 } [/block] ####UTC offset (HH:mm) The hours and minutes should be entered the same way as for the date but are used to specify the time offset (e.g. -05:00 = UTC-5). This means you can use your local time to query but have to specify the UTC offset. **Examples:** 1. 2016-04-01T14:25:50+01:00 - Fri Apr 01 13:25:50 UTC 2016 2. 2016-04-01T14:25:50 - Fri Apr 01 14:25:50 UTC 2016 3. 2016-04-01 - Fri Apr 01 00:00:00 UTC 2016 ##Response [See a list of Cavatica-specific response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body [block:code] { "codes": [ { "code": "{\n \"items\": [\n {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/tasks/d14259c2-3fe3-4f87-b4eb-a54847681fc9\",\n \"id\": \"d14259c2-3fe3-4f87-b4eb-a54847681fc9\",\n \"name\": \"bwa run - 05-11-2015 10:30:59\",\n \"description\": \"\",\n \"status\": \"Completed\"\n }\n ]\n}", "language": "json" } ], "sidebar": true } [/block] <div align="right"><a href="#top">top</a></div> <hr>