{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","method":"get","examples":{"codes":[]},"settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Get info about a DRS object","type":"endpoint","slug":"get-info-about-a-drs-object","excerpt":"","body":"This call will return the details of a DRS object.\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"https://cgc-ga4gh-api.sbgenomics.com/ga4gh/drs/v1/objects/{object_id}\",\n \"language\": \"text\",\n \"name\": \"Path\"\n }\n ]\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"GET ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9c HTTP/1.1\\nHost: cgc-ga4gh-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5436eb8f1273259740f75\",\n \"language\": \"http\",\n \"name\": null\n },\n {\n \"code\": \"GET /ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9c HTTP/1.1\\nHost: cgc-ga4gh-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5336ea8f1273259740f75\",\n \"language\": \"curl\",\n \"name\": \"cURL\"\n }\n ],\n \"sidebar\": true\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Key\",\n \"h-1\": \"Description of value\",\n \"0-0\": \"`X-SBG-Auth-Token`\\n_required_\",\n \"0-1\": \"Your CGC [authentication token](doc:get-your-authentication-token).\",\n \"h-2\": \"\"\n },\n \"cols\": 2,\n \"rows\": 1\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Key\",\n \"h-1\": \"Description of value\",\n \"h-2\": \"Description of value\",\n \"0-0\": \"`object_id`\",\n \"0-1\": \"The ID of the DRS object i.e. file in your project.\",\n \"0-2\": \"If true and a file exists in the given location on the volume (respecting volume prefix if given), the API will attempt to delete the existing file on the volume before exporting.\\n\\n_default_: `false`\"\n },\n \"cols\": 2,\n \"rows\": 1\n}\n[/block]\n##Response\n\n[See a list of CGC-specific response codes that may be contained in the body of the response](doc:api-status-codes). \n\n###Response body\n\nThe response object contains information about the DRS object. The information is structured using the following key-value pairs:\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Key\",\n \"h-1\": \"Data type of value\",\n \"h-2\": \"Description of value\",\n \"0-0\": \"`id`\",\n \"0-1\": \"String\",\n \"1-1\": \"String\",\n \"1-0\": \"`name`\",\n \"2-0\": \"`size`\",\n \"2-1\": \"String\",\n \"4-0\": \"`self_uri`\",\n \"4-1\": \"String\",\n \"7-0\": \"`mime_type`\",\n \"7-1\": \"String\",\n \"8-0\": \"`access_methods`\",\n \"8-1\": \"\",\n \"0-2\": \"ID of the DRS object.\",\n \"1-2\": \"The name of the DRS object.\",\n \"2-2\": \"The size of the file.\",\n \"4-2\": \"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.\",\n \"7-2\": \"Information about the file type.\",\n \"8-2\": \"This dictionary contains these fields:\\n\\n`type` - Type of the access method.\\n`region` - Name of the region in the cloud service provider that the object belongs to.\\n`access_id` - An arbitrary string to be passed to the /access method to get an AccessURL.\",\n \"5-0\": \"`created_time`\",\n \"5-1\": \"String\",\n \"3-0\": \"`checksums`\",\n \"3-1\": \"Dictionary\",\n \"6-0\": \"`updated_time`\",\n \"6-1\": \"String\",\n \"3-2\": \"This dictionary contains two fields:\\n* type\\n* checksum\",\n \"6-2\": \"The time and date the object was last updated.\",\n \"5-2\": \"The time and date the object was originally created.\"\n },\n \"cols\": 3,\n \"rows\": 9\n}\n[/block]\n###Example response body\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"id\\\": \\\"5c24cd21e4b08832c2f94e9c\\\",\\n \\\"name\\\": \\\"7ee5a028a6bc0812b1b10aec200b57ac_gdc_realn.bam\\\",\\n \\\"size\\\": 11305017366,\\n \\\"checksums\\\": [\\n {\\n \\\"type\\\": \\\"etag\\\",\\n \\\"checksum\\\": \\\"4c555f6a344a35dd75fa4086bb94dccb-43\\\"\\n }\\n ],\\n \\\"self_uri\\\": \\\"drs://cgc-ga4gh-api.sbgenomics.com/5c24cd21e4b08832c2f94e9c\\\",\\n \\\"created_time\\\": \\\"2018-12-27T13:01:21Z\\\",\\n \\\"updated_time\\\": \\\"2018-12-27T13:01:21Z\\\",\\n \\\"mime_type\\\": \\\"application/json\\\",\\n \\\"access_methods\\\": [\\n {\\n \\\"type\\\": \\\"s3\\\",\\n \\\"region\\\": \\\"us-east-1\\\",\\n \\\"access_id\\\": \\\"aws-us-east-1\\\"\\n }\\n ]\\n}\",\n \"language\": \"json\",\n \"name\": \"Example response body\"\n }\n ],\n \"sidebar\": true\n}\n[/block]","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5db6f09a1ceb850043e49bb3","project":"55faf11ba62ba1170021a9a7","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f","5c222bed4bc358002f21459a","5c22412594a2a5005cc9e919","5c41ae1c33592700190a291e","5c8a525e2ba7b2003f9b153c","5cbf14d58c79c700ef2b502e","5db6f03a6e187c006f667fa4","5f894c7d3b0894006477ca01","6176d5bf8f59c6001038c2f7"],"_id":"55faf11ba62ba1170021a9aa","releaseDate":"2015-09-17T16:58:03.490Z","createdAt":"2015-09-17T16:58:03.490Z","project":"55faf11ba62ba1170021a9a7","__v":48},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"DRS API","slug":"drs-api","order":39,"from_sync":false,"reference":false,"_id":"5db6f03a6e187c006f667fa4","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","createdAt":"2019-10-28T13:42:18.754Z","__v":0},"user":"566590c83889610d0008a253","createdAt":"2019-10-28T13:43:54.305Z","__v":1,"parentDoc":null}