{"_id":"5c8a72d0b84fd6005723be9f","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":"5c8a68278e883901341de571","project":"5773dcfc255e820e00e1cd4d","version":"5773dcfc255e820e00e1cd50","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2019-03-14T14:41:43.757Z","from_sync":false,"order":16,"slug":"async-bulk-actions","title":"ASYNC BULK ACTIONS"},"user":"566590c83889610d0008a253","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-03-14T15:27:12.640Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"This call gets the details for all asynchronous bulk jobs you have started. This information will be available for up to a month after the job has been completed.\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/async/files\\n\",\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\": \"GET /v2/async/files\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5336ea8f1253259740f75\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -X GET \\\\\\n  https://cgc-api.sbgenomics.com/v2/async/files\\n  -H 'Content-Type: application/json' \\\\\\n  -H 'X-SBG-Auth-Token: d32c2976ffc04d0eb90c6c4fb4c0a465' \\\\\",\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### Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`offset`\",\n    \"0-1\": \"integer\",\n    \"0-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.\",\n    \"1-0\": \"`limit`\",\n    \"1-1\": \"integer\",\n    \"1-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 attribute.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\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\n## Response body\n\nThe response body will contain information for each of the jobs.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`id`\",\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"string\",\n    \"0-2\": \"ID of the job.\",\n    \"1-0\": \"`result`\",\n    \"1-1\": \"string\",\n    \"1-2\": \"The result of the job.\",\n    \"2-0\": \"`type`\",\n    \"2-1\": \"string\",\n    \"2-2\": \"The type of job.\",\n    \"3-0\": \"`state`\",\n    \"3-1\": \"string\",\n    \"3-2\": \"The following states are available:\\n\\nSUBMITTED\\nRESOLVING\\nRUNNING\\nFINISHED\",\n    \"4-0\": \"`failed_files`\",\n    \"5-0\": \"`completed_files`\",\n    \"6-0\": \"`total_files`\",\n    \"4-1\": \"string\",\n    \"5-1\": \"string\",\n    \"6-1\": \"string\",\n    \"4-2\": \"The number of files that failed.\",\n    \"5-2\": \"The number of files that were successfully completed.\",\n    \"6-2\": \"The total number of files that were processed for the job.\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n\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{\\n    \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/async/files?offset=0&limit=13\\\",\\n    \\\"items\\\": [\\n        {\\n            \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/async/files/copy/70711174378885120\\\",\\n            \\\"id\\\": \\\"70711174378885120\\\",\\n            \\\"result\\\": [\\n                {\\n                    \\\"resource\\\": {\\n                        \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/files/5c6d4227e4b0385632389346\\\",\\n                        \\\"id\\\": \\\"5c6d4227e4b0385632389346\\\"\\n                    }\\n                }\\n            ],\\n            \\\"type\\\": \\\"COPY\\\",\\n            \\\"state\\\": \\\"FINISHED\\\",\\n            \\\"failed_files\\\": 0,\\n            \\\"completed_files\\\": 1,\\n            \\\"total_files\\\": 1,\\n            \\\"started_on\\\": \\\"2019-02-20T12:03:50Z\\\",\\n            \\\"finished_on\\\": \\\"2019-02-20T12:03:51Z\\\"\\n        },\\n        {\\n            \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/async/files/copy/70714896400060416\\\",\\n            \\\"id\\\": \\\"70714896400060416\\\",\\n            \\\"result\\\": [\\n                {\\n                    \\\"resource\\\": {\\n                        \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/files/5c6d5004e4b03856323893bb\\\",\\n                        \\\"id\\\": \\\"5c6d5004e4b03856323893bb\\\"\\n                    }\\n                },\\n                {\\n                    \\\"resource\\\": {\\n                        \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/files/5c6d5004e4b03856323893bc\\\",\\n                        \\\"id\\\": \\\"5c6d5004e4b03856323893bc\\\"\\n                    }\\n                },\\n                {\\n                    \\\"resource\\\": {\\n                        \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/files/5c6d5004e4b03856323893ba\\\",\\n                        \\\"id\\\": \\\"5c6d5004e4b03856323893ba\\\"\\n                    }\\n                }\\n            ],\\n            \\\"type\\\": \\\"COPY\\\",\\n            \\\"state\\\": \\\"FINISHED\\\",\\n            \\\"failed_files\\\": 0,\\n            \\\"completed_files\\\": 3,\\n            \\\"total_files\\\": 3,\\n            \\\"started_on\\\": \\\"2019-02-20T13:03:00Z\\\",\\n            \\\"finished_on\\\": \\\"2019-02-20T13:03:00Z\\\"\\n        },\\n        {\\n            \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/async/files/copy/70714077692891136\\\",\\n            \\\"id\\\": \\\"70714077692891136\\\",\\n            \\\"result\\\": [\\n                {\\n                    \\\"resource\\\": {\\n                        \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/files/5c6d4cf7e4b0385632389392\\\",\\n                        \\\"id\\\": \\\"5c6d4cf7e4b0385632389392\\\"\\n                    }\\n                },\\n                {\\n                    \\\"resource\\\": {\\n                        \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/files/5c6d4cf7e4b0385632389391\\\",\\n                        \\\"id\\\": \\\"5c6d4cf7e4b0385632389391\\\"\\n                    }\\n                }\\n            ],\\n            \\\"type\\\": \\\"COPY\\\",\\n            \\\"state\\\": \\\"FINISHED\\\",\\n            \\\"failed_files\\\": 0,\\n            \\\"completed_files\\\": 3,\\n            \\\"total_files\\\": 3,\\n            \\\"started_on\\\": \\\"2019-02-20T12:49:59Z\\\",\\n            \\\"finished_on\\\": \\\"2019-02-20T12:49:59Z\\\"\\n       }\\n    ],\\n    \\\"links\\\": []\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example response body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"get-details-of-all-async-jobs","type":"basic","title":"Get details of all async jobs"}

