{"_id":"5b0e13ffc4664e0003c75c25","category":{"_id":"5b0e13ffc4664e0003c75a75","project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":32,"slug":"api","title":"API Reference"},"parentDoc":null,"__v":0,"user":"5613e4f8fdd08f2b00437620","version":{"_id":"5b0e13ffc4664e0003c75a67","project":"5b0e13ffc4664e0003c75a66","__v":4,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["5b0e13ffc4664e0003c75a68","5b0e13ffc4664e0003c75a69","5b0e13ffc4664e0003c75a6a","5b0e13ffc4664e0003c75a6b","5b0e13ffc4664e0003c75a6c","5b0e13ffc4664e0003c75a6d","5b0e13ffc4664e0003c75a6e","5b0e13ffc4664e0003c75a6f","5b0e13ffc4664e0003c75a70","5b0e13ffc4664e0003c75a71","5b0e13ffc4664e0003c75a72","5b0e13ffc4664e0003c75a73","5b0e13ffc4664e0003c75a74","5b0e13ffc4664e0003c75a75","5b0e13ffc4664e0003c75a76","5b0e13ffc4664e0003c75a77","5b0e13ffc4664e0003c75a89","5b0e13ffc4664e0003c75a8a","5b0e13ffc4664e0003c75a9d","5b0e13ffc4664e0003c75a9e","5b0e13ffc4664e0003c75a9f","5b0e13ffc4664e0003c75aa0","5b0e13ffc4664e0003c75aa1","5b0e13ffc4664e0003c75aa2","5b0e13ffc4664e0003c75aa3","5b0e13ffc4664e0003c75aa4","5b0e13ffc4664e0003c75aa5","5b0e13ffc4664e0003c75aa6","5b0e13ffc4664e0003c75aa7","5b0e13ffc4664e0003c75aa8","5b0e13ffc4664e0003c75aa9","5b0e13ffc4664e0003c75aaa","5b0e13ffc4664e0003c75aab","5b0e13ffc4664e0003c75aac","5b0e13ffc4664e0003c75aad","5b0e13ffc4664e0003c75aae","5b0e13ffc4664e0003c75aaf","5b0e13ffc4664e0003c75ab2","5bb3374f4306ad0003eb18e7","5bbf3c5373e72a000318362b","5bc065567d1cb0000384c649","5cbf19a5f9181f0033fbb968"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"project":"5b0e13ffc4664e0003c75a66","githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-12T22:22:14.884Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":92,"body":"This call lists export jobs initiated by particular user.\n\nNote that when you export a file from a project on the Platform into a volume, you write to your cloud storage bucket on Amazon Web Services or Google Cloud Storage.\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://f4c-api.sbgenomics.com/v2/storage/exports\",\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/exports HTTP/1.1\\nHost: f4c-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\nContent-type: application/json\",\n      \"language\": \"http\",\n      \"name\": \"HTTP\"\n    },\n    {\n      \"code\": \"curl -s -H \\\"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\\\" -H \\\"Content-Type: application/json\\\" -X GET \\\"https://f4c-api.sbgenomics.com/v2/storage/exports\\\"\",\n      \"language\": \"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 [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##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###Example response body \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/storage/exports?offset=0&limit=50\\\",\\n  \\\"items\\\": [\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/storage/exports/19K01S2JNGdsI8pSV1IeLoh2eM0A60hK\\\",\\n      \\\"id\\\": \\\"19K01S2JNGdsI8pSV1IeLoh2eM0A60hK\\\",\\n      \\\"state\\\": \\\"FAILED\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/storage/exports/2fzgXdc7zqeYFMiVvTCZdLBKgUpKdUhn\\\",\\n      \\\"id\\\": \\\"2fzgXdc7zqeYFMiVvTCZdLBKgUpKdUhn\\\",\\n      \\\"state\\\": \\\"COMPLETED\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/storage/exports/2nNtQ85VYLSk1s2pl4AA2Rd53cFXbU6r\\\",\\n      \\\"id\\\": \\\"2nNtQ85VYLSk1s2pl4AA2Rd53cFXbU6r\\\",\\n      \\\"state\\\": \\\"COMPLETED\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/storage/exports/2vCsLGISafBS6VVBbc6HvUwIztH4IUkG\\\",\\n      \\\"id\\\": \\\"2vCsLGISafBS6VVBbc6HvUwIztH4IUkG\\\",\\n      \\\"state\\\": \\\"COMPLETED\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/storage/exports/3uAhcn70HgmeUsxaFmFRjgAY49HiLTDi\\\",\\n      \\\"id\\\": \\\"3uAhcn70HgmeUsxaFmFRjgAY49HiLTDi\\\",\\n      \\\"state\\\": \\\"COMPLETED\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/storage/exports/4C52TscVhMYxqbDOARXQuE0DF48hcC2W\\\",\\n      \\\"id\\\": \\\"4C52TscVhMYxqbDOARXQuE0DF48hcC2W\\\",\\n      \\\"state\\\": \\\"COMPLETED\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/storage/exports/5uK7FFmfZULvKaLU1Uvh8Hs64rXLvUZr\\\",\\n      \\\"id\\\": \\\"5uK7FFmfZULvKaLU1Uvh8Hs64rXLvUZr\\\",\\n      \\\"state\\\": \\\"FAILED\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/storage/exports/6D0sMkqDioRSJTDMwKVpcyED0GY12mQB\\\",\\n      \\\"id\\\": \\\"6D0sMkqDioRSJTDMwKVpcyED0GY12mQB\\\",\\n      \\\"state\\\": \\\"FAILED\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/storage/exports/6jiuHRIRksVlGfhyQgar5hpPvGv0Kkfk\\\",\\n      \\\"id\\\": \\\"6jiuHRIRksVlGfhyQgar5hpPvGv0Kkfk\\\",\\n      \\\"state\\\": \\\"FAILED\\\"\\n    },\\n   }\\n    <snip>\\n  ],\\n  \\\"links\\\": []\\n}\",\n      \"language\": \"json\",\n      \"name\": \"\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"list-export-jobs-v2","type":"endpoint","title":"List export jobs"}

getList export jobs


This call lists export jobs initiated by particular user. Note that when you export a file from a project on the Platform into a volume, you write to your cloud storage bucket on Amazon Web Services or Google Cloud Storage. 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://f4c-api.sbgenomics.com/v2/storage/exports", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/storage/exports HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\nContent-type: application/json", "language": "http", "name": "HTTP" }, { "code": "curl -s -H \"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\" -H \"Content-Type: application/json\" -X GET \"https://f4c-api.sbgenomics.com/v2/storage/exports\"", "language": "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 [authentication token](doc:get-your-authentication-token).", "h-2": "", "1-0": "`Content-type`\n_required_", "1-1": "`application/json`" }, "cols": 2, "rows": 2 } [/block] ##Response [See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body [block:code] { "codes": [ { "code": "{\n \"href\": \"https://f4c-api.sbgenomics.com/v2/storage/exports?offset=0&limit=50\",\n \"items\": [\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/storage/exports/19K01S2JNGdsI8pSV1IeLoh2eM0A60hK\",\n \"id\": \"19K01S2JNGdsI8pSV1IeLoh2eM0A60hK\",\n \"state\": \"FAILED\"\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/storage/exports/2fzgXdc7zqeYFMiVvTCZdLBKgUpKdUhn\",\n \"id\": \"2fzgXdc7zqeYFMiVvTCZdLBKgUpKdUhn\",\n \"state\": \"COMPLETED\"\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/storage/exports/2nNtQ85VYLSk1s2pl4AA2Rd53cFXbU6r\",\n \"id\": \"2nNtQ85VYLSk1s2pl4AA2Rd53cFXbU6r\",\n \"state\": \"COMPLETED\"\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/storage/exports/2vCsLGISafBS6VVBbc6HvUwIztH4IUkG\",\n \"id\": \"2vCsLGISafBS6VVBbc6HvUwIztH4IUkG\",\n \"state\": \"COMPLETED\"\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/storage/exports/3uAhcn70HgmeUsxaFmFRjgAY49HiLTDi\",\n \"id\": \"3uAhcn70HgmeUsxaFmFRjgAY49HiLTDi\",\n \"state\": \"COMPLETED\"\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/storage/exports/4C52TscVhMYxqbDOARXQuE0DF48hcC2W\",\n \"id\": \"4C52TscVhMYxqbDOARXQuE0DF48hcC2W\",\n \"state\": \"COMPLETED\"\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/storage/exports/5uK7FFmfZULvKaLU1Uvh8Hs64rXLvUZr\",\n \"id\": \"5uK7FFmfZULvKaLU1Uvh8Hs64rXLvUZr\",\n \"state\": \"FAILED\"\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/storage/exports/6D0sMkqDioRSJTDMwKVpcyED0GY12mQB\",\n \"id\": \"6D0sMkqDioRSJTDMwKVpcyED0GY12mQB\",\n \"state\": \"FAILED\"\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/storage/exports/6jiuHRIRksVlGfhyQgar5hpPvGv0Kkfk\",\n \"id\": \"6jiuHRIRksVlGfhyQgar5hpPvGv0Kkfk\",\n \"state\": \"FAILED\"\n },\n }\n <snip>\n ],\n \"links\": []\n}", "language": "json", "name": "" } ], "sidebar": true } [/block]