Get info about a DRS object

This call will return the details of a DRS object.

Path

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

Request

Example request

HTTP

GET ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9c HTTP/1.1
Host: sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5436eb8f1273259740f75

cURL

GET /ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9c 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. file in your project.

Response

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:

Key	Data type of value	Description of value
id	String	ID of the DRS object.
name	String	The name of the DRS object.
size	String	The size of the file.
checksums	Dictionary	This dictionary contains two fields: type checksum
self_uri	String	A 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_time	String	The time and date the object was originally created.
updated_time	String	The time and date the object was last updated.
mime_type	String	Information about the file type.
access_methods		This 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

Example response body

{
    "id": "5c24cd21e4b08832c2f94e9c",
    "name": "7ee5a028a6bc0812b1b10aec200b57ac_gdc_realn.bam",
    "size": 11305017366,
    "checksums": [
        {
            "type": "etag",
            "checksum": "4c555f6a344a35dd75fa4086bb94dccb-43"
        }
    ],
    "self_uri": "drs://ga4gh-api.sb.biodatacatalyst.nhlbi.nih.gov/5c24cd21e4b08832c2f94e9c",
    "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"
        }
    ]
}