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 on Amazon Web Services or Google Cloud Storage. This call obtains the details of that job.

Learn more about using the Volumes API for Amazon S3 and for Google Cloud Storage.

Request

Path

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/bulk/storage/export/get

Example request

HTTP

POST v2/bulk/storage/export/get
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75

cURL

curl -X POST \
  https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/bulk/storage/exports/get \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -H 'X-SBG-Auth-Token: b04aa2a2e98348a1a3a75ca677ea7fd7' \
  -d '{
    "export_ids": [
        "gOM3zcx6CG411ac0SbNkaUE0SNRK4H0S", "YFyyZ7rpCGtXjKTzjGGRJIIAmCd6Mh19"
    ]
}
'

Header Fields

Name	Description
X-SBG-Auth-Token required	Your 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 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

Example response body

{
    "items": [
        {
            "resource": {
                "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/storage/exports/gOM3zcx6CG411ac0SbNkaUE0SNRK4H0S",
                "id": "gOM3zcx6CG411ac0SbNkaUE0SNRK4H0S",
                "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://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files/5aba5c8b1c94b662fa6c2ae4",
                    "id": "5aba5c8b1c94b662fa6c2ae4",
                    "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://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/storage/exports/YFyyZ7rpCGtXjKTzjGGRJIIAmCd6Mh19",
                "id": "YFyyZ7rpCGtXjKTzjGGRJIIAmCd6Mh19",
                "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://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files/5aba5c8b1c94b662fa6c2ae4",
                    "id": "5aba5c8b1c94b662fa6c2ae4",
                    "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"
            }
        }
    ]
}