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. This call obtains the details of that job.
Learn more about using the Volumes API for Amazon S3 and for Google Cloud Storage.
If you are using Seven Bridges Platform EU, please use the following endpoint:
https://eu-api.sbgenomics.com/v2/storage/exports/{export_id}
When exporting a file from the Platform to an attached volume, export is possible only to a volume that is in the same location (cloud provider and region) as the project from which the file is being exported.
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. |