Get info about a DRS object

This call will return the details of a DRS object.

https://cgc-ga4gh-api.sbgenomics.com/ga4gh/drs/v1/objects/{object_id}

Request

Example request

GET ga4gh/drs/v1/objects/4c33ae65e4b08832ce3d94e9c HTTP/1.1
Host: cgc-ga4gh-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74

GET /ga4gh/drs/v1/objects/4c33ae65e4b08832ce3d94e9c HTTP/1.1
Host: cgc-ga4gh-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74

Header Fields

Key	Description of value
`X-SBG-Auth-Token` required	Your CGC 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 CGC-specific 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

{
    "id": "4c33ae65e4b08832ce3d94e9c",
    "name": "7ee5a028a6bc010aec200b57ac_file.bam",
    "size": 11305017366,
    "checksums": [
        {
            "type": "etag",
            "checksum": "4c555f6c235dd75fa4086bb94dccb-43"
        }
    ],
    "self_uri": "drs://cgc-ga4gh-api.sbgenomics.com/4c33ae65e4b08832ce3d94e9c",
    "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"
        }
    ]
}