{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"List tasks you can access (primary method)","type":"endpoint","slug":"list-tasks-you-can-access","excerpt":"/tasks","body":"This call returns a list of tasks that you can access. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cgc-api.sbgenomics.com/v2/tasks\",\n      \"language\": \"text\",\n      \"name\": \"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: cgc-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 GET \\\"https://cgc-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 CGC [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    \"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    \"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-a-batch-analysis) for more details details on how to run tasks in batches.\",\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-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    \"8-1\": \"string\",\n    \"9-1\": \"string\",\n    \"9-2\": \"Enter the ending date for querying tasks that ended until a specified date.\",\n    \"10-0\": \"`offset`\",\n    \"10-1\": \"integer\",\n    \"10-2\": \"The zero-based starting index in the entire collection of the first item to return. The default value is 0. This is a [pagination-specific attribute](doc:the-cgc-api#section-response-pagination).\",\n    \"11-0\": \"`limit`\",\n    \"11-1\": \"integer\",\n    \"11-2\": \"The maximum number of collection items to return for a single request. Minimum value is 1. The maximum value is 100 and the default value is 25. This is a [pagination-specific ](doc:the-cgc-api#section-response-pagination)attribute.\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\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://cgc-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://cgc-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 CGC-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://cgc-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]","updates":[],"order":75,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56328f148c9cda0d002526ad","category":{"sync":{"isSync":false,"url":""},"pages":["56312d239ead230d00a188f2","56312e0d82d96a0d00b0fb08","56315777fc94aa0d00e9b553","56315b779ead230d00a1894a","5631657c9c25801700dac34f","56317884fc94aa0d00e9b586","56318386c3b04b0d00ba9bb9","563240ccdcc27a170082363b","563240dfbddb091700ad5e82","563240edfe9acd1900cc1d10","56324504fa40240d007c8d5f","56324b30c3b04b0d00ba9c96","563273ae45f2cb0d006be3fa","563273c08c9cda0d0025266d","563273cc38f8aa0d00d30f55","563273d838f8aa0d00d30f59","5632740945f2cb0d006be3fc","56327411df556c0d00cd0905","5632741b8c9cda0d0025266f","563274ea10b6040d008793d8","5632757cdf556c0d00cd0908","563275b710b6040d008793da","563275f938f8aa0d00d30f60","5632762fb904a10d0032f6fc","5632767110b6040d008793dd","563276c0b904a10d0032f700","5632770162c48a0d00334d53","5632843d8c9cda0d00252698","5632846e62c48a0d00334d78","56328a7e49e16d0d00122420","56328aaf49e16d0d00122425","56328b2238f8aa0d00d30f88","56328b6c8c9cda0d002526a2","56328c0710b6040d008793ff","56328c3710b6040d00879401","56328c5938f8aa0d00d30f8c","56328c90b904a10d0032f722","56328cc449e16d0d0012242a","56328ce68c9cda0d002526a8","56328d1338f8aa0d00d30f8e","56328d5810b6040d00879407","56328d7cdf556c0d00cd092f","56328d9a10b6040d00879409","56328db438f8aa0d00d30f92","56328dd762c48a0d00334d8b","56328df649e16d0d0012242d","56328e1edf556c0d00cd0931","56328e4662c48a0d00334d8e","56328e5edf556c0d00cd0933","56328e8f8c9cda0d002526ab","56328eb3b904a10d0032f72a","56328edb38f8aa0d00d30f95","56328ef210b6040d0087940d","56328f148c9cda0d002526ad","56328f2962c48a0d00334d90","56328f54b904a10d0032f72c","56328f6c38f8aa0d00d30f98","56328f858c9cda0d002526af","56328fae62c48a0d00334d95","56328fd838f8aa0d00d30f9c","5637f069ee0ee60d0024ec18","5641ffaa9417b40d00c0fc35","564355240d9748190079dea9","5644cfeb2c74cf1900da4831","56450f856b0ca50d00f6bd8f","56706537cbb2fb0d00f7c7dd","567065bc3d29830d00376213","56706fc2cbb2fb0d00f7c87e","568bf5a1e662f40d00eee866","568c0699e662f40d00eee881","568cff0274c77f2d00d56d51","568d10f58602880d001ce277","568d2abc37b636250036b904","568d343413c5ad0d00b34efb","568d593a8602880d001ce2d3","568e64135e12fb0d00325160","568e66f05e12fb0d00325162","568e78aa5e12fb0d0032517a","569433cfd8c04d1700e5ae0c","56943723d8c04d1700e5ae14","5694393b3e9d080d00f0655d","5694e6cf953b810d008f91bc","5694f301c5c5ce0d00058e68","569502ef9797fa1900f704e7","5695063bcaa32519009c40b3","569511cccaa32519009c40d9","569557e2fcb1032d0089dfe2","569562fefcb1032d0089dfee","56956428fe18811700c9c058","569639b87596a90d0014e5a3","56a90197e590350d004b5103","56a9021e9ec7660d002e08c2"],"title":"API Reference","slug":"api","order":32,"from_sync":false,"reference":true,"_id":"55faf9aa17b9d00d00969f49","project":"55faf11ba62ba1170021a9a7","createdAt":"2015-09-17T17:34:34.937Z","version":"55faf11ba62ba1170021a9aa","__v":92},"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f","5c222bed4bc358002f21459a","5c22412594a2a5005cc9e919","5c41ae1c33592700190a291e","5c8a525e2ba7b2003f9b153c","5cbf14d58c79c700ef2b502e","5db6f03a6e187c006f667fa4"],"_id":"55faf11ba62ba1170021a9aa","releaseDate":"2015-09-17T16:58:03.490Z","createdAt":"2015-09-17T16:58:03.490Z","project":"55faf11ba62ba1170021a9a7","__v":46},"user":"554340dfb7f4540d00fcef1d","__v":12,"githubsync":"","parentDoc":null,"createdAt":"2015-10-29T21:26:44.244Z","project":"55faf11ba62ba1170021a9a7"}