Get details of a bulk import job

This call returns the details of a bulk import job.

Note that when you import files from your volume on a cloud storage provider (Amazon Web Services or Google Cloud Storage), you create an alias on CGC which points to the files in your cloud storage bucket. Aliases appear as files on CGC and can be copied, executed, and modified.

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

Request

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

Example request

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

curl -X POST \
  https://cgc-api.sbgenomics.com/v2/bulk/storage/imports/get \
  -H 'Content-Type: application/json' \
  -H 'X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74' \
  -d '{
    "import_ids": [
        "gOM3zcx63MW711ac0SbNkaUE0SNRK4H0S", "YFyyZ7rpCGtXjKTzjGGRJIIBmWd6Mh19"
    ]
}
'

Header Fields

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

Request body

Name	Description
`import_ids`	The IDs of the import jobs as returned by the call to start a bulk import 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	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.
`source`	object	Import source, as passed when this job was started by the call to start an import job.
`destination`	object	Import destination, as passed when this job was start an import job.
`result`	object	File object that was imported.
`error`	object	In case of error in the import job, standard API error is returned here.

Example response body

{
    "items": [
        {
            "resource": {
                "href": "https://cgc-api.sbgenomics.com/v2/storage/imports/gOM3zcx63MW711ac0SbNkaUE0SNRK4H0S",
                "id": "gOM3zcx63MW711ac0SbNkaUE0SNRK4H0S",
                "state": "PENDING",
                "overwrite": true,
                "source": {
                    "volume": "rfranklin/input",
                    "location": "example_human_Illumina.pe_1.fastq"
                },
                "destination": {
                    "project": "rfranklin/my_project",
                    "name": "example_human_Illumina.pe_1.fastq"
                }
            }
        },
        {
            "resource": {
                "href": "https://cgc-api.sbgenomics.com/v2/storage/imports/YFyyZ7rpCGtXjKTzjGGRJIIBmWd6Mh19",
                "id": "YFyyZ7rpCGtXjKTzjGGRJIIBmWd6Mh19",
                "state": "PENDING",
                "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"
                }
            }
        }
    ]
}