{"_id":"5be198d144baa800138e68b9","project":"5773dcfc255e820e00e1cd4d","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"},"category":{"_id":"5ad5eab10a46a3000376af1f","project":"5773dcfc255e820e00e1cd4d","version":"5773dcfc255e820e00e1cd50","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-04-17T12:38:09.296Z","from_sync":false,"order":15,"slug":"bulk-api-actions","title":"BULK API ACTIONS"},"user":"566590c83889610d0008a253","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-11-06T13:36:17.716Z","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://cavatica-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: cavatica-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 Cavatica [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 Cavatica-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://cavatica-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://cavatica-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://cavatica-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: cavatica-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 Cavatica [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 Cavatica-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://cavatica-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://cavatica-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]