{"__v":3,"_id":"57856a8fce05c019001afc2d","category":{"__v":92,"_id":"55faf9aa17b9d00d00969f49","pages":["56312d239ead230d00a188f2","56312e0d82d96a0d00b0fb08","56315777fc94aa0d00e9b553","56315b779ead230d00a1894a","5631657c9c25801700dac34f","56317884fc94aa0d00e9b586","56318386c3b04b0d00ba9bb9","563240ccdcc27a170082363b","563240dfbddb091700ad5e82","563240edfe9acd1900cc1d10","56324504fa40240d007c8d5f","56324b30c3b04b0d00ba9c96","563273ae45f2cb0d006be3fa","563273c08c9cda0d0025266d","563273cc38f8aa0d00d30f55","563273d838f8aa0d00d30f59","5632740945f2cb0d006be3fc","56327411df556c0d00cd0905","5632741b8c9cda0d0025266f","563274ea10b6040d008793d8","5632757cdf556c0d00cd0908","563275b710b6040d008793da","563275f938f8aa0d00d30f60","5632762fb904a10d0032f6fc","5632767110b6040d008793dd","563276c0b904a10d0032f700","5632770162c48a0d00334d53","5632843d8c9cda0d00252698","5632846e62c48a0d00334d78","56328a7e49e16d0d00122420","56328aaf49e16d0d00122425","56328b2238f8aa0d00d30f88","56328b6c8c9cda0d002526a2","56328c0710b6040d008793ff","56328c3710b6040d00879401","56328c5938f8aa0d00d30f8c","56328c90b904a10d0032f722","56328cc449e16d0d0012242a","56328ce68c9cda0d002526a8","56328d1338f8aa0d00d30f8e","56328d5810b6040d00879407","56328d7cdf556c0d00cd092f","56328d9a10b6040d00879409","56328db438f8aa0d00d30f92","56328dd762c48a0d00334d8b","56328df649e16d0d0012242d","56328e1edf556c0d00cd0931","56328e4662c48a0d00334d8e","56328e5edf556c0d00cd0933","56328e8f8c9cda0d002526ab","56328eb3b904a10d0032f72a","56328edb38f8aa0d00d30f95","56328ef210b6040d0087940d","56328f148c9cda0d002526ad","56328f2962c48a0d00334d90","56328f54b904a10d0032f72c","56328f6c38f8aa0d00d30f98","56328f858c9cda0d002526af","56328fae62c48a0d00334d95","56328fd838f8aa0d00d30f9c","5637f069ee0ee60d0024ec18","5641ffaa9417b40d00c0fc35","564355240d9748190079dea9","5644cfeb2c74cf1900da4831","56450f856b0ca50d00f6bd8f","56706537cbb2fb0d00f7c7dd","567065bc3d29830d00376213","56706fc2cbb2fb0d00f7c87e","568bf5a1e662f40d00eee866","568c0699e662f40d00eee881","568cff0274c77f2d00d56d51","568d10f58602880d001ce277","568d2abc37b636250036b904","568d343413c5ad0d00b34efb","568d593a8602880d001ce2d3","568e64135e12fb0d00325160","568e66f05e12fb0d00325162","568e78aa5e12fb0d0032517a","569433cfd8c04d1700e5ae0c","56943723d8c04d1700e5ae14","5694393b3e9d080d00f0655d","5694e6cf953b810d008f91bc","5694f301c5c5ce0d00058e68","569502ef9797fa1900f704e7","5695063bcaa32519009c40b3","569511cccaa32519009c40d9","569557e2fcb1032d0089dfe2","569562fefcb1032d0089dfee","56956428fe18811700c9c058","569639b87596a90d0014e5a3","56a90197e590350d004b5103","56a9021e9ec7660d002e08c2"],"project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":26,"slug":"api","title":"API Reference"},"parentDoc":null,"project":"55faf11ba62ba1170021a9a7","user":"5613e4f8fdd08f2b00437620","version":{"__v":37,"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-12T22:09:19.508Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":86,"body":"This call will return the details of an import job. \n\nNote that when you import a file from your volume on your cloud storage provider (Amazon Web Services or Google Cloud Storage), you are creating an alias on the Platform which points to the file in your cloud storage bucket. Aliases appear as files on the Platform and can be copied, executed, and modified as such. They refer back to the respective file on the given volume.\n\nLearn more about using the Volumes API for [Amazon S3](aws-cloud-storage-tutorial) and for [Google Cloud Storage](google-cloud-storage-tutorial).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cgc-api.sbgenomics.com/v2/storage/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/storage/imports/9G2EcQdEDNcfqTQN2NOGoy0pV0uHsDkR HTTP/1.1\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\nContent-Type: application/json\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -s -H \\\"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\\\" -H \\\"Content-Type: application/json\\\" -X GET \\\"https://cgc-api.sbgenomics.com/v2/storage/imports/9G2EcQdEDNcfqTQN2NOGoy0pV0uHsDkR\\\"\",\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    \"1-0\": \"`Content-type`\\n_required_\",\n    \"1-1\": \"`application/json`\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Description of value\",\n    \"h-2\": \"Description of value\",\n    \"0-0\": \"`import_id`\",\n    \"0-1\": \"The ID of the import job as returned by the call to [start an import job](start-an-import-job-v2).\"\n  },\n  \"cols\": 2,\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 information about the status of the import job. The information is structured using the following key-value pairs:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type of value\",\n    \"h-2\": \"Description of value\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"String\",\n    \"1-1\": \"String\",\n    \"1-0\": \"`state`\",\n    \"2-0\": \"`source`\",\n    \"2-1\": \"Object\",\n    \"3-0\": \"`destination`\",\n    \"3-1\": \"Object\",\n    \"4-0\": \"`result`\",\n    \"4-1\": \"Object\",\n    \"5-0\": \"`error`\",\n    \"5-1\": \"Object\",\n    \"0-2\": \"ID of this import job\",\n    \"1-2\": \"The state of this import job. Possible values are:\\n  * `PENDING`: the import is queued;\\n  * `RUNNING`: the import is running;\\n  * `COMPLETED`: the import has completed successfully;\\n  * `FAILED`: the import has failed.\",\n    \"2-2\": \"Import source, as passed when this job was started by the call to [start an import job](doc:start-an-import-job-v2) .\",\n    \"3-2\": \"Import destination, as passed when this job was started by the call to [start an import job](doc:start-an-import-job-v2)\",\n    \"4-2\": \"File object that was [imported](get-file-details).\",\n    \"5-2\": \"In case of error in the import job, standard API error is returned here.\"\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/storage/imports/uWbndWHxUWBrgVE3YK9nAetAsJXxyM78\\\",\\n  \\\"id\\\": \\\"uWbndWHxUWBrgVE3YK9nAetAsJXxyM78\\\",\\n  \\\"state\\\": \\\"COMPLETED\\\",\\n  \\\"overwrite\\\": true,\\n  \\\"source\\\": {\\n    \\\"volume\\\": \\\"rfranklin/input\\\",\\n    \\\"location\\\": \\\"_1_27775714857613d176941a835574167_w640.jpg\\\"\\n  },\\n  \\\"destination\\\": {\\n    \\\"project\\\": \\\"rfranklin/my_project\\\",\\n    \\\"name\\\": \\\"imported.jpg\\\"\\n  },\\n  \\\"result\\\": {\\n    \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/files/576a92eff5b481188f096b64\\\",\\n    \\\"id\\\": \\\"576a92eff5b481188f096b64\\\",\\n    \\\"name\\\": \\\"imported.jpg\\\",\\n    \\\"size\\\": 46102,\\n    \\\"project\\\": \\\"rfranklin/my_project\\\",\\n    \\\"created_on\\\": \\\"2016-06-22T13:30:23Z\\\",\\n    \\\"modified_on\\\": \\\"2016-06-22T13:30:24Z\\\",\\n    \\\"storage\\\": {\\n      \\\"type\\\": \\\"VOLUME\\\",\\n      \\\"volume\\\": \\\"rfranklin/input\\\",\\n      \\\"location\\\": \\\"_1_27775714857613d176941a835574167_w640.jpg\\\"\\n    },\\n    \\\"origin\\\": {}\\n  },\\n  \\\"started_on\\\": \\\"2016-06-22T13:30:23Z\\\",\\n  \\\"finished_on\\\": \\\"2016-06-22T13:30:24Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example response body - successfully completed import\"\n    },\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/storage/imports/1KAWc6h1KEMMMa702FqdGJhp0PIm9AZ3\\\",\\n  \\\"id\\\": \\\"1KAWc6h1KEMMMa702FqdGJhp0PIm9AZ3\\\",\\n  \\\"state\\\": \\\"FAILED\\\",\\n  \\\"overwrite\\\": false,\\n  \\\"source\\\": {\\n    \\\"volume\\\": \\\"rfranklin/input\\\",\\n    \\\"location\\\": \\\"giphy.gif\\\"\\n  },\\n  \\\"destination\\\": {\\n    \\\"project\\\": \\\"rfranklin/my_project\\\",\\n    \\\"name\\\": \\\"giphy.gif\\\"\\n  },\\n  \\\"error\\\": {\\n    \\\"status\\\": 403,\\n    \\\"code\\\": 9103,\\n    \\\"message\\\": \\\"Location on volume is not accessible as configured. See the documentation.\\\",\\n    \\\"more_info\\\": \\\"http://docs.cancergenomicscloud.com/docs/api-status-codes#9103\\\"\\n  },\\n  \\\"started_on\\\": \\\"2016-06-14T14:57:18Z\\\",\\n  \\\"finished_on\\\": \\\"2016-06-14T14:57:19Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example response body - failed import job\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"get-details-of-an-import-job-v2","type":"endpoint","title":"Get details of an import job"}

getGet details of an import job


This call will return the details of an import job. Note that when you import a file from your volume on your cloud storage provider (Amazon Web Services or Google Cloud Storage), you are creating an alias on the Platform which points to the file in your cloud storage bucket. Aliases appear as files on the Platform and can be copied, executed, and modified as such. They refer back to the respective file on the given volume. Learn more about using the Volumes API for [Amazon S3](aws-cloud-storage-tutorial) and for [Google Cloud Storage](google-cloud-storage-tutorial). [block:code] { "codes": [ { "code": "https://cgc-api.sbgenomics.com/v2/storage/imports/{import_id}", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/storage/imports/9G2EcQdEDNcfqTQN2NOGoy0pV0uHsDkR HTTP/1.1\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\nContent-Type: application/json", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\" -H \"Content-Type: application/json\" -X GET \"https://cgc-api.sbgenomics.com/v2/storage/imports/9G2EcQdEDNcfqTQN2NOGoy0pV0uHsDkR\"", "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": "", "1-0": "`Content-type`\n_required_", "1-1": "`application/json`" }, "cols": 2, "rows": 2 } [/block] ###Path parameters [block:parameters] { "data": { "h-0": "Key", "h-1": "Description of value", "h-2": "Description of value", "0-0": "`import_id`", "0-1": "The ID of the import job as returned by the call to [start an import job](start-an-import-job-v2)." }, "cols": 2, "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 information about the status of the import job. The information is structured using the following key-value pairs: [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type of value", "h-2": "Description of value", "0-0": "`id`", "0-1": "String", "1-1": "String", "1-0": "`state`", "2-0": "`source`", "2-1": "Object", "3-0": "`destination`", "3-1": "Object", "4-0": "`result`", "4-1": "Object", "5-0": "`error`", "5-1": "Object", "0-2": "ID of this import job", "1-2": "The state of this import job. Possible values are:\n * `PENDING`: the import is queued;\n * `RUNNING`: the import is running;\n * `COMPLETED`: the import has completed successfully;\n * `FAILED`: the import has failed.", "2-2": "Import source, as passed when this job was started by the call to [start an import job](doc:start-an-import-job-v2) .", "3-2": "Import destination, as passed when this job was started by the call to [start an import job](doc:start-an-import-job-v2)", "4-2": "File object that was [imported](get-file-details).", "5-2": "In case of error in the import job, standard API error is returned here." }, "cols": 3, "rows": 6 } [/block] ###Example response body [block:code] { "codes": [ { "code": "{\n \"href\": \"https://cgc-api.sbgenomics.com/v2/storage/imports/uWbndWHxUWBrgVE3YK9nAetAsJXxyM78\",\n \"id\": \"uWbndWHxUWBrgVE3YK9nAetAsJXxyM78\",\n \"state\": \"COMPLETED\",\n \"overwrite\": true,\n \"source\": {\n \"volume\": \"rfranklin/input\",\n \"location\": \"_1_27775714857613d176941a835574167_w640.jpg\"\n },\n \"destination\": {\n \"project\": \"rfranklin/my_project\",\n \"name\": \"imported.jpg\"\n },\n \"result\": {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/files/576a92eff5b481188f096b64\",\n \"id\": \"576a92eff5b481188f096b64\",\n \"name\": \"imported.jpg\",\n \"size\": 46102,\n \"project\": \"rfranklin/my_project\",\n \"created_on\": \"2016-06-22T13:30:23Z\",\n \"modified_on\": \"2016-06-22T13:30:24Z\",\n \"storage\": {\n \"type\": \"VOLUME\",\n \"volume\": \"rfranklin/input\",\n \"location\": \"_1_27775714857613d176941a835574167_w640.jpg\"\n },\n \"origin\": {}\n },\n \"started_on\": \"2016-06-22T13:30:23Z\",\n \"finished_on\": \"2016-06-22T13:30:24Z\"\n}", "language": "json", "name": "Example response body - successfully completed import" }, { "code": "{\n \"href\": \"https://cgc-api.sbgenomics.com/v2/storage/imports/1KAWc6h1KEMMMa702FqdGJhp0PIm9AZ3\",\n \"id\": \"1KAWc6h1KEMMMa702FqdGJhp0PIm9AZ3\",\n \"state\": \"FAILED\",\n \"overwrite\": false,\n \"source\": {\n \"volume\": \"rfranklin/input\",\n \"location\": \"giphy.gif\"\n },\n \"destination\": {\n \"project\": \"rfranklin/my_project\",\n \"name\": \"giphy.gif\"\n },\n \"error\": {\n \"status\": 403,\n \"code\": 9103,\n \"message\": \"Location on volume is not accessible as configured. See the documentation.\",\n \"more_info\": \"http://docs.cancergenomicscloud.com/docs/api-status-codes#9103\"\n },\n \"started_on\": \"2016-06-14T14:57:18Z\",\n \"finished_on\": \"2016-06-14T14:57:19Z\"\n}", "language": "json", "name": "Example response body - failed import job" } ], "sidebar": true } [/block]