Get 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 or Google Cloud Storage. This call obtains the details of that job.

Learn more about using the Volumes API for Amazon S3 and for Google Cloud Storage.

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/storage/exports/{export_id}

Request

Example request

GET /v2/storage/exports/crand0mKvetGpxIjo088DnMXEg0t6srX HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
Content-type: application/json

curl -s -H "X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96" -H "Content-Type: application/json" -X GET "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/storage/exports/crand0mKvetGpxIjo088DnMXEg0t6srX"

Header Fields

Key	Description of value
`X-SBG-Auth-Token` required	Your authentication token.
`Content-type` required	`application/json`

Path parameters

Key	Description of value
`export_id`	The ID of the export job as returned by Start an export job.

Response

See a list of response codes that may be contained in the body of the response.

Response body

The response object contains information about the status of the export job. The information is structured using the following key-value pairs:

Key	Data type of value	Description of value
`id`	String	ID of this export job
`state`	String	The state of this export job. Possible values are: `PENDING`: the export is queued; `RUNNING`: the export is running; `COMPLETED`: the export has completed successfully; `FAILED`: the export has failed.
`source`	Object	Export source, as passed when this job was started by the call to start an export job .
`file`	String	ID of the file that was exported.
`destination`	Object	Export destination, as passed when this job was started by the call to Start an export job.
`volume`	String	ID of the volume where to export.
`location	String	Location on the volume where the file should be exported.
`started_on`	String	Time when the export job was started.
`finished_on`	String	Time when the export job was finished.
`properties`	Object	Contains properties related to the export, including: "sse_algorithm" - algorithm used for S3 encryption "aws_storage_class" - storage class (STANDARD or GLACIER) * "aws_canned_acl" - ACL which is set on the S3 bucket
`overwrite`	Boolean	Whether the file should be overwritten in the destination.

Example response body

{
  "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/storage/exports/crand0mKvetGpxIjo088DnMXEg0t6srX",
  "id": "crand0mKvetGpxIjo088DnMXEg0t6srX",
  "state": "COMPLETED",
  "source": {
    "file": "567890abc9b0307bc0414164"
  },
  "destination": {
    "volume": "rfranklin/output",
    "location": "output.vcf"
  },
  "started_on": "2016-06-15T19:17:39Z",
  "finished_on": "2016-06-15T19:17:41Z",
  "properties": {
    "sse_algorithm": "AES256",
    "aws_storage_class": "STANDARD",
    "aws_canned_acl": "public-read"
  },
  "overwrite": false
}

{
  "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/storage/exports/yrand0mqLcnVaDEFYyM75zZ7M6rvTeZm",
  "id": "yrand0mqLcnVaDEFYyM75zZ7M6rvTeZm",
  "state": "FAILED",
  "error": {
    "status": 409,
    "code": 9107,
    "message": "Location on volume already contains a file. Check the documentation.",
    "more_info": "https://sb-biodatacatalyst.readme.io/reference/api-status-codes#9107"
  },
  "source": {
    "file": "567890abc4f3066bc3750174"
  },
  "destination": {
    "volume": "rfranklin/output",
    "location": "_4_s3_file.jpg"
  },
  "started_on": "2016-06-22T13:38:57Z",
  "finished_on": "2016-06-22T13:38:57Z",
  "properties": {
    "sse_algorithm": "AES256",
    "sse_aws_kms_key_id": "67f68072-45b6-12b3-789c-37be8b0f2f04",
    "aws_canned_acl": "public-read"
  },
  "overwrite": false
}