Get details of a bulk export job

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

See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the 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 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.

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.

Language