{"_id":"5b0e13ffc4664e0003c75bcc","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"},"__v":0,"project":"5b0e13ffc4664e0003c75a66","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"},"parentDoc":null,"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-29T21:07:59.409Z","link_external":false,"link_url":"","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://f4c-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: f4c-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://f4c-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 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 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 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://f4c-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    \\\"use_interruptible_instances\\\": 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-platform). 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-platform#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://f4c-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: f4c-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://f4c-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 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 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 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://f4c-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 \"use_interruptible_instances\": 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-platform). 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-platform#section-controlled-data-project).