Get details of a bulk DRS import job

This API call lets you get details of a bulk file import job done through the Data Repository Service (DRS).

https://cgc-api.sbgenomics.com/v2/bulk/drs/imports/{import_id}

Request

Example request

GET v2/bulk/drs/imports/123456246075339870 HTTP/1.1
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74
curl -X GET -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" 'https://cgc-api.sbgenomics.com/v2/bulk/drs/imports/123456246075339870 HTTP/1.1'

Header Fields

KeyDescription of value
X-SBG-Auth-Token
required
Your CGC authentication token.

Path parameters

KeyData typeDescription
import_idStringID of the job for which you want to get import information. ID is returned when creating a bulk DRS import job.

Response

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

Response body

The response object contains the link for downloading the file.

KeyData typeDescription
hrefStringURI of this import job, for example https://api.sbgenomics.com/v2/async/files/import/123456246075339.
idStringID of the import job.
resultArrayFiles and errors for each of the items in the bulk import job.
started_onStringDate and time when the import job started.
finished_onStringDate and time when the import job ended.
stateStringCurrent state of the import job. Available values:
SUBMITTED
RESOLVING
RUNNING
FINISHED

Example response body

{
    "href": "https://cgc-api.sbgenomics.com/v2/bulk/drs/imports/123456246075339870",
    "id": "123456246075339870",
    "result": [
        {
            "resource": {
                "href": "https://cgc-api.sbgenomics.com/v2/files/568e69abe9b0307bc0412345",
                "id": "568e69abe9b0307bc0412345"
            }
        }
    ],
    "state": "FINISHED",
    "started_on": "2021-09-14T14:06:27Z",
    "finished_on": "2021-09-14T14:06:28Z"
}
Language