{"_id":"5be196ef980bff0025f192b2","project":"55faf11ba62ba1170021a9a7","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":40,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5ad5d392af566800032a8107","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-04-17T10:59:30.322Z","from_sync":false,"order":32,"slug":"bulk-actions","title":"BULK API ACTIONS"},"user":"566590c83889610d0008a253","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-11-06T13:28:15.990Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":9,"body":"This call will return statistics for all specified tasks i.e. task IDs.\n\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://cgc-api.sbgenomics.com/v2/bulk/tasks/get\",\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/bulk/tasks/get\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: e5030ffa-9c6a-4464-9a1a-ab003acb05e1\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -X POST \\\\\\n  https://api.sbgenomics.com/v2/bulk/tasks/get \\\\\\n  -H 'Content-Type: application/json' \\\\\\n  -H 'Postman-Token: e5030ffa-9c6a-4464-9a1a-ab003acb05e1' \\\\\\n  -H 'X-SBG-Auth-Token: 4459c50e1ac9416ea8f5263279340f74' \\\\\\n  -H 'cache-control: no-cache' \\\\\\n  -d '{\\n\\t\\\"task_ids\\\": [\\n\\t\\t\\\"49a218ef-066f-4c1c-8f91-5bcdbc15b9e5\\\", \\\"2bc5ce5e-f109-416e-b4b8-7e824f258cb1\\\"\\n\\t]\\n}\\n'\",\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    \"1-0\": \" Content-Type\\n*required* \",\n    \"1-1\": \"`application/json`\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n###Request body\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`task_id`\",\n    \"0-1\": \"array\",\n    \"0-2\": \"The IDs of the tasks you are requesting the statistics for.\"\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 CGC-specific response codes that may be contained in the body of the response.](ref:api-status-codes).\n[block:api-header]\n{\n  \"title\": \"Response body\"\n}\n[/block]\nThe response contains statistics for all specified tasks.\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    \\\"items\\\": [\\n        {\\n            \\\"resource\\\": {\\n                \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/tasks/49a128ef-066f-4c1c-8f91-5bcdbc15b9e5\\\",\\n                \\\"id\\\": \\\"49a228ef-066f-4c1c-8f91-5bcdbc15b8e5\\\",\\n                \\\"name\\\": \\\"star index and align run - 08-11-15 16:28:02\\\",\\n                \\\"status\\\": \\\"ABORTED\\\",\\n                \\\"project\\\": \\\"rfranklin/star-dev\\\",\\n                \\\"app\\\": \\\"rfranklin/star-dev/star-index-and-align/1\\\",\\n                \\\"type\\\": \\\"v2\\\",\\n                \\\"created_by\\\": \\\"rfranklin\\\",\\n                \\\"executed_by\\\": \\\"rfranklin\\\",\\n                \\\"start_time\\\": \\\"2015-08-11T16:28:02Z\\\",\\n                \\\"end_time\\\": \\\"2015-08-12T11:43:00Z\\\",\\n                \\\"batch\\\": false,\\n                \\\"batch_group\\\": {\\n                    \\\"fields\\\": {}\\n                },\\n                \\\"use_interruptible_instances\\\": false,\\n                \\\"execution_settings\\\": {},\\n                \\\"execution_status\\\": {\\n                    \\\"steps_completed\\\": 0,\\n                    \\\"steps_total\\\": 0,\\n                    \\\"system_limit\\\": false,\\n                    \\\"account_limit\\\": false,\\n                    \\\"instance_init\\\": false,\\n                    \\\"queued_duration\\\": 0,\\n                    \\\"running_duration\\\": 69111383,\\n                    \\\"execution_duration\\\": 0,\\n                    \\\"duration\\\": 69111383\\n                },\\n                \\\"errors\\\": [],\\n                \\\"warnings\\\": [],\\n                \\\"inputs\\\": {},\\n                \\\"outputs\\\": {},\\n                \\\"created_time\\\": \\\"2015-08-11T16:28:02Z\\\"\\n            }\\n        },\\n        {\\n            \\\"resource\\\": {\\n                \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/tasks/2cb5ce5e-f109-416e-b4b8-7e824f258cb1\\\",\\n                \\\"id\\\": \\\"2bb5ce5e-f109-416e-b3b8-7e824f258cb1\\\",\\n                \\\"name\\\": \\\"star index and align run - 08-12-15 11:32:39\\\",\\n                \\\"status\\\": \\\"FAILED\\\",\\n                \\\"project\\\": \\\"rfranklin/star-dev\\\",\\n                \\\"app\\\": \\\"rfranklin/star-dev/star-index-and-align/1\\\",\\n                \\\"type\\\": \\\"v2\\\",\\n                \\\"created_by\\\": \\\"rfranklin\\\",\\n                \\\"executed_by\\\": \\\"rfranklin\\\",\\n                \\\"start_time\\\": \\\"2015-08-12T11:32:39Z\\\",\\n                \\\"end_time\\\": \\\"2015-08-12T11:41:05Z\\\",\\n                \\\"batch\\\": false,\\n                \\\"batch_group\\\": {\\n                    \\\"fields\\\": {}\\n                },\\n                \\\"use_interruptible_instances\\\": false,\\n                \\\"execution_settings\\\": {},\\n                \\\"execution_status\\\": {\\n                    \\\"steps_completed\\\": 0,\\n                    \\\"steps_total\\\": 0,\\n                    \\\"system_limit\\\": false,\\n                    \\\"account_limit\\\": false,\\n                    \\\"instance_init\\\": false,\\n                    \\\"queued_duration\\\": 0,\\n                    \\\"running_duration\\\": 497286,\\n                    \\\"execution_duration\\\": 0,\\n                    \\\"duration\\\": 497286\\n                },\\n                \\\"errors\\\": [],\\n                \\\"warnings\\\": [],\\n                \\\"inputs\\\": {},\\n                \\\"outputs\\\": {},\\n                \\\"created_time\\\": \\\"2015-08-12T11:32:39Z\\\"\\n            }\\n        }\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example response body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"get-statistics-of-multiple-tasks","type":"endpoint","title":"Get statistics of multiple tasks"}

postGet statistics of multiple tasks


This call will return statistics for all specified tasks i.e. task IDs. [block:api-header] { "type": "basic", "title": "Request" } [/block] [block:code] { "codes": [ { "code": "https://cgc-api.sbgenomics.com/v2/bulk/tasks/get", "language": "text", "name": "Path" } ] } [/block] [block:api-header] { "type": "basic", "title": "Example request", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "POST v2/bulk/tasks/get\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: e5030ffa-9c6a-4464-9a1a-ab003acb05e1", "language": "http", "name": null }, { "code": "curl -X POST \\\n https://api.sbgenomics.com/v2/bulk/tasks/get \\\n -H 'Content-Type: application/json' \\\n -H 'Postman-Token: e5030ffa-9c6a-4464-9a1a-ab003acb05e1' \\\n -H 'X-SBG-Auth-Token: 4459c50e1ac9416ea8f5263279340f74' \\\n -H 'cache-control: no-cache' \\\n -d '{\n\t\"task_ids\": [\n\t\t\"49a218ef-066f-4c1c-8f91-5bcdbc15b9e5\", \"2bc5ce5e-f109-416e-b4b8-7e824f258cb1\"\n\t]\n}\n'", "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 CGC [authentication token](doc:get-your-authentication-token).", "h-2": "", "1-0": " Content-Type\n*required* ", "1-1": "`application/json`" }, "cols": 2, "rows": 2 } [/block] ###Request body [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-0": "`task_id`", "0-1": "array", "0-2": "The IDs of the tasks you are requesting the statistics for." }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Response" } [/block] [See a list of CGC-specific response codes that may be contained in the body of the response.](ref:api-status-codes). [block:api-header] { "title": "Response body" } [/block] The response contains statistics for all specified tasks. [block:api-header] { "type": "basic", "title": "Example response body", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"items\": [\n {\n \"resource\": {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/tasks/49a128ef-066f-4c1c-8f91-5bcdbc15b9e5\",\n \"id\": \"49a228ef-066f-4c1c-8f91-5bcdbc15b8e5\",\n \"name\": \"star index and align run - 08-11-15 16:28:02\",\n \"status\": \"ABORTED\",\n \"project\": \"rfranklin/star-dev\",\n \"app\": \"rfranklin/star-dev/star-index-and-align/1\",\n \"type\": \"v2\",\n \"created_by\": \"rfranklin\",\n \"executed_by\": \"rfranklin\",\n \"start_time\": \"2015-08-11T16:28:02Z\",\n \"end_time\": \"2015-08-12T11:43:00Z\",\n \"batch\": false,\n \"batch_group\": {\n \"fields\": {}\n },\n \"use_interruptible_instances\": false,\n \"execution_settings\": {},\n \"execution_status\": {\n \"steps_completed\": 0,\n \"steps_total\": 0,\n \"system_limit\": false,\n \"account_limit\": false,\n \"instance_init\": false,\n \"queued_duration\": 0,\n \"running_duration\": 69111383,\n \"execution_duration\": 0,\n \"duration\": 69111383\n },\n \"errors\": [],\n \"warnings\": [],\n \"inputs\": {},\n \"outputs\": {},\n \"created_time\": \"2015-08-11T16:28:02Z\"\n }\n },\n {\n \"resource\": {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/tasks/2cb5ce5e-f109-416e-b4b8-7e824f258cb1\",\n \"id\": \"2bb5ce5e-f109-416e-b3b8-7e824f258cb1\",\n \"name\": \"star index and align run - 08-12-15 11:32:39\",\n \"status\": \"FAILED\",\n \"project\": \"rfranklin/star-dev\",\n \"app\": \"rfranklin/star-dev/star-index-and-align/1\",\n \"type\": \"v2\",\n \"created_by\": \"rfranklin\",\n \"executed_by\": \"rfranklin\",\n \"start_time\": \"2015-08-12T11:32:39Z\",\n \"end_time\": \"2015-08-12T11:41:05Z\",\n \"batch\": false,\n \"batch_group\": {\n \"fields\": {}\n },\n \"use_interruptible_instances\": false,\n \"execution_settings\": {},\n \"execution_status\": {\n \"steps_completed\": 0,\n \"steps_total\": 0,\n \"system_limit\": false,\n \"account_limit\": false,\n \"instance_init\": false,\n \"queued_duration\": 0,\n \"running_duration\": 497286,\n \"execution_duration\": 0,\n \"duration\": 497286\n },\n \"errors\": [],\n \"warnings\": [],\n \"inputs\": {},\n \"outputs\": {},\n \"created_time\": \"2015-08-12T11:32:39Z\"\n }\n }\n ]\n}", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]