{"_id":"5ad5de183c98570003f5c0ef","project":"55faf11ba62ba1170021a9a7","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":40,"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","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5ad5d392af566800032a8107","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-04-17T10:59:30.322Z","from_sync":false,"order":32,"slug":"bulk-actions","title":"BULK API ACTIONS"},"user":"566590c83889610d0008a253","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-17T11:44:24.127Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"examples":{"codes":[]},"method":"post","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"This call returns the details of a bulk export job.\n\nWhen you export files from a project on CGC into a volume, you write to your cloud storage bucket on Amazon Web Services or Google Cloud Storage. This call obtains the details of that job.\n\nLearn more about using the Volumes API for [Amazon S3](doc:aws-cloud-storage-tutorial) and for [Google Cloud Storage](doc:google-cloud-storage-tutorial).\n\n##Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cgc-api.sbgenomics.com/v2/bulk/storage/export/get\",\n      \"language\": \"json\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST v2/bulk/storage/export/get\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -X POST \\\\\\n  https://cgc-api.sbgenomics.com/v2/bulk/storage/exports/get \\\\\\n  -H 'Cache-Control: no-cache' \\\\\\n  -H 'Content-Type: application/json' \\\\\\n  -H 'X-SBG-Auth-Token: b04aa2a2e98348a1a3a75ca677ea7fd7' \\\\\\n  -d '{\\n    \\\"export_ids\\\": [\\n        \\\"gOM3zcx6CG411ac0SbNkaUE0SNRK4H0S\\\", \\\"YFyyZ7rpCGtXjKTzjGGRJIIAmCd6Mh19\\\"\\n    ]\\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 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###Request body\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`export_ids`\",\n    \"0-1\": \"The IDs of the export job as returned by the call to [start a bulk export job](doc:start-a-bulk-export-job). Separate IDs with a comma.\",\n    \"0-2\": \"This object should describe the source from which the file should be imported.\"\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.](ref:api-status-codes).\n\n###Response body\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"The ID of the particular export job.\",\n    \"1-0\": \"`state`\",\n    \"1-1\": \"string\",\n    \"1-2\": \"The state of this export job. Possible values are:\\n\\n  * `PENDING`: the export is queued\\n  * `RUNNING`: the export is running\\n  * `COMPLETED`: the export has completed successfully\\n  * `FAILED`: the export has failed\",\n    \"2-0\": \"`source`\",\n    \"2-1\": \"object\",\n    \"2-2\": \"Export source, as passed when this job was started by the call to start an export job.\",\n    \"3-0\": \"`destination`\",\n    \"3-1\": \"object\",\n    \"3-2\": \"export destination, as passed when this job was [start an export job](doc:start-an-export-job-v2).\",\n    \"4-0\": \"`result`\",\n    \"4-1\": \"object\",\n    \"4-2\": \"File object that was exported.\",\n    \"5-0\": \"`error`\",\n    \"5-1\": \"object\",\n    \"5-2\": \"In case of error in the export 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    \\\"items\\\": [\\n        {\\n            \\\"resource\\\": {\\n                \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/storage/exports/gOM3zcx6CG411ac0SbNkaUE0SNRK4H0S\\\",\\n                \\\"id\\\": \\\"gOM3zcx6CG411ac0SbNkaUE0SNRK4H0S\\\",\\n                \\\"state\\\": \\\"COMPLETED\\\",\\n                \\\"overwrite\\\": true,\\n                \\\"source\\\": {\\n                    \\\"volume\\\": \\\"rfranklin/input\\\",\\n                    \\\"location\\\": \\\"my_uploaded_example_human_Illumina.pe_1.fastq\\\"\\n                },\\n                \\\"destination\\\": {\\n                    \\\"project\\\": \\\"rfranklin/my_project\\\",\\n                    \\\"name\\\": \\\"example_human_Illumina.pe_1.fastq\\\"\\n                },\\n                \\\"result\\\": {\\n                    \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/files/5aba5c8b1c94b662fa6c2ae4\\\",\\n                    \\\"id\\\": \\\"5aba5c8b1c94b662fa6c2ae4\\\",\\n                    \\\"name\\\": \\\"example_human_Illumina.pe_1.fastq\\\",\\n                    \\\"size\\\": 36433,\\n                    \\\"project\\\": \\\"rfranklin/my-project\\\",\\n                    \\\"created_on\\\": \\\"2018-03-27T15:00:27Z\\\",\\n                    \\\"modified_on\\\": \\\"2018-03-27T15:00:30Z\\\",\\n                    \\\"storage\\\": {\\n                        \\\"type\\\": \\\"VOLUME\\\",\\n                        \\\"volume\\\": \\\"rfranklin/input\\\",\\n                        \\\"location\\\": \\\"example_human_Illumina.pe_1.fastq\\\"\\n                    },\\n                    \\\"origin\\\": {},\\n                    \\\"tags\\\": [],\\n                    \\\"metadata\\\": {}        \\n                },\\n                \\\"finished_on\\\": \\\"2018-03-27T15:00:28Z\\\"\\n            }\\n        },\\n        {\\n            \\\"resource\\\": {\\n                \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/storage/exports/YFyyZ7rpCGtXjKTzjGGRJIIAmCd6Mh19\\\",\\n                \\\"id\\\": \\\"YFyyZ7rpCGtXjKTzjGGRJIIAmCd6Mh19\\\",\\n                \\\"state\\\": \\\"COMPLETED\\\",\\n                \\\"overwrite\\\": true,\\n                \\\"source\\\": {\\n                    \\\"volume\\\": \\\"rfranklin/input\\\",\\n                    \\\"location\\\": \\\"example_human_Illumina.pe_2.fastq\\\"\\n                },\\n                \\\"destination\\\": {\\n                    \\\"project\\\": \\\"rfranklin/my-project\\\",\\n                    \\\"name\\\": \\\"example_human_Illumina.pe_2.fastq\\\"\\n                },\\n                \\\"result\\\": {\\n                    \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/files/5aba5c8b1c94b662fa6c2ae4\\\",\\n                    \\\"id\\\": \\\"5aba5c8b1c94b662fa6c2ae4\\\",\\n                    \\\"name\\\": \\\"example_human_Illumina.pe_2.fastq\\\",\\n                    \\\"size\\\": 36433,\\n                    \\\"project\\\": \\\"rfranklin/my-project\\\",\\n                    \\\"created_on\\\": \\\"2018-03-27T15:00:27Z\\\",\\n                    \\\"modified_on\\\": \\\"2018-03-27T15:00:30Z\\\",\\n                    \\\"storage\\\": {\\n                        \\\"type\\\": \\\"VOLUME\\\",\\n                        \\\"volume\\\": \\\"rfranklin/input\\\",\\n                        \\\"location\\\": \\\"example_human_Illumina.pe_2.fastq\\\"\\n                    },\\n                    \\\"origin\\\": {},\\n                    \\\"tags\\\": [],\\n                    \\\"metadata\\\": {}\\n                },\\n                \\\"finished_on\\\": \\\"2018-03-27T15:00:31Z\\\"\\n            }\\n        }\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example response body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"get-details-of-a-bulk-export-job","type":"endpoint","title":"Get details of a bulk export job"}

