Get an URL for downloading a file

This call will return a URL for downloading a file.

https://cavatica-ga4gpi.sbgenomics.com/ga4gh/drs/v1/objects/{object_id}/access/{access_id}

Request

Example request

GET ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9c/access/aws-us-east-1 HTTP/1.1
Host: cavatica-ga4gh-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5436eb8f1273259740f75
GET /ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9/access/aws-us-east-1c HTTP/1.1
Host: cavatica-ga4gh-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5436eb8f1273259740f75

Header Fields

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

Path parameters

KeyDescription of value
object_idThe ID of the DRS object i.e. the ID of the file in your project.
access_idAn arbitrary string to be passed to the /access method to get an AccessURL.

Note: use the Get info about a DRS object call to retrieve the access_idparameter.

Response

See a list of CAVATICA-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 type of valueDescription of value
urlStringThe link for downloading the file.

Example response body

{
    "url": "https://tcga-controlled.s3.amazonaws.com/3a5968d3-2a4f-415a-9b01-7f9f9afbad9f/7ee5a028a6bc0812b1b10aec200b57ac_gdc_realn.bam?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAINBJ6QVTSWMR7UZQ%2F20191029%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20191029T141056Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&user_id=436&username=ALEKSANDARGAZIBARA&X-Amz-Signature=af07361682c2b11a6537c99152b3e6e9d1198cafd9ee0bedcc4ae989d22de768"
}