{"__v":0,"_id":"5804cce77d46550f002b1106","category":{"project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","_id":"5804caf792398f0f00e77521","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-17T12:58:31.759Z","from_sync":false,"order":30,"slug":"folders-api-advance-access","title":"FOLDERS API (Advance Access)"},"parentDoc":null,"project":"55faf11ba62ba1170021a9a7","user":"566590c83889610d0008a253","version":{"__v":35,"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-17T13:06:47.924Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":2,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Heads Up!\",\n  \"body\": \"This page documents the Advance Access version (think \\\"beta\\\" but with fewer bugs) of the folders functionality.\"\n}\n[/block]\nThis call lists the contents of the specified folder.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cgc-api.sbgenomics.com/v2/files/{folder_id}/list\",\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/6282d5e2121d43e7900e9d52b15845e7/list HTTP/1.1\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\nContent-Type: application/json\\nX-SBG-advance-access: advance\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -X GET -H \\\"X-SBG-Auth-Token: c2e05946fb9a494ab5c19c72a94cb4ac\\\" -H \\\"x-sbg-advance-access: advance\\\" -H \\\"Content-Type: application/json\\\" \\\"http://cgc-api.sbgenomics.com/v2/files/57fb98c51c94d72f08ba0544/list\\\"\",\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 Seven Bridges Platform [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\",\n    \"1-0\": \"`Content-Type`\\n*required*\",\n    \"1-1\": \"`application/json`\",\n    \"2-0\": \"`X-SBG-Advance-Access`\\nrequired\",\n    \"2-1\": \"`advance`\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\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###Example response body \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/files/57fb98c51c94d72f08ba0544/list?offset=0&limit=5\\\",\\n  \\\"items\\\": [\\n    {\\n      \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/files/57fba0581c94d72f08ba054e\\\",\\n      \\\"id\\\": \\\"57fba0581c94d72f08ba054e\\\",\\n      \\\"name\\\": \\\"folder-name-1\\\",\\n      \\\"project\\\": \\\"rfranklin/my-project\\\",\\n      \\\"parent\\\": \\\"57fb98c51c94d72f08ba0544\\\",\\n      \\\"type\\\": \\\"FOLDER\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/files/57fba04c1c94d72f08ba054a\\\",\\n      \\\"id\\\": \\\"57fba04c1c94d72f08ba054a\\\",\\n      \\\"name\\\": \\\"file-name-1\\\",\\n      \\\"project\\\": \\\"rfranklin/my-project\\\",\\n      \\\"parent\\\": \\\"57fb98c51c94d72f08ba0544\\\",\\n      \\\"type\\\": \\\"FILE\\\"\\n    },\",\n      \"language\": \"json\",\n      \"name\": \"Example response body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"files/{folder_id}/list","slug":"list-folder-contents","type":"get","title":"List folder contents"}

getList folder contents

files/{folder_id}/list

[block:callout] { "type": "danger", "title": "Heads Up!", "body": "This page documents the Advance Access version (think \"beta\" but with fewer bugs) of the folders functionality." } [/block] This call lists the contents of the specified folder. [block:code] { "codes": [ { "code": "https://cgc-api.sbgenomics.com/v2/files/{folder_id}/list", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/files/6282d5e2121d43e7900e9d52b15845e7/list HTTP/1.1\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\nContent-Type: application/json\nX-SBG-advance-access: advance", "language": "http", "name": null }, { "code": "curl -X GET -H \"X-SBG-Auth-Token: c2e05946fb9a494ab5c19c72a94cb4ac\" -H \"x-sbg-advance-access: advance\" -H \"Content-Type: application/json\" \"http://cgc-api.sbgenomics.com/v2/files/57fb98c51c94d72f08ba0544/list\"", "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 Seven Bridges Platform [authentication token](doc:get-your-authentication-token).", "h-2": "", "1-0": "`Content-Type`\n*required*", "1-1": "`application/json`", "2-0": "`X-SBG-Advance-Access`\nrequired", "2-1": "`advance`" }, "cols": 2, "rows": 3 } [/block] ##Response [See a list of CGC-specific 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://cgc-api.sbgenomics.com/v2/files/57fb98c51c94d72f08ba0544/list?offset=0&limit=5\",\n \"items\": [\n {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/files/57fba0581c94d72f08ba054e\",\n \"id\": \"57fba0581c94d72f08ba054e\",\n \"name\": \"folder-name-1\",\n \"project\": \"rfranklin/my-project\",\n \"parent\": \"57fb98c51c94d72f08ba0544\",\n \"type\": \"FOLDER\"\n },\n {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/files/57fba04c1c94d72f08ba054a\",\n \"id\": \"57fba04c1c94d72f08ba054a\",\n \"name\": \"file-name-1\",\n \"project\": \"rfranklin/my-project\",\n \"parent\": \"57fb98c51c94d72f08ba0544\",\n \"type\": \"FILE\"\n },", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]