{"_id":"5b0e13ffc4664e0003c75c29","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"},"__v":0,"parentDoc":null,"user":"554340dfb7f4540d00fcef1d","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"},"project":"5b0e13ffc4664e0003c75a66","githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-06T15:35:16.779Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[],"url":""},"isReference":true,"order":29,"body":"This call lists the files in the specified project. It is an alias for the call [GET /files](doc:list-files-in-a-project) and redirects to that path. \n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Alias call\",\n  \"body\": \"Note that since this is an alias for another call, the call cannot be made straightforwardly from all applications. In particular, to send the call using cURL, use the [cURL option `-L`](http://curl.haxx.se/docs/manpage.html#-L) to redirect the path of this call to `https://cgc-api.sbgenomics.com/v2/files?{project_owner}/{project}. \\n\\nAlternatively, to list all files, you can simply use the call [GET /files](doc:list-files-in-a-project).\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://f4c-api.sbgenomics.com/v2/projects/{project_owner}/{project}/files\",\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 ID, or short name. For full details of identifying objects using the API, please see the [API overview](doc:the-api#section-identifying-projects-users-apps-files-and-tasks).\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/projects/rfranklin/my-project/files 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 -L \\\"https://cgc-api.sbgenomics.com/v2/files?RFranklin/my-project\\\"  -s -H \\\"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\\\" -H \\\"content-type: application/json\\\" -X GET \\\"https://f4c-api.sbgenomics.com/v2/projects/RFranklin/my-project/files\\\"\",\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 Platform [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\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[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/files/?offset=0&limit=25&project=RFranklin/my-project\\\",\\n  \\\"items\\\": [\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/files/568cf5dce4b0307bc0462060\\\",\\n      \\\"id\\\": \\\"568cf5dce4b0307bc0462060\\\",\\n      \\\"name\\\": \\\"my_reference.vcf\\\",\\n      \\\"project\\\": \\\"RFranklin/my-project\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/files/566aad1de4b0c560b469ea80\\\",\\n      \\\"id\\\": \\\"566aad1de4b0c560b469ea80\\\",\\n      \\\"name\\\": \\\"_1_unsorted.bam\\\",\\n      \\\"project\\\": \\\"RFranklin/my-project\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/files/568cf5f4e4b0307bc0462062\\\",\\n      \\\"id\\\": \\\"568cf5f4e4b0307bc0462062\\\",\\n      \\\"name\\\": \\\"unsorted.bam\\\",\\n      \\\"project\\\": \\\"RFranklin/my-project\\\"\\n    }\\n  ],\\n  \\\"links\\\": []\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"projects/{project_owner}/{project_name}/files","slug":"list-files-secondary-method","type":"endpoint","title":"List files (secondary method)"}

getList files (secondary method)

projects/{project_owner}/{project_name}/files

This call lists the files in the specified project. It is an alias for the call [GET /files](doc:list-files-in-a-project) and redirects to that path. [block:callout] { "type": "danger", "title": "Alias call", "body": "Note that since this is an alias for another call, the call cannot be made straightforwardly from all applications. In particular, to send the call using cURL, use the [cURL option `-L`](http://curl.haxx.se/docs/manpage.html#-L) to redirect the path of this call to `https://cgc-api.sbgenomics.com/v2/files?{project_owner}/{project}. \n\nAlternatively, to list all files, you can simply use the call [GET /files](doc:list-files-in-a-project)." } [/block] [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/projects/{project_owner}/{project}/files", "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 ID, or short name. For full details of identifying objects using the API, please see the [API overview](doc:the-api#section-identifying-projects-users-apps-files-and-tasks)." } [/block] [block:code] { "codes": [ { "code": "GET /v2/projects/rfranklin/my-project/files HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "code": " curl -L \"https://cgc-api.sbgenomics.com/v2/files?RFranklin/my-project\" -s -H \"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\" -H \"content-type: application/json\" -X GET \"https://f4c-api.sbgenomics.com/v2/projects/RFranklin/my-project/files\"", "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 Platform [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/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 [block:code] { "codes": [ { "code": "{\n \"href\": \"https://f4c-api.sbgenomics.com/v2/files/?offset=0&limit=25&project=RFranklin/my-project\",\n \"items\": [\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/files/568cf5dce4b0307bc0462060\",\n \"id\": \"568cf5dce4b0307bc0462060\",\n \"name\": \"my_reference.vcf\",\n \"project\": \"RFranklin/my-project\"\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/files/566aad1de4b0c560b469ea80\",\n \"id\": \"566aad1de4b0c560b469ea80\",\n \"name\": \"_1_unsorted.bam\",\n \"project\": \"RFranklin/my-project\"\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/files/568cf5f4e4b0307bc0462062\",\n \"id\": \"568cf5f4e4b0307bc0462062\",\n \"name\": \"unsorted.bam\",\n \"project\": \"RFranklin/my-project\"\n }\n ],\n \"links\": []\n}", "language": "json" } ], "sidebar": true } [/block]