Get details of a bulk export job

This call returns the details of a bulk export job.

📘
When exporting a file from the CGC 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.

When you export files from a project on CGC 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 Google Cloud Storage.

Request

https://cgc-api.sbgenomics.com/v2/bulk/storage/export/get

Example request

POST v2/bulk/storage/export/get
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74

curl -X POST \
  https://cgc-api.sbgenomics.com/v2/bulk/storage/exports/get \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -H 'X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74' \
  -d '{
    "export_ids": [
        "gET2tre6CG411ac0SbNkaVA0SNRK4H9W", "YFyyZ7teCGtXjPPzjGGRJIIAmCd6Ol29"
    ]
}
'

Header Fields

Name	Description
X-SBG-Auth-Token required	Your CGC authentication token.
Content-Type required	`application/json`

Request body

Key	Description
`export_ids`	The IDs of the export job as returned by the call to start a bulk export job. Separate IDs with a comma.

Response

See a list of CGC-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.

Example response body

{
    "items": [
        {
            "resource": {
                "href": "https://cgc-api.sbgenomics.com/v2/storage/exports/gET2tre6CG411ac0SbNkaVA0SNRK4H9W",
                "id": "gET2tre6CG411ac0SbNkaVA0SNRK4H9W",
                "state": "COMPLETED",
                "overwrite": true,
                "source": {
                    "volume": "rfranklin/input",
                    "location": "my_uploaded_example_human_Illumina.pe_1.fastq"
                },
                "destination": {
                    "project": "rfranklin/my_project",
                    "name": "example_human_Illumina.pe_1.fastq"
                },
                "result": {
                    "href": "https://cgc-api.sbgenomics.com/v2/files/568e69abe9b0307bc0419876",
                    "id": "568e69abe9b0307bc0419876",
                    "name": "example_human_Illumina.pe_1.fastq",
                    "size": 36433,
                    "project": "rfranklin/my-project",
                    "created_on": "2018-03-27T15:00:27Z",
                    "modified_on": "2018-03-27T15:00:30Z",
                    "storage": {
                        "type": "VOLUME",
                        "volume": "rfranklin/input",
                        "location": "example_human_Illumina.pe_1.fastq"
                    },
                    "origin": {},
                    "tags": [],
                    "metadata": {}        
                },
                "finished_on": "2018-03-27T15:00:28Z"
            }
        },
        {
            "resource": {
                "href": "https://cgc-api.sbgenomics.com/v2/storage/exports/YFyyZ7teCGtXjPPzjGGRJIIAmCd6Ol29",
                "id": "YFyyZ7teCGtXjPPzjGGRJIIAmCd6Ol29",
                "state": "COMPLETED",
                "overwrite": true,
                "source": {
                    "volume": "rfranklin/input",
                    "location": "example_human_Illumina.pe_2.fastq"
                },
                "destination": {
                    "project": "rfranklin/my-project",
                    "name": "example_human_Illumina.pe_2.fastq"
                },
                "result": {
                    "href": "https://cgc-api.sbgenomics.com/v2/files/568e69abe9b0307bc0414164",
                    "id": "568e69abe9b0307bc0414164",
                    "name": "example_human_Illumina.pe_2.fastq",
                    "size": 36433,
                    "project": "rfranklin/my-project",
                    "created_on": "2018-03-27T15:00:27Z",
                    "modified_on": "2018-03-27T15:00:30Z",
                    "storage": {
                        "type": "VOLUME",
                        "volume": "rfranklin/input",
                        "location": "example_human_Illumina.pe_2.fastq"
                    },
                    "origin": {},
                    "tags": [],
                    "metadata": {}
                },
                "finished_on": "2018-03-27T15:00:31Z"
            }
        }
    ]
}