{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"List folder contents","type":"endpoint","slug":"list-folder-contents","excerpt":"files/{folder_id}/list","body":"This call lists the contents of the specified folder.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-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: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\nContent-Type: application/json\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -X GET -H \\\"X-SBG-Auth-Token: c2e05946fb9a494ab5c19c72a94cb4ac\\\" -H \\\"Content-Type: application/json\\\" \\\"http://cavatica-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  },\n  \"cols\": 2,\n  \"rows\": 2\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###Example response body \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/files/57fb98c51c94d72f08ba0544/list?offset=0&limit=5\\\",\\n  \\\"items\\\": [\\n    {\\n      \\\"href\\\": \\\"https://cavatica-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://cavatica-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]","updates":[],"order":44,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5804dc6f1642890f00803627","parentDoc":null,"user":"566590c83889610d0008a253","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"],"_id":"5773dcfc255e820e00e1cd50","__v":27,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"githubsync":"","project":"5773dcfc255e820e00e1cd4d","__v":1,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Cavatica API","slug":"api","order":12,"from_sync":false,"reference":false,"_id":"5773df36904b0c0e00ef05ff","createdAt":"2016-06-29T14:46:14.277Z","version":"5773dcfc255e820e00e1cd50","__v":0,"project":"5773dcfc255e820e00e1cd4d"},"createdAt":"2016-10-17T14:13:03.805Z"}

getList folder contents

files/{folder_id}/list

This call lists the contents of the specified folder. [block:code] { "codes": [ { "code": "https://cavatica-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: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\nContent-Type: application/json", "language": "http", "name": null }, { "code": "curl -X GET -H \"X-SBG-Auth-Token: c2e05946fb9a494ab5c19c72a94cb4ac\" -H \"Content-Type: application/json\" \"http://cavatica-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`" }, "cols": 2, "rows": 2 } [/block] ##Response [See a list of Cavatica-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://cavatica-api.sbgenomics.com/v2/files/57fb98c51c94d72f08ba0544/list?offset=0&limit=5\",\n \"items\": [\n {\n \"href\": \"https://cavatica-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://cavatica-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]