Get info about a DRS object

This call will return the details of a DRS object.{object_id}


Example request

GET ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9c HTTP/1.1
X-SBG-Auth-Token: 3259c50e1ac5436eb8f1273259740f75
GET /ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9c HTTP/1.1
X-SBG-Auth-Token: 3259c50e1ac5336ea8f1273259740f75

Header Fields

KeyDescription of value
Your Platform authentication token.

Path parameters

KeyDescription of value
object_idThe ID of the DRS object i.e. file in your project.


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

Response body

The response object contains information about the DRS object. The information is structured using the following key-value pairs:

KeyData type of valueDescription of value
idStringID of the DRS object.
nameStringThe name of the DRS object.
sizeStringThe size of the file.
checksumsDictionaryThis dictionary contains two fields:
self_uriStringA drs:// URI, as defined in the DRS documentation, that tells clients how to access this object. The intent of this field is to make DRS objects self-contained, and therefore easier for clients to store and pass around.
created_timeStringThe time and date the object was originally created.
updated_timeStringThe time and date the object was last updated.
mime_typeStringInformation about the file type.
access_methodsThis dictionary contains these fields:

type - Type of the access method.
region - Name of the region in the cloud service provider that the object belongs to.
access_id - An arbitrary string to be passed to the /access method to get an AccessURL.

Example response body

    "id": "5c24cd21e4b08832c2f94e9c",
    "name": "7ee5a028a6bc0812b1b10aec200b57ac_gdc_realn.bam",
    "size": 11305017366,
    "checksums": [
            "type": "etag",
            "checksum": "4c555f6a344a35dd75fa4086bb94dccb-43"
    "self_uri": "drs://",
    "created_time": "2018-12-27T13:01:21Z",
    "updated_time": "2018-12-27T13:01:21Z",
    "mime_type": "application/json",
    "access_methods": [
            "type": "s3",
            "region": "us-east-1",
            "access_id": "aws-us-east-1"