get https://api.sbgenomics.com/v2/bulk/storage/export/get
This call returns the details of a bulk export job.
When you export files 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.
If you are using Seven Bridges Platform EU, please use the following endpoint:
https://eu-api.sbgenomics.com/v2/bulk/storage/export/get
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
| Key | Data type | Description |
|---|---|---|
id | string | The ID of the particular export job. |
state | string | The state of this export job. Possible values are:PENDING: the export is queuedRUNNING: the export is runningCOMPLETED: the export has completed successfullyFAILED: the export has failed |
source | object | Export source, as passed when this job was started by the call to start an export job. |
destination | object | Export destination, as passed when this job was start an export job. |
result | object | File object that was exported. |
error | object | In case of error in the export job, standard API error is returned here. |