postGet details of a bulk export job


This call returns the details of a bulk export job. When you export files from a project on CGC into a volume, you write to your cloud storage bucket on Amazon Web Services or Google Cloud Storage. This call obtains the details of that job. Learn more about using the Volumes API for [Amazon S3](doc:aws-cloud-storage-tutorial) and for [Google Cloud Storage](doc:google-cloud-storage-tutorial). ##Request [block:code] { "codes": [ { "code": "https://cgc-api.sbgenomics.com/v2/bulk/storage/export/get", "language": "json", "name": "Path" } ] } [/block] ###Example request [block:code] { "codes": [ { "code": "POST v2/bulk/storage/export/get\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75", "language": "http", "name": null }, { "code": "curl -X POST \\\n https://cgc-api.sbgenomics.com/v2/bulk/storage/exports/get \\\n -H 'Cache-Control: no-cache' \\\n -H 'Content-Type: application/json' \\\n -H 'X-SBG-Auth-Token: b04aa2a2e98348a1a3a75ca677ea7fd7' \\\n -d '{\n \"export_ids\": [\n \"gOM3zcx6CG411ac0SbNkaUE0SNRK4H0S\", \"YFyyZ7rpCGtXjKTzjGGRJIIAmCd6Mh19\"\n ]\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 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] ###Request body [block:parameters] { "data": { "h-0": "Key", "h-1": "Description", "h-2": "Description", "0-0": "`export_ids`", "0-1": "The IDs of the export job as returned by the call to [start a bulk export job](doc:start-a-bulk-export-job). Separate IDs with a comma.", "0-2": "This object should describe the source from which the file should be imported." }, "cols": 2, "rows": 1 } [/block] ##Response [See a list of CGC-specific response codes that may be contained in the body of the response.](ref:api-status-codes). ###Response body [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-0": "`id`", "0-1": "string", "0-2": "The ID of the particular export job.", "1-0": "`state`", "1-1": "string", "1-2": "The state of this export job. Possible values are:\n\n * `PENDING`: the export is queued\n * `RUNNING`: the export is running\n * `COMPLETED`: the export has completed successfully\n * `FAILED`: the export has failed", "2-0": "`source`", "2-1": "object", "2-2": "Export source, as passed when this job was started by the call to start an export job.", "3-0": "`destination`", "3-1": "object", "3-2": "export destination, as passed when this job was [start an export job](doc:start-an-export-job-v2).", "4-0": "`result`", "4-1": "object", "4-2": "File object that was exported.", "5-0": "`error`", "5-1": "object", "5-2": "In case of error in the export job, standard API error is returned here." }, "cols": 3, "rows": 6 } [/block] ###Example response body [block:code] { "codes": [ { "code": "{\n \"items\": [\n {\n \"resource\": {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/storage/exports/gOM3zcx6CG411ac0SbNkaUE0SNRK4H0S\",\n \"id\": \"gOM3zcx6CG411ac0SbNkaUE0SNRK4H0S\",\n \"state\": \"COMPLETED\",\n \"overwrite\": true,\n \"source\": {\n \"volume\": \"rfranklin/input\",\n \"location\": \"my_uploaded_example_human_Illumina.pe_1.fastq\"\n },\n \"destination\": {\n \"project\": \"rfranklin/my_project\",\n \"name\": \"example_human_Illumina.pe_1.fastq\"\n },\n \"result\": {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/files/5aba5c8b1c94b662fa6c2ae4\",\n \"id\": \"5aba5c8b1c94b662fa6c2ae4\",\n \"name\": \"example_human_Illumina.pe_1.fastq\",\n \"size\": 36433,\n \"project\": \"rfranklin/my-project\",\n \"created_on\": \"2018-03-27T15:00:27Z\",\n \"modified_on\": \"2018-03-27T15:00:30Z\",\n \"storage\": {\n \"type\": \"VOLUME\",\n \"volume\": \"rfranklin/input\",\n \"location\": \"example_human_Illumina.pe_1.fastq\"\n },\n \"origin\": {},\n \"tags\": [],\n \"metadata\": {} \n },\n \"finished_on\": \"2018-03-27T15:00:28Z\"\n }\n },\n {\n \"resource\": {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/storage/exports/YFyyZ7rpCGtXjKTzjGGRJIIAmCd6Mh19\",\n \"id\": \"YFyyZ7rpCGtXjKTzjGGRJIIAmCd6Mh19\",\n \"state\": \"COMPLETED\",\n \"overwrite\": true,\n \"source\": {\n \"volume\": \"rfranklin/input\",\n \"location\": \"example_human_Illumina.pe_2.fastq\"\n },\n \"destination\": {\n \"project\": \"rfranklin/my-project\",\n \"name\": \"example_human_Illumina.pe_2.fastq\"\n },\n \"result\": {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/files/5aba5c8b1c94b662fa6c2ae4\",\n \"id\": \"5aba5c8b1c94b662fa6c2ae4\",\n \"name\": \"example_human_Illumina.pe_2.fastq\",\n \"size\": 36433,\n \"project\": \"rfranklin/my-project\",\n \"created_on\": \"2018-03-27T15:00:27Z\",\n \"modified_on\": \"2018-03-27T15:00:30Z\",\n \"storage\": {\n \"type\": \"VOLUME\",\n \"volume\": \"rfranklin/input\",\n \"location\": \"example_human_Illumina.pe_2.fastq\"\n },\n \"origin\": {},\n \"tags\": [],\n \"metadata\": {}\n },\n \"finished_on\": \"2018-03-27T15:00:31Z\"\n }\n }\n ]\n}", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]