{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"Get details of an export job","type":"endpoint","slug":"get-details-of-an-export-job-v2","excerpt":"","body":"This call will return the details of an export job.\n\nWhen you export a file from a project on the Platform 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](http://docs.sevenbridges.com/docs/aws-cloud-storage-tutorial).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/storage/exports/{export_id}\",\n      \"language\": \"text\",\n      \"name\": \"API 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/gW26LlICb9MmJkalaWEeI3HvJkbgvIh8 HTTP/1.1\\nHost: cavatica-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://cavatica-api.sbgenomics.com/v2/storage/exports/gW26LlICb9MmJkalaWEeI3HvJkbgvIh8\\\"\",\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 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###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\": \"`export_id`\",\n    \"0-1\": \"The ID of the export job as returned by [Start an export job](doc:start-an-export-job).\",\n    \"0-2\": \"If true and a file exists in the given location on the volume (respecting volume prefix if given), the API will attempt to delete the existing file on the volume before exporting.\\n\\n_default_: `false`\"\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](doc:api-status-codes).\n\n###Response body\n\nThe response object contains information about the status of the export 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    \"4-0\": \"`destination`\",\n    \"4-1\": \"Object\",\n    \"7-0\": \"`started_on`\",\n    \"7-1\": \"String\",\n    \"8-0\": \"`finished_on`\",\n    \"8-1\": \"String\",\n    \"0-2\": \"ID of this export job\",\n    \"1-2\": \"The state of this export job. Possible values are:\\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-2\": \"Export source, as passed when this job was started by the call to [start an export job](doc:start-an-export-job-v2) .\",\n    \"4-2\": \"Export destination, as passed when this job was started by the call to [Start an export job](doc:start-an-export-job-v2).\",\n    \"7-2\": \"Time when the export job was started.\",\n    \"8-2\": \"Time when the export job was finished.\",\n    \"5-0\": \"`volume`\",\n    \"5-1\": \"String\",\n    \"3-0\": \"`file`\",\n    \"3-1\": \"String\",\n    \"6-0\": \"`location\",\n    \"6-1\": \"String\",\n    \"9-0\": \"`properties`\",\n    \"10-0\": \"`overwrite`\",\n    \"9-1\": \"Object\",\n    \"10-1\": \"Boolean\",\n    \"3-2\": \"ID of the file that was exported.\",\n    \"6-2\": \"Location on the volume where the file should be exported.\",\n    \"5-2\": \"ID of the volume where to export.\",\n    \"9-2\": \"Contains properties related to the export, including:\\n  * \\\"sse_algorithm\\\" - algorithm used for S3 encryption\\n  *  \\\"aws_storage_class\\\" - storage class (STANDARD or GLACIER)\\n  *  \\\"aws_canned_acl\\\" - ACL which is set on the S3 bucket\",\n    \"10-2\": \"Whether the file should be overwritten in the destination.\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]\n###Example response body - successfully completed export\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/storage/exports/2fzgXdc7zqeYFMiVvTCZdLBKgUpKdUhn\\\",\\n  \\\"id\\\": \\\"2fzgXdc7zqeYFMiVvTCZdLBKgUpKdUhn\\\",\\n  \\\"state\\\": \\\"COMPLETED\\\",\\n  \\\"source\\\": {\\n    \\\"file\\\": \\\"576159f7f5b4e1de6ae9b5f0\\\"\\n  },\\n  \\\"destination\\\": {\\n    \\\"volume\\\": \\\"rfranklin/output\\\",\\n    \\\"location\\\": \\\"output.vcf\\\"\\n  },\\n  \\\"started_on\\\": \\\"2016-06-15T19:17:39Z\\\",\\n  \\\"finished_on\\\": \\\"2016-06-15T19:17:41Z\\\",\\n  \\\"properties\\\": {\\n    \\\"sse_algorithm\\\": \\\"AES256\\\",\\n    \\\"aws_storage_class\\\": \\\"STANDARD\\\",\\n    \\\"aws_canned_acl\\\": \\\"public-read\\\"\\n  },\\n  \\\"overwrite\\\": false\\n}\",\n      \"language\": \"json\",\n      \"name\": \"\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Example response body - failed export\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" {\\n  \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/storage/exports/19K01S2JNGdsI8pSV1IeLoh2eM0A60hK\\\",\\n  \\\"id\\\": \\\"19K01S2JNGdsI8pSV1IeLoh2eM0A60hK\\\",\\n  \\\"state\\\": \\\"FAILED\\\",\\n  \\\"error\\\": {\\n    \\\"status\\\": 409,\\n    \\\"code\\\": 9107,\\n    \\\"message\\\": \\\"Location on volume already contains a file. Check the documentation.\\\",\\n    \\\"more_info\\\": \\\"http://docs.sevenbridges.com/docs/api-status-codes#9107\\\"\\n  },\\n  \\\"source\\\": {\\n    \\\"file\\\": \\\"57679b78f5b42122e7fde6a9\\\"\\n  },\\n  \\\"destination\\\": {\\n    \\\"volume\\\": \\\"rfranklin/output\\\",\\n    \\\"location\\\": \\\"_4_s3_file.jpg\\\"\\n  },\\n  \\\"started_on\\\": \\\"2016-06-22T13:38:57Z\\\",\\n  \\\"finished_on\\\": \\\"2016-06-22T13:38:57Z\\\",\\n  \\\"properties\\\": {\\n    \\\"sse_algorithm\\\": \\\"AES256\\\",\\n    \\\"sse_aws_kms_key_id\\\": \\\"6762ec77-01e3-42cc-ba3f-de371ec2359b\\\",\\n    \\\"aws_canned_acl\\\": \\\"public-read\\\"\\n  },\\n  \\\"overwrite\\\": false\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","updates":[],"order":97,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5790a6baf7ff000e004ba3a9","parentDoc":null,"project":"5773dcfc255e820e00e1cd4d","user":"575e85ac41c8ba0e00259a44","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"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","5dc15666a4f788004c5fd7d7","5eaff69e844d67003642a020","5eb00899b36ba5002d35b0c1","5eb0172be179b70073dc936e","5eb01b42b36ba5002d35ebba","5eb01f202654a20136813093","5eb918ef149186021c9a76c8","5f0839d3f4b24e005ebbbc29","5f893e508c9862002d0614a9","6024033e2b2f6f004dfe994c","60a7a12f9a06c70052b7c4db","60a7ab97266a4700161507c4","60b0c84babba720010a8b0b5"],"_id":"5773dcfc255e820e00e1cd50","__v":39,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"__v":1,"createdAt":"2016-07-21T10:40:58.450Z","githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"CAVATICA API","slug":"api","order":22,"from_sync":false,"reference":false,"_id":"5773df36904b0c0e00ef05ff","createdAt":"2016-06-29T14:46:14.277Z","version":"5773dcfc255e820e00e1cd50","__v":1,"project":"5773dcfc255e820e00e1cd4d"}}

Get started

Tutorials

CAVATICA Projects

Find apps

Find files

Add files to a project

Bring data to CAVATICA

Set metadata associated with a file

Collaborate securely

BRING YOUR TOOLS

Docker

Developer tools

EDIT AN APP

Tool wrapping tips and tricks

Describe your tool (Legacy)

Browse public datasets

Run an analysis

Task Execution

Review a task

INTERACTIVE ANALYSIS

Kids First studies

CAVATICA Datasets

CAVATICA API

Connect cloud storage

SBFS (Beta)

BULK API ACTIONS

ASYNC BULK ACTIONS

DRS API

WES API

CAVATICA DATASETS API (Advanced Access)

Data Cruncher

SBFS (Beta)

SBFS Command reference

getGet details of an export job

This call will return the details of an export job. 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. 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](http://docs.sevenbridges.com/docs/aws-cloud-storage-tutorial). [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/storage/exports/{export_id}", "language": "text", "name": "API path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/storage/exports/gW26LlICb9MmJkalaWEeI3HvJkbgvIh8 HTTP/1.1\nHost: cavatica-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://cavatica-api.sbgenomics.com/v2/storage/exports/gW26LlICb9MmJkalaWEeI3HvJkbgvIh8\"", "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 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] ###Path parameters [block:parameters] { "data": { "h-0": "Key", "h-1": "Description of value", "h-2": "Description of value", "0-0": "`export_id`", "0-1": "The ID of the export job as returned by [Start an export job](doc:start-an-export-job).", "0-2": "If true and a file exists in the given location on the volume (respecting volume prefix if given), the API will attempt to delete the existing file on the volume before exporting.\n\n_default_: `false`" }, "cols": 2, "rows": 1 } [/block] ##Response [See a list of CAVATICA-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 export 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", "4-0": "`destination`", "4-1": "Object", "7-0": "`started_on`", "7-1": "String", "8-0": "`finished_on`", "8-1": "String", "0-2": "ID of this export job", "1-2": "The state of this export job. Possible values are:\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-2": "Export source, as passed when this job was started by the call to [start an export job](doc:start-an-export-job-v2) .", "4-2": "Export destination, as passed when this job was started by the call to [Start an export job](doc:start-an-export-job-v2).", "7-2": "Time when the export job was started.", "8-2": "Time when the export job was finished.", "5-0": "`volume`", "5-1": "String", "3-0": "`file`", "3-1": "String", "6-0": "`location", "6-1": "String", "9-0": "`properties`", "10-0": "`overwrite`", "9-1": "Object", "10-1": "Boolean", "3-2": "ID of the file that was exported.", "6-2": "Location on the volume where the file should be exported.", "5-2": "ID of the volume where to export.", "9-2": "Contains properties related to the export, including:\n * \"sse_algorithm\" - algorithm used for S3 encryption\n * \"aws_storage_class\" - storage class (STANDARD or GLACIER)\n * \"aws_canned_acl\" - ACL which is set on the S3 bucket", "10-2": "Whether the file should be overwritten in the destination." }, "cols": 3, "rows": 11 } [/block] ###Example response body - successfully completed export [block:code] { "codes": [ { "code": "{\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/storage/exports/2fzgXdc7zqeYFMiVvTCZdLBKgUpKdUhn\",\n \"id\": \"2fzgXdc7zqeYFMiVvTCZdLBKgUpKdUhn\",\n \"state\": \"COMPLETED\",\n \"source\": {\n \"file\": \"576159f7f5b4e1de6ae9b5f0\"\n },\n \"destination\": {\n \"volume\": \"rfranklin/output\",\n \"location\": \"output.vcf\"\n },\n \"started_on\": \"2016-06-15T19:17:39Z\",\n \"finished_on\": \"2016-06-15T19:17:41Z\",\n \"properties\": {\n \"sse_algorithm\": \"AES256\",\n \"aws_storage_class\": \"STANDARD\",\n \"aws_canned_acl\": \"public-read\"\n },\n \"overwrite\": false\n}", "language": "json", "name": "" } ], "sidebar": true } [/block] ###Example response body - failed export [block:code] { "codes": [ { "code": " {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/storage/exports/19K01S2JNGdsI8pSV1IeLoh2eM0A60hK\",\n \"id\": \"19K01S2JNGdsI8pSV1IeLoh2eM0A60hK\",\n \"state\": \"FAILED\",\n \"error\": {\n \"status\": 409,\n \"code\": 9107,\n \"message\": \"Location on volume already contains a file. Check the documentation.\",\n \"more_info\": \"http://docs.sevenbridges.com/docs/api-status-codes#9107\"\n },\n \"source\": {\n \"file\": \"57679b78f5b42122e7fde6a9\"\n },\n \"destination\": {\n \"volume\": \"rfranklin/output\",\n \"location\": \"_4_s3_file.jpg\"\n },\n \"started_on\": \"2016-06-22T13:38:57Z\",\n \"finished_on\": \"2016-06-22T13:38:57Z\",\n \"properties\": {\n \"sse_algorithm\": \"AES256\",\n \"sse_aws_kms_key_id\": \"6762ec77-01e3-42cc-ba3f-de371ec2359b\",\n \"aws_canned_acl\": \"public-read\"\n },\n \"overwrite\": false\n}", "language": "json" } ] } [/block]