{"_id":"5804cc101642890f0080360d","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":38,"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","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"parentDoc":null,"project":"55faf11ba62ba1170021a9a7","__v":0,"user":"566590c83889610d0008a253","category":{"_id":"5804caf792398f0f00e77521","__v":0,"project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","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)"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-17T13:03:12.223Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":1,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"This page documents the Advance Access version (think \\\"beta\\\" but with fewer bugs) of the folders functionality.\",\n  \"title\": \"Heads Up!\"\n}\n[/block]\nThis call creates a new folder.\n\nEvery project on the CGC is represented by a root folder which contains all the files associated with a particular project. You can create nesting folders and subfolders within this root folder by using this API request.\n\nOnce you've created a folder, you can [copy](doc:copy-a-file-between-folders) or [move](move-a-file-between-folders) files between folders to populate your newly created folder.\n\nTo list the contents of the main project folder, first make the API request to [get project details](doc:get-project-details) which will return the ID of the main folder (key: `root_folder`). Next, use the [list folder contents](doc:list-folder-contents) call and specify this ID.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cgc-api.sbgenomics.com/v2/files\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v2/files HTTP/1.1\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\nContent-Type: application/json\\nX-SBG-advance-access: advance\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -X POST -H \\\"X-SBG-Auth-Token: c2e05946fb9a494ab5c19c72a94cb4ac\\\" -H \\\"x-sbg-advance-access: advance\\\" -H \\\"Content-Type: application/json\\\" -d '{\\n    \\\"name\\\" : \\\"my new folder\\\",\\n    \\\"type\\\" : \\\"folder\\\",\\n    \\\"parent\\\": \\\"57fb98c51c94d72f08ba0544\\\"\\n}\",\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 CGC [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\\n*required* \",\n    \"2-1\": \"`advance`\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n###Request body\nIn the request body, you should enter the following list of key-value pairs:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`name`\\n_required_\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The name of the folder. It shouldn't begin with \\\"__\\\".\",\n    \"1-0\": \"`type`\\n_required_\",\n    \"1-1\": \"Enum\",\n    \"1-2\": \"`folder`\",\n    \"2-0\": \"`parent`\",\n    \"2-1\": \"String\",\n    \"2-2\": \"Specifies the ID of the parent folder for the new folder. \\n\\nYou should either specify a parent folder or the project name (see [List folder contents](doc:list-folder-contents) for instructions on how to find the folder ID).\",\n    \"3-0\": \"project\",\n    \"3-1\": \"String\",\n    \"3-2\": \"Project ID (`username/project_name`). \\n\\nYou should either specify a project name or the parent folder ID.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n###Example request body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"name\\\": \\\"my new folder\\\", \\n  \\\"parent\\\": \\\"57fba0611c94d72f08ba0550\\\",\\n  \\\"type\\\": \\\"FOLDER\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\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/57fba0611c94d72f08ba0550\\\",\\n  \\\"id\\\": \\\"5800b406e4b07ecb1445de83\\\",\\n  \\\"name\\\": \\\"my new folder\\\",\\n  \\\"parent\\\": \\\"57fba0611c94d72f08ba0550\\\",\\n  \\\"type\\\": \\\"FOLDER\\\",\\n  \\\"created_on\\\": \\\"2016-10-10T14:06:25Z\\\",\\n  \\\"modified_on\\\": \\\"2016-10-10T14:06:25Z\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example response body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"/files","slug":"create-a-folder","type":"endpoint","title":"Create a folder"}

postCreate a folder

/files

[block:callout] { "type": "danger", "body": "This page documents the Advance Access version (think \"beta\" but with fewer bugs) of the folders functionality.", "title": "Heads Up!" } [/block] This call creates a new folder. Every project on the CGC is represented by a root folder which contains all the files associated with a particular project. You can create nesting folders and subfolders within this root folder by using this API request. Once you've created a folder, you can [copy](doc:copy-a-file-between-folders) or [move](move-a-file-between-folders) files between folders to populate your newly created folder. To list the contents of the main project folder, first make the API request to [get project details](doc:get-project-details) which will return the ID of the main folder (key: `root_folder`). Next, use the [list folder contents](doc:list-folder-contents) call and specify this ID. [block:code] { "codes": [ { "code": "https://cgc-api.sbgenomics.com/v2/files", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "POST /v2/files 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", "name": null }, { "code": "curl -X POST -H \"X-SBG-Auth-Token: c2e05946fb9a494ab5c19c72a94cb4ac\" -H \"x-sbg-advance-access: advance\" -H \"Content-Type: application/json\" -d '{\n \"name\" : \"my new folder\",\n \"type\" : \"folder\",\n \"parent\": \"57fb98c51c94d72f08ba0544\"\n}", "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 CGC [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\n*required* ", "2-1": "`advance`" }, "cols": 2, "rows": 3 } [/block] ###Request body In the request body, you should enter the following list of key-value pairs: [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Description", "0-0": "`name`\n_required_", "0-1": "String", "0-2": "The name of the folder. It shouldn't begin with \"__\".", "1-0": "`type`\n_required_", "1-1": "Enum", "1-2": "`folder`", "2-0": "`parent`", "2-1": "String", "2-2": "Specifies the ID of the parent folder for the new folder. \n\nYou should either specify a parent folder or the project name (see [List folder contents](doc:list-folder-contents) for instructions on how to find the folder ID).", "3-0": "project", "3-1": "String", "3-2": "Project ID (`username/project_name`). \n\nYou should either specify a project name or the parent folder ID." }, "cols": 3, "rows": 4 } [/block] ###Example request body [block:code] { "codes": [ { "code": "{\n \"name\": \"my new folder\", \n \"parent\": \"57fba0611c94d72f08ba0550\",\n \"type\": \"FOLDER\"\n}", "language": "json" } ] } [/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/57fba0611c94d72f08ba0550\",\n \"id\": \"5800b406e4b07ecb1445de83\",\n \"name\": \"my new folder\",\n \"parent\": \"57fba0611c94d72f08ba0550\",\n \"type\": \"FOLDER\",\n \"created_on\": \"2016-10-10T14:06:25Z\",\n \"modified_on\": \"2016-10-10T14:06:25Z\"\n}", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]