{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Get info about a DRS object","type":"basic","slug":"get-info-about-a-drs-object","excerpt":"","body":"This call will return the details of a DRS object.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Please note that a different endpoint is used for the purpose of retrieving information about a DRS object (https://cavatica-ga4gh-api.sbgenomics.com/ga4gh/drs/v1/).\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-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: cavatica-ga4gh-api.sbgenomics.com\\nAuthorization: Bearer 3cfa44f5d2d4418b88018e88b795189b\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"GET /ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9c HTTP/1.1\\nHost: cavatica-ga4gh-api.sbgenomics.com\\nAuthorization: Bearer 3cfa44f5d2d4318b88018e98b795189b\\nHost: cavatica-ga4gh-api.sbgenomics.com\",\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\": \"`Authorization`\\n_required_\",\n    \"0-1\": \"Your Cavatica[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. a 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 Cavatica-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://cavatica-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":"5dc1573b860919004f9a0abd","project":"5773dcfc255e820e00e1cd4d","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5773dcfc255e820e00e1cd51","5773df36904b0c0e00ef05ff","577baf92451b1e0e006075ac","577bb183b7ee4a0e007c4e8d","577ce77a1cf3cb0e0048e5ea","577d11865fd4de0e00cc3dab","578e62792c3c790e00937597","578f4fd98335ca0e006d5c84","578f5e5c3d04570e00976ebb","57bc35f7531e000e0075d118","57f801b3760f3a1700219ebb","5804d55d1642890f00803623","581c8d55c0dc651900aa9350","589dcf8ba8c63b3b00c3704f","594cebadd8a2f7001b0b53b2","59a562f46a5d8c00238e309a","5a2aa096e25025003c582b58","5a2e79566c771d003ca0acd4","5a3a5166142db90026f24007","5a3a52b5bcc254001c4bf152","5a3a574a2be213002675c6d2","5a3a66bb2be213002675cb73","5a3a6e4854faf60030b63159","5c8a68278e883901341de571","5cb9971e57bf020024523c7b","5cbf1683e2a36d01d5012ecd","5dc15666a4f788004c5fd7d7","5eaff69e844d67003642a020","5eb00899b36ba5002d35b0c1","5eb0172be179b70073dc936e","5eb01b42b36ba5002d35ebba","5eb01f202654a20136813093","5eb918ef149186021c9a76c8","5f0839d3f4b24e005ebbbc29"],"_id":"5773dcfc255e820e00e1cd50","__v":34,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"DRS API","slug":"drs-api","order":24,"from_sync":false,"reference":false,"_id":"5dc15666a4f788004c5fd7d7","project":"5773dcfc255e820e00e1cd4d","version":"5773dcfc255e820e00e1cd50","createdAt":"2019-11-05T11:00:54.262Z","__v":0},"user":"566590c83889610d0008a253","createdAt":"2019-11-05T11:04:27.089Z","__v":0,"parentDoc":null}

Get info about a DRS object


This call will return the details of a DRS object. [block:callout] { "type": "info", "body": "Please note that a different endpoint is used for the purpose of retrieving information about a DRS object (https://cavatica-ga4gh-api.sbgenomics.com/ga4gh/drs/v1/)." } [/block] [block:code] { "codes": [ { "code": "https://cavatica-ga4gh-api.sbgenomics.com/ga4gh/drs/v1/objects/{object_id}", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9c HTTP/1.1\nHost: cavatica-ga4gh-api.sbgenomics.com\nAuthorization: Bearer 3cfa44f5d2d4418b88018e88b795189b", "language": "http", "name": null }, { "code": "GET /ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9c HTTP/1.1\nHost: cavatica-ga4gh-api.sbgenomics.com\nAuthorization: Bearer 3cfa44f5d2d4318b88018e98b795189b\nHost: cavatica-ga4gh-api.sbgenomics.com", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Key", "h-1": "Description of value", "0-0": "`Authorization`\n_required_", "0-1": "Your Cavatica[authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Path parameters [block:parameters] { "data": { "h-0": "Key", "h-1": "Description of value", "h-2": "Description of value", "0-0": "`object_id`", "0-1": "The ID of the DRS object i.e. a file in your project.", "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`" }, "cols": 2, "rows": 1 } [/block] ##Response [See a list of Cavatica-specific response codes that may be contained in the body of the response](doc:api-status-codes). ###Response body The response object contains information about the DRS object. The information is structured using the following key-value pairs: [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type of value", "h-2": "Description of value", "0-0": "`id`", "0-1": "String", "1-1": "String", "1-0": "`name`", "2-0": "`size`", "2-1": "String", "4-0": "`self_uri`", "4-1": "String", "7-0": "`mime_type`", "7-1": "String", "8-0": "`access_methods`", "8-1": "", "0-2": "ID of the DRS object.", "1-2": "The name of the DRS object.", "2-2": "The size of the file.", "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.", "7-2": "Information about the file type.", "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.", "5-0": "`created_time`", "5-1": "String", "3-0": "`checksums`", "3-1": "Dictionary", "6-0": "`updated_time`", "6-1": "String", "3-2": "This dictionary contains two fields:\n* type\n* checksum", "6-2": "The time and date the object was last updated.", "5-2": "The time and date the object was originally created." }, "cols": 3, "rows": 9 } [/block] ###Example response body [block:code] { "codes": [ { "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://cavatica-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}", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]