{"_id":"56328aaf49e16d0d00122425","category":{"_id":"55faf9aa17b9d00d00969f49","pages":["56312d239ead230d00a188f2","56312e0d82d96a0d00b0fb08","56315777fc94aa0d00e9b553","56315b779ead230d00a1894a","5631657c9c25801700dac34f","56317884fc94aa0d00e9b586","56318386c3b04b0d00ba9bb9","563240ccdcc27a170082363b","563240dfbddb091700ad5e82","563240edfe9acd1900cc1d10","56324504fa40240d007c8d5f","56324b30c3b04b0d00ba9c96","563273ae45f2cb0d006be3fa","563273c08c9cda0d0025266d","563273cc38f8aa0d00d30f55","563273d838f8aa0d00d30f59","5632740945f2cb0d006be3fc","56327411df556c0d00cd0905","5632741b8c9cda0d0025266f","563274ea10b6040d008793d8","5632757cdf556c0d00cd0908","563275b710b6040d008793da","563275f938f8aa0d00d30f60","5632762fb904a10d0032f6fc","5632767110b6040d008793dd","563276c0b904a10d0032f700","5632770162c48a0d00334d53","5632843d8c9cda0d00252698","5632846e62c48a0d00334d78","56328a7e49e16d0d00122420","56328aaf49e16d0d00122425","56328b2238f8aa0d00d30f88","56328b6c8c9cda0d002526a2","56328c0710b6040d008793ff","56328c3710b6040d00879401","56328c5938f8aa0d00d30f8c","56328c90b904a10d0032f722","56328cc449e16d0d0012242a","56328ce68c9cda0d002526a8","56328d1338f8aa0d00d30f8e","56328d5810b6040d00879407","56328d7cdf556c0d00cd092f","56328d9a10b6040d00879409","56328db438f8aa0d00d30f92","56328dd762c48a0d00334d8b","56328df649e16d0d0012242d","56328e1edf556c0d00cd0931","56328e4662c48a0d00334d8e","56328e5edf556c0d00cd0933","56328e8f8c9cda0d002526ab","56328eb3b904a10d0032f72a","56328edb38f8aa0d00d30f95","56328ef210b6040d0087940d","56328f148c9cda0d002526ad","56328f2962c48a0d00334d90","56328f54b904a10d0032f72c","56328f6c38f8aa0d00d30f98","56328f858c9cda0d002526af","56328fae62c48a0d00334d95","56328fd838f8aa0d00d30f9c","5637f069ee0ee60d0024ec18","5641ffaa9417b40d00c0fc35","564355240d9748190079dea9","5644cfeb2c74cf1900da4831","56450f856b0ca50d00f6bd8f","56706537cbb2fb0d00f7c7dd","567065bc3d29830d00376213","56706fc2cbb2fb0d00f7c87e","568bf5a1e662f40d00eee866","568c0699e662f40d00eee881","568cff0274c77f2d00d56d51","568d10f58602880d001ce277","568d2abc37b636250036b904","568d343413c5ad0d00b34efb","568d593a8602880d001ce2d3","568e64135e12fb0d00325160","568e66f05e12fb0d00325162","568e78aa5e12fb0d0032517a","569433cfd8c04d1700e5ae0c","56943723d8c04d1700e5ae14","5694393b3e9d080d00f0655d","5694e6cf953b810d008f91bc","5694f301c5c5ce0d00058e68","569502ef9797fa1900f704e7","5695063bcaa32519009c40b3","569511cccaa32519009c40d9","569557e2fcb1032d0089dfe2","569562fefcb1032d0089dfee","56956428fe18811700c9c058","569639b87596a90d0014e5a3","56a90197e590350d004b5103","56a9021e9ec7660d002e08c2"],"project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":92,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":27,"slug":"api","title":"API Reference"},"__v":17,"project":"55faf11ba62ba1170021a9a7","user":"554340dfb7f4540d00fcef1d","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":37,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-29T21:07:59.409Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[],"url":""},"isReference":true,"order":18,"body":"This call returns the details of a specified project.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cgc-api.sbgenomics.com/v2/projects/{project_owner}/{project}\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Referring to your project\",\n  \"body\": \"Note that `project_owner` is always case-sensitive, and that `project` is not the project's name but its short name. For full details of identifying objects using the API, please see the [API overview](the-cgc-api#section-identifying-projects-users-apps-files-tasks-and-inputs).\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/projects/rfranklin/my-project HTTP/1.1\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\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://cgc-api.sbgenomics.com/v2/projects/RFranklinate/my-project\\\"\",\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<span style=\\\"color:red\\\"><i>required</i></span>\",\n    \"0-1\": \"Your CGC [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 to return the ID of the project root folder.\\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\": \"`project`\",\n    \"1-0\": \"`project_owner`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The short name of the project you are querying.\",\n    \"1-1\": \"The owner of the project you are querying.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\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 CGC-specific response codes that may be contained in the body of the response.](doc:api-status-codes) \n\n###Example response body\n\nThis example response body displays the JSON returned when the `fields` parameter in the request is set to `_all`.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"http://cgc-api.sbgenomics.com/v2/projects/rfranklin/rfranklin-s-demo-project\\\",\\n  \\\"id\\\": \\\"rfranklin/rfranklin-s-demo-project\\\",\\n  \\\"name\\\": \\\"rfranklin's Demo Project\\\",\\n  \\\"type\\\": \\\"v2\\\",\\n  \\\"description\\\": \\\"This project contains data, completed analyses, and results.\\\\n\\\\Contains WGS, WES, and two different RNA-Seq read alignments - STAR and TopHat, fusion transcript detection analysis using ChimeraScan, FASTQ quality control and more.\\\\n\\\\n Open it up and  take a look.\\\",\\n  \\\"tags\\\": [],\\n  \\\"settings\\\": {\\n    \\\"locked\\\": false,\\n    \\\"controlled\\\": true\\n  },\\n  \\\"permissions\\\": {\\n    \\\"write\\\": true,\\n    \\\"read\\\": true,\\n    \\\"copy\\\": true,\\n    \\\"execute\\\": true,\\n    \\\"admin\\\": true\\n  },\\n  \\\"billing_group\\\": \\\"c567f1b8-8846-4e8d-a3d8-1d3037132310\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n**Interpreting the response body**\n* The object `type` in the response should be ignored: all projects have type `v2`.\n* The object `tags` is an array that either contains the string `\"tcga\"` or is empty. If it contains `\"tcga\"` this indicates that the project is a [Controlled Data project](projects-on-the-cgc). Otherwise, the project is Open Data.\n* The dictionary `settings` contains two Boolean field, `locked` and `controlled`. The `locked` field shows whether or not your project is locked. You can lock down a project to prevent any Seven Bridges team member from viewing information about your project. Learn more about [creating a locked project](doc:create-a-new-project#lock). The `controlled` field indicates whether or not the project is a [controlled data project](doc:projects-on-the-cgc#section-controlled-data-project).","excerpt":"/projects/{project_owner}/{project}","slug":"get-project-details","type":"endpoint","title":"Get details of a project"}

getGet details of a project

/projects/{project_owner}/{project}

This call returns the details of a specified project. [block:code] { "codes": [ { "code": "https://cgc-api.sbgenomics.com/v2/projects/{project_owner}/{project}", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:callout] { "type": "success", "title": "Referring to your project", "body": "Note that `project_owner` is always case-sensitive, and that `project` is not the project's name but its short name. For full details of identifying objects using the API, please see the [API overview](the-cgc-api#section-identifying-projects-users-apps-files-tasks-and-inputs)." } [/block] [block:code] { "codes": [ { "code": "GET /v2/projects/rfranklin/my-project HTTP/1.1\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X GET \"https://cgc-api.sbgenomics.com/v2/projects/RFranklinate/my-project\"", "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<span style=\"color:red\"><i>required</i></span>", "0-1": "Your CGC [authentication token](doc:get-your-authentication-token).", "h-2": "", "1-0": "`X-sbg-advance-access`\n*optional*", "1-1": "`advance`\n\nUse this field to return the ID of the project root folder.\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": "`project`", "1-0": "`project_owner`", "h-0": "Name", "h-1": "Description", "0-1": "The short name of the project you are querying.", "1-1": "The owner of the project you are querying." }, "cols": 2, "rows": 2 } [/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 CGC-specific response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body This example response body displays the JSON returned when the `fields` parameter in the request is set to `_all`. [block:code] { "codes": [ { "code": "{\n \"href\": \"http://cgc-api.sbgenomics.com/v2/projects/rfranklin/rfranklin-s-demo-project\",\n \"id\": \"rfranklin/rfranklin-s-demo-project\",\n \"name\": \"rfranklin's Demo Project\",\n \"type\": \"v2\",\n \"description\": \"This project contains data, completed analyses, and results.\\n\\Contains WGS, WES, and two different RNA-Seq read alignments - STAR and TopHat, fusion transcript detection analysis using ChimeraScan, FASTQ quality control and more.\\n\\n Open it up and take a look.\",\n \"tags\": [],\n \"settings\": {\n \"locked\": false,\n \"controlled\": true\n },\n \"permissions\": {\n \"write\": true,\n \"read\": true,\n \"copy\": true,\n \"execute\": true,\n \"admin\": true\n },\n \"billing_group\": \"c567f1b8-8846-4e8d-a3d8-1d3037132310\"\n}", "language": "json" } ], "sidebar": true } [/block] **Interpreting the response body** * The object `type` in the response should be ignored: all projects have type `v2`. * The object `tags` is an array that either contains the string `"tcga"` or is empty. If it contains `"tcga"` this indicates that the project is a [Controlled Data project](projects-on-the-cgc). Otherwise, the project is Open Data. * The dictionary `settings` contains two Boolean field, `locked` and `controlled`. The `locked` field shows whether or not your project is locked. You can lock down a project to prevent any Seven Bridges team member from viewing information about your project. Learn more about [creating a locked project](doc:create-a-new-project#lock). The `controlled` field indicates whether or not the project is a [controlled data project](doc:projects-on-the-cgc#section-controlled-data-project).