Get an URL for downloading a file

This call will return a URL for downloading a file.

Path

https://ga4gh-api.sb.biodatacatalyst.nhlbi.nih.gov/ga4gh/drs/v1/objects/{object_id}/access/{access_id}

Request

Example request

HTTP

GET ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9c/access/aws-us-east-1 HTTP/1.1
Host: sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5336eb7cf1273259740f75

cURL

GET /ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9/access/aws-us-east-1c HTTP/1.1
Host: sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5336ea8f1273259740f75

Header Fields

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

Path parameters

Key	Description of value
object_id	The ID of the DRS object i.e. the ID of the file in your project.
access_id	An 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 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.

Key	Data type of value	Description of value
url	String	The link for downloading the file.

Example response body

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"
}