{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Get details of a bulk DRS import job","type":"basic","slug":"get-details-of-a-bulk-drs-import-job","excerpt":"","body":"This API call lets you get details of a bulk file import job done through the [Data Repository Service (DRS)](doc:drs-api-overview).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/bulk/drs/imports/{import_id}\",\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/bulk/drs/imports/154608246075330560 HTTP/1.1\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ae5426ea8f1273259740f74\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -X GET -H \\\"X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\\" 'https://cavatica-api.sbgenomics.com/v2/bulk/drs/imports/154608246075330560 HTTP/1.1'\",\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\": \"Key\",\n    \"h-1\": \"Description of value\",\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###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`import_id`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"ID of the job for which you want to get import information. ID is returned when [creating a bulk DRS import job](doc:start-a-bulk-drs-import-job).\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n##Response\n\n[See a list of response codes that may be contained in the body of the response](doc:api-status-codes).\n\n###Response body\n\nThe response object contains the link for downloading the file.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`href`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"URI of this import job, for example `https://cavatica-api.sbgenomics.com/v2/async/files/import/436242183587799`.\",\n    \"1-0\": \"`id`\",\n    \"2-0\": \"`result`\",\n    \"3-0\": \"`started_on`\",\n    \"4-0\": \"`finished_on`\",\n    \"5-0\": \"`state`\",\n    \"1-1\": \"String\",\n    \"3-1\": \"String\",\n    \"4-1\": \"String\",\n    \"5-1\": \"String\",\n    \"2-1\": \"Array\",\n    \"1-2\": \"ID of the import job.\",\n    \"2-2\": \"Files and errors for each of the items in the bulk import job.\",\n    \"3-2\": \"Date and time when the import job started.\",\n    \"4-2\": \"Date and time when the import job ended.\",\n    \"5-2\": \"Current state of the import job. Available values:\\n  * `SUBMITTED`\\n  * `RESOLVING`\\n  * `RUNNING`\\n  * `FINISHED`\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/bulk/drs/imports/154608246075330560\\\",\\n    \\\"id\\\": \\\"154608246075330560\\\",\\n    \\\"result\\\": [\\n        {\\n            \\\"resource\\\": {\\n                \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/files/6130ac6485ecd250bb0c4fed\\\",\\n                \\\"id\\\": \\\"6130ac6485ecd250bb0c4fed\\\"\\n            }\\n        }\\n    ],\\n    \\\"state\\\": \\\"FINISHED\\\",\\n    \\\"started_on\\\": \\\"2021-09-14T14:06:27Z\\\",\\n    \\\"finished_on\\\": \\\"2021-09-14T14:06:28Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example response body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","updates":[],"order":999,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"615eef31be99d20356af43d0","createdAt":"2021-10-07T12:59:29.950Z","user":"5dbff97bc91e080029778657","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"DRS API","slug":"drs-api","order":28,"from_sync":false,"reference":false,"_id":"5dc15666a4f788004c5fd7d7","project":"5773dcfc255e820e00e1cd4d","version":"5773dcfc255e820e00e1cd50","createdAt":"2019-11-05T11:00:54.262Z","__v":0},"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"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","5dc15666a4f788004c5fd7d7","5eaff69e844d67003642a020","5eb00899b36ba5002d35b0c1","5eb0172be179b70073dc936e","5eb01b42b36ba5002d35ebba","5eb01f202654a20136813093","5eb918ef149186021c9a76c8","5f0839d3f4b24e005ebbbc29","5f893e508c9862002d0614a9","6024033e2b2f6f004dfe994c","60a7a12f9a06c70052b7c4db","60a7ab97266a4700161507c4","60b0c84babba720010a8b0b5"],"_id":"5773dcfc255e820e00e1cd50","__v":39,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"project":"5773dcfc255e820e00e1cd4d","__v":0,"parentDoc":null}

Get details of a bulk DRS import job


This API call lets you get details of a bulk file import job done through the [Data Repository Service (DRS)](doc:drs-api-overview). [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/bulk/drs/imports/{import_id}", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET v2/bulk/drs/imports/154608246075330560 HTTP/1.1\nHost: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ae5426ea8f1273259740f74", "language": "http", "name": null }, { "code": "curl -X GET -H \"X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\" 'https://cavatica-api.sbgenomics.com/v2/bulk/drs/imports/154608246075330560 HTTP/1.1'", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Key", "h-1": "Description of value", "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] ###Path parameters [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-0": "`import_id`", "0-1": "String", "0-2": "ID of the job for which you want to get import information. ID is returned when [creating a bulk DRS import job](doc:start-a-bulk-drs-import-job)." }, "cols": 3, "rows": 1 } [/block] ##Response [See a list of response codes that may be contained in the body of the response](doc:api-status-codes). ###Response body The response object contains the link for downloading the file. [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-0": "`href`", "0-1": "String", "0-2": "URI of this import job, for example `https://cavatica-api.sbgenomics.com/v2/async/files/import/436242183587799`.", "1-0": "`id`", "2-0": "`result`", "3-0": "`started_on`", "4-0": "`finished_on`", "5-0": "`state`", "1-1": "String", "3-1": "String", "4-1": "String", "5-1": "String", "2-1": "Array", "1-2": "ID of the import job.", "2-2": "Files and errors for each of the items in the bulk import job.", "3-2": "Date and time when the import job started.", "4-2": "Date and time when the import job ended.", "5-2": "Current state of the import job. Available values:\n * `SUBMITTED`\n * `RESOLVING`\n * `RUNNING`\n * `FINISHED`" }, "cols": 3, "rows": 6 } [/block] ###Example response body [block:code] { "codes": [ { "code": "{\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/bulk/drs/imports/154608246075330560\",\n \"id\": \"154608246075330560\",\n \"result\": [\n {\n \"resource\": {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/files/6130ac6485ecd250bb0c4fed\",\n \"id\": \"6130ac6485ecd250bb0c4fed\"\n }\n }\n ],\n \"state\": \"FINISHED\",\n \"started_on\": \"2021-09-14T14:06:27Z\",\n \"finished_on\": \"2021-09-14T14:06:28Z\"\n}", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]