Start an import job

This call lets you queue a job to import a file or folder from a volume into a project on the Platform. Essentially, you are importing an item from your cloud storage provider (Amazon Web Services or Google Cloud Storage) via the volume onto the Platform.

If successful, an alias will be created on the Platform. Aliases appear on the Platform and can be copied, executed, and modified as such. They refer back to the respective item on the given volume.

If you want to import multiple files, the recommended way is to do it in bulk considering the API rate limit (learn more).

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/imports

Example request body

{  
   "source":{  
      "volume":"rfranklin/input",
      "location":"example_human_Illumina.pe_1.fastq"
   },
   "destination":{  
      "project":"rfranklin/my_project",
      "name":"my_uploaded_example_human_Illumina.pe_1.fastq"
   },
   "overwrite": true
}
{
     "source": {
       "volume": "rfranklin/my_volume",
       "location": "samples/november/"
     },
     "destination": {
         "parent": "5bcdc233e4b0cbdd7a82e7cc"
     }
}

Response

See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.

Response body

The response object contains information about the specified volume. The information is structured using the following key-value pairs:

Key

Data type of value

Description of value

id

String

ID of this import job

state

String

The state of this import job. Possible values are:

  • PENDING: the import is queued;
  • RUNNING: the import is running;
  • COMPLETED: the import has completed successfully;
  • FAILED: the import has failed.

overwrite

Boolean

autorename

Boolean

source

Object

Import source, as passed when this job was started.

destination

Object

Import destination, as passed when this job was started.

result

Object

File object that was imported.

error

Object

In case of error in the import job, standard API error is returned here.

started_on

String

Time when the import job started.

finished_on

String

Time when the import job ended.

Language