Get details of all async jobs


This call gets the details for all asynchronous bulk jobs you have started. This information will be available for up to a month after the job has been completed. [block:api-header] { "type": "basic", "title": "Request" } [/block] [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/async/files\n", "language": "text", "name": "Path" } ] } [/block] [block:api-header] { "type": "basic", "title": "Example request", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "GET /v2/async/files\nHost: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5336ea8f1253259740f75", "language": "http", "name": null }, { "code": "curl -X GET \\\n https://cgc-api.sbgenomics.com/v2/async/files\n -H 'Content-Type: application/json' \\\n -H 'X-SBG-Auth-Token: d32c2976ffc04d0eb90c6c4fb4c0a465' \\", "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] ### Query parameters [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-0": "`offset`", "0-1": "integer", "0-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.", "1-0": "`limit`", "1-1": "integer", "1-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 attribute." }, "cols": 3, "rows": 2 } [/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) ## Response body The response body will contain information for each of the jobs. [block:parameters] { "data": { "0-0": "`id`", "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-1": "string", "0-2": "ID of the job.", "1-0": "`result`", "1-1": "string", "1-2": "The result of the job.", "2-0": "`type`", "2-1": "string", "2-2": "The type of job.", "3-0": "`state`", "3-1": "string", "3-2": "The following states are available:\n\nSUBMITTED\nRESOLVING\nRUNNING\nFINISHED", "4-0": "`failed_files`", "5-0": "`completed_files`", "6-0": "`total_files`", "4-1": "string", "5-1": "string", "6-1": "string", "4-2": "The number of files that failed.", "5-2": "The number of files that were successfully completed.", "6-2": "The total number of files that were processed for the job." }, "cols": 3, "rows": 7 } [/block] [block:api-header] { "type": "basic", "title": "Example response body", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "\n{\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/async/files?offset=0&limit=13\",\n \"items\": [\n {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/async/files/copy/70711174378885120\",\n \"id\": \"70711174378885120\",\n \"result\": [\n {\n \"resource\": {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/files/5c6d4227e4b0385632389346\",\n \"id\": \"5c6d4227e4b0385632389346\"\n }\n }\n ],\n \"type\": \"COPY\",\n \"state\": \"FINISHED\",\n \"failed_files\": 0,\n \"completed_files\": 1,\n \"total_files\": 1,\n \"started_on\": \"2019-02-20T12:03:50Z\",\n \"finished_on\": \"2019-02-20T12:03:51Z\"\n },\n {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/async/files/copy/70714896400060416\",\n \"id\": \"70714896400060416\",\n \"result\": [\n {\n \"resource\": {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/files/5c6d5004e4b03856323893bb\",\n \"id\": \"5c6d5004e4b03856323893bb\"\n }\n },\n {\n \"resource\": {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/files/5c6d5004e4b03856323893bc\",\n \"id\": \"5c6d5004e4b03856323893bc\"\n }\n },\n {\n \"resource\": {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/files/5c6d5004e4b03856323893ba\",\n \"id\": \"5c6d5004e4b03856323893ba\"\n }\n }\n ],\n \"type\": \"COPY\",\n \"state\": \"FINISHED\",\n \"failed_files\": 0,\n \"completed_files\": 3,\n \"total_files\": 3,\n \"started_on\": \"2019-02-20T13:03:00Z\",\n \"finished_on\": \"2019-02-20T13:03:00Z\"\n },\n {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/async/files/copy/70714077692891136\",\n \"id\": \"70714077692891136\",\n \"result\": [\n {\n \"resource\": {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/files/5c6d4cf7e4b0385632389392\",\n \"id\": \"5c6d4cf7e4b0385632389392\"\n }\n },\n {\n \"resource\": {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/files/5c6d4cf7e4b0385632389391\",\n \"id\": \"5c6d4cf7e4b0385632389391\"\n }\n }\n ],\n \"type\": \"COPY\",\n \"state\": \"FINISHED\",\n \"failed_files\": 0,\n \"completed_files\": 3,\n \"total_files\": 3,\n \"started_on\": \"2019-02-20T12:49:59Z\",\n \"finished_on\": \"2019-02-20T12:49:59Z\"\n }\n ],\n \"links\": []\n}", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]