{"_id":"5b0e13ffc4664e0003c75bc5","project":"5b0e13ffc4664e0003c75a66","category":{"_id":"5b0e13ffc4664e0003c75a75","project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":32,"slug":"api","title":"API Reference"},"user":"554340dfb7f4540d00fcef1d","version":{"_id":"5b0e13ffc4664e0003c75a67","project":"5b0e13ffc4664e0003c75a66","__v":4,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["5b0e13ffc4664e0003c75a68","5b0e13ffc4664e0003c75a69","5b0e13ffc4664e0003c75a6a","5b0e13ffc4664e0003c75a6b","5b0e13ffc4664e0003c75a6c","5b0e13ffc4664e0003c75a6d","5b0e13ffc4664e0003c75a6e","5b0e13ffc4664e0003c75a6f","5b0e13ffc4664e0003c75a70","5b0e13ffc4664e0003c75a71","5b0e13ffc4664e0003c75a72","5b0e13ffc4664e0003c75a73","5b0e13ffc4664e0003c75a74","5b0e13ffc4664e0003c75a75","5b0e13ffc4664e0003c75a76","5b0e13ffc4664e0003c75a77","5b0e13ffc4664e0003c75a89","5b0e13ffc4664e0003c75a8a","5b0e13ffc4664e0003c75a9d","5b0e13ffc4664e0003c75a9e","5b0e13ffc4664e0003c75a9f","5b0e13ffc4664e0003c75aa0","5b0e13ffc4664e0003c75aa1","5b0e13ffc4664e0003c75aa2","5b0e13ffc4664e0003c75aa3","5b0e13ffc4664e0003c75aa4","5b0e13ffc4664e0003c75aa5","5b0e13ffc4664e0003c75aa6","5b0e13ffc4664e0003c75aa7","5b0e13ffc4664e0003c75aa8","5b0e13ffc4664e0003c75aa9","5b0e13ffc4664e0003c75aaa","5b0e13ffc4664e0003c75aab","5b0e13ffc4664e0003c75aac","5b0e13ffc4664e0003c75aad","5b0e13ffc4664e0003c75aae","5b0e13ffc4664e0003c75aaf","5b0e13ffc4664e0003c75ab2","5bb3374f4306ad0003eb18e7","5bbf3c5373e72a000318362b","5bc065567d1cb0000384c649","5cbf19a5f9181f0033fbb968"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":0,"parentDoc":null,"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-29T21:19:56.682Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":31,"body":"This call returns details about a specified file. The call returns the file's name, its tags, and all of its metadata.\n\nFiles are specified by their IDs, which you can obtain by making the API call to [list files in a project ](doc:list-files-in-a-project).\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://f4c-api.sbgenomics.com/v2/files/{file_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 /v2/files/598033fb2094fbf1b3b0bce4 HTTP/1.1\\nHost: f4c-api.sbgenomics.com\\nX-SBG-Auth-Token: 565357a1e4b09c884b29334a\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl  -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"content-type: application/json\\\" -X GET \\\"https://f4c-api.sbgenomics.com/v2/files/565357a1e4b09c884b29334a\\\"\",\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\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`X-SBG-Auth-Token`\\n_required_\",\n    \"0-1\": \"Your Platform [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\",\n    \"1-0\": \"`X-SBG-Advance-Access`\\n*optional*\",\n    \"1-1\": \"`advance`\\n\\nUse this field if you want to return the parent folder ID.\\n\\nThis field is a part of the [advance access functionality for managing folders](doc:folders-overview) on the Seven Bridges Platform.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`file_id`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The ID of the file whose details you want to GET.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`fields`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Selector specifying a subset of fields to include in the response.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n##Response\n\n[See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) \n\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/files/5d4ad1e1e4b0bd9de3154f1e\\\",\\n    \\\"id\\\": \\\"5d4ad1e1e4b0bd9de3154f1e\\\",\\n    \\\"name\\\": \\\"chr20.intervals\\\",\\n    \\\"size\\\": 5,\\n    \\\"project\\\": \\\"rfranklin/my-project\\\",\\n    \\\"parent\\\": \\\"5d4ad1b1e4b05e2cb95903ec\\\",\\n    \\\"type\\\": \\\"file\\\",\\n    \\\"created_on\\\": \\\"2019-08-07T13:28:01Z\\\",\\n    \\\"modified_on\\\": \\\"2019-08-07T13:28:01Z\\\",\\n    \\\"storage\\\": {\\n        \\\"type\\\": \\\"PLATFORM\\\",\\n        \\\"hosted_on_locations\\\": [\\n            \\\"aws:us-east-1\\\",\\n            \\\"google:us-west1\\\"\\n        ]\\n    },\\n    \\\"origin\\\": {},\\n    \\\"tags\\\": [\\n        \\\"tag\\\"\\n    ],\\n    \\\"metadata\\\": {\\n        \\\"md5_sum\\\": \\\"3feb601b4b6d63db86669175f921463b\\\",\\n        \\\"sbg_public_files_category\\\": \\\"reference\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\nInterpreting the response body:\n\n* The object `origin` denotes the origin of the file, such as the task which produced it or the dataset to which the file belongs.\n* The dictionary object `metadata` lists the metadata fields and values for the file.\n* The object `tags` lists the tags for the file. Learn more about [tagging your files](tag-your-files) on the Platform.","excerpt":"/files/{file_id}","slug":"get-file-details","type":"endpoint","title":"Get file details"}

getGet file details

/files/{file_id}

This call returns details about a specified file. The call returns the file's name, its tags, and all of its metadata. Files are specified by their IDs, which you can obtain by making the API call to [list files in a project ](doc:list-files-in-a-project). [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/files/{file_id}", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/files/598033fb2094fbf1b3b0bce4 HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 565357a1e4b09c884b29334a\n", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X GET \"https://f4c-api.sbgenomics.com/v2/files/565357a1e4b09c884b29334a\"", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`X-SBG-Auth-Token`\n_required_", "0-1": "Your Platform [authentication token](doc:get-your-authentication-token).", "h-2": "", "1-0": "`X-SBG-Advance-Access`\n*optional*", "1-1": "`advance`\n\nUse this field if you want to return the parent folder ID.\n\nThis field is a part of the [advance access functionality for managing folders](doc:folders-overview) on the Seven Bridges Platform." }, "cols": 2, "rows": 2 } [/block] ###Path parameters [block:parameters] { "data": { "0-0": "`file_id`", "h-0": "Name", "h-1": "Description", "0-1": "The ID of the file whose details you want to GET." }, "cols": 2, "rows": 1 } [/block] ###Query parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Description", "0-0": "`fields`", "0-1": "string", "0-2": "Selector specifying a subset of fields to include in the response." }, "cols": 3, "rows": 1 } [/block] ##Response [See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body [block:code] { "codes": [ { "code": "{\n \"href\": \"https://f4c-api.sbgenomics.com/v2/files/5d4ad1e1e4b0bd9de3154f1e\",\n \"id\": \"5d4ad1e1e4b0bd9de3154f1e\",\n \"name\": \"chr20.intervals\",\n \"size\": 5,\n \"project\": \"rfranklin/my-project\",\n \"parent\": \"5d4ad1b1e4b05e2cb95903ec\",\n \"type\": \"file\",\n \"created_on\": \"2019-08-07T13:28:01Z\",\n \"modified_on\": \"2019-08-07T13:28:01Z\",\n \"storage\": {\n \"type\": \"PLATFORM\",\n \"hosted_on_locations\": [\n \"aws:us-east-1\",\n \"google:us-west1\"\n ]\n },\n \"origin\": {},\n \"tags\": [\n \"tag\"\n ],\n \"metadata\": {\n \"md5_sum\": \"3feb601b4b6d63db86669175f921463b\",\n \"sbg_public_files_category\": \"reference\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] Interpreting the response body: * The object `origin` denotes the origin of the file, such as the task which produced it or the dataset to which the file belongs. * The dictionary object `metadata` lists the metadata fields and values for the file. * The object `tags` lists the tags for the file. Learn more about [tagging your files](tag-your-files) on the Platform.