{"_id":"5ad6051ab93a210003db8808","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":"5ad5eab10a46a3000376af1f","project":"5773dcfc255e820e00e1cd4d","version":"5773dcfc255e820e00e1cd50","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-04-17T12:38:09.296Z","from_sync":false,"order":15,"slug":"bulk-api-actions","title":"BULK API ACTIONS"},"user":"566590c83889610d0008a253","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-17T14:30:50.753Z","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 Cavatica into a volume, you write to your cloud storage bucket on Amazon Web Services. This call obtains the details of that job.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Please note that export from Cavatica to Google Cloud Storage volumes is currently not supported.\"\n}\n[/block]\nLearn more about using the Volumes API for [Amazon S3](doc:aws-cloud-storage-tutorial).\n\n##Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-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: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -X POST \\\\\\n  https://cavatica-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 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###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 Cavatica-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://cavatica-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://cavatica-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://cavatica-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://cavatica-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 Cavatica into a volume, you write to your cloud storage bucket on Amazon Web Services. This call obtains the details of that job. [block:callout] { "type": "info", "body": "Please note that export from Cavatica to Google Cloud Storage volumes is currently not supported." } [/block] Learn more about using the Volumes API for [Amazon S3](doc:aws-cloud-storage-tutorial). ##Request [block:code] { "codes": [ { "code": "https://cavatica-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: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75", "language": "http", "name": null }, { "code": "curl -X POST \\\n https://cavatica-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 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] ###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 Cavatica-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://cavatica-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://cavatica-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://cavatica-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://cavatica-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]