{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"Get details of a bulk DRS import job","type":"endpoint","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://cgc-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: cgc-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://cgc-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 CGC [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 CGC-specific 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://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://cgc-api.sbgenomics.com/v2/bulk/drs/imports/154608246075330560\\\",\\n    \\\"id\\\": \\\"154608246075330560\\\",\\n    \\\"result\\\": [\\n        {\\n            \\\"resource\\\": {\\n                \\\"href\\\": \\\"https://cgc-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":"6140835bf30ef400187e1b85","createdAt":"2021-09-14T11:11:23.634Z","user":"5767bc73bb15f40e00a28777","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"DRS API","slug":"drs-api","order":38,"from_sync":false,"reference":false,"_id":"5db6f03a6e187c006f667fa4","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","createdAt":"2019-10-28T13:42:18.754Z","__v":0},"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","5f894c7d3b0894006477ca01"],"_id":"55faf11ba62ba1170021a9aa","releaseDate":"2015-09-17T16:58:03.490Z","createdAt":"2015-09-17T16:58:03.490Z","project":"55faf11ba62ba1170021a9a7","__v":47},"project":"55faf11ba62ba1170021a9a7","__v":0}

getGet 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://cgc-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: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ae5426ea8f1273259740f74", "language": "http", "name": null }, { "code": "curl -X GET -H \"X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\" 'https://cgc-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 CGC [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 CGC-specific 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://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://cgc-api.sbgenomics.com/v2/bulk/drs/imports/154608246075330560\",\n \"id\": \"154608246075330560\",\n \"result\": [\n {\n \"resource\": {\n \"href\": \"https://cgc-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]