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

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

Request

Example request

GET v2/bulk/drs/imports/154608246075330560 HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ae5426ea8f1273259740f74

curl -X GET -H "X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74" 'https://cavatica-api.sbgenomics.com/v2/bulk/drs/imports/154608246075330560 HTTP/1.1'

Header Fields

Key	Description of value
`X-SBG-Auth-Token` required	Your Cavatica authentication token.

Path parameters

Key	Data type	Description
`import_id`	String	ID 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 response codes that may be contained in the body of the response.

Response body

The response object contains the link for downloading the file.

Key	Data type	Description
`href`	String	URI of this import job, for example `https://cavatica-api.sbgenomics.com/v2/async/files/import/436242183587799`.
`id`	String	ID of the import job.
`result`	Array	Files and errors for each of the items in the bulk import job.
`started_on`	String	Date and time when the import job started.
`finished_on`	String	Date and time when the import job ended.
`state`	String	Current state of the import job. Available values: `SUBMITTED` `RESOLVING` `RUNNING` `FINISHED`

Example response body

{
    "href": "https://cavatica-api.sbgenomics.com/v2/bulk/drs/imports/154608246075330560",
    "id": "154608246075330560",
    "result": [
        {
            "resource": {
                "href": "https://cavatica-api.sbgenomics.com/v2/files/6130ac6485ecd250bb0c4fed",
                "id": "6130ac6485ecd250bb0c4fed"
            }
        }
    ],
    "state": "FINISHED",
    "started_on": "2021-09-14T14:06:27Z",
    "finished_on": "2021-09-14T14:06:28Z"
}