{"_id":"56328d1338f8aa0d00d30f8e","user":"554340dfb7f4540d00fcef1d","project":"55faf11ba62ba1170021a9a7","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"},"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"},"parentDoc":null,"__v":18,"updates":["566b25f814c22f1900f00b3f","56a5fc9afe3e780d00c50696"],"next":{"pages":[],"description":""},"createdAt":"2015-10-29T21:18:11.273Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":28,"body":"This call returns a list of all files in a specified project with specified properties that you can access. For each file, the call returns:\n\n  * Its ID\n  * Its filename\n\nThe project to find files from is specified as a query parameter in the call. Further file properties to filter by can also be specified as query parameters.\n\nDon't forget that projects on the Platform are specified by their [short names](http://docs.cancergenomicscloud.org/v1.0/docs/the-cgc-api#section-identifying-projects-users-apps-files-tasks-and-inputs).\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"File IDs\",\n  \"body\": \"The file IDs returned by this call are useful for issuing further queries to get more information about a particular file.\"\n}\n[/block]\n\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\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Alias call\",\n  \"body\": \"There is a second method for listing files in a project: [`GET projects/{project_owner}/{project_name}/files`](http://docs.cancergenomicscloud.org/v1.0/docs/list-files-secondary-method). The call listed here is the primary and preferred method for performing this operation.\"\n}\n[/block]\n##Request\n\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  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Query Parameters\n\nYou can use query parameters, listed in the table below, to return specific results. See the tip box below for details on `OR` and `AND` operations while filtering. Below the table, you'll see examples of API requests using various parameters.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Tips for filtering\",\n  \"body\": \"When filtering on any resource, including the same field several times with different filtering criteria results in an implicit `OR` operation for that field and the different criteria. \\n\\nWhen filtering by different specified fields, an implicit `AND` is performed between those criteria. Thus, the call in Example 3 above would return files matching the specified project AND sample ID AND library.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`project_owner`\\n_required_\",\n    \"6-0\": \"<a name=\\\"tags\\\"></a>`tag`\",\n    \"5-0\": \"`fields`\",\n    \"0-1\": \"string\",\n    \"5-1\": \"string\",\n    \"6-1\": \"string\",\n    \"6-2\": \"List files containing this tag. Note that the tag must be an exact complete string for the results to match. Multiple tags can be separated by an OR operation, as shown in example 5 below. The OR operation is implied when the same parameter is queried multiple times in the same API request.\\n\\nKeep in mind that tags are different from metadata. Learn more about [tagging your files](tag-your-files) on the Platform.\",\n    \"5-2\": \"Selector specifying a subset of fields to include in the response.\",\n    \"0-2\": \"The owner of the project you are listing files from.\",\n    \"3-0\": \"`metadata.{field}`\",\n    \"3-1\": \"string\",\n    \"3-2\": \"List only files with that have the specified value in metadata field.\\n\\nMultiple instances of the same metadata field are implicitly separated by an `OR` operation. Conversely, different metadata fields are implicitly separated by an `AND` operation, as shown in example 3 below.\",\n    \"2-0\": \"`name`\",\n    \"2-1\": \"string\",\n    \"2-2\": \"List file with this name. Note that the name must be an exact complete string for the results to match. \\n\\nMultiple names can be separated by an `OR` operation, as shown in example 4 below. The `OR` operation is implied when the same parameter is queried multiple times in the same API request\",\n    \"4-0\": \"`origin.task`\",\n    \"4-1\": \"string\",\n    \"4-2\": \"List only files produced by task specified by ID in this field\",\n    \"1-0\": \"`project`\\n_required_\",\n    \"1-2\": \"The project's [short name](doc:the-cgc-api#section-project-short-names)\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Limit your results\",\n  \"body\": \"Don't forget that you can [use filtering with the `limit` parameter](the-cgc-api#section-response-pagination) to restrict the number of files returned by this call.\"\n}\n[/block]\n###Example requests\nSince file filtering is a powerful feature, we have included some example usages.\n\nExample 1: List all files in the project 'my-project':\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/files?project=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/files?project=RFranklin/my-project\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\nExample 2: List all files in 'my-project' with a specific sample ID\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/files?project=rfranklin/my-project&metadata.sample_id=SAMPLE1 HTTP/1.1\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\",\n      \"language\": \"http\",\n      \"name\": \"HTTP\"\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/files?project=RFranklin/my-project&metadata.sample_id=SAMPLE1\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ]\n}\n[/block]\nExample 3: List all files in 'my-project' that were produced by a specific task with a specific library and sample ID:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/files?project=rfranklin/my-project&metadata.sample_id=ERR315335&metadata.library_id=HiSeqX_R HTTP/1.1\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\",\n      \"language\": \"http\",\n      \"name\": \"HTTP\"\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/files?project=my-project&metadata.sample_id=ERR315335&origin.task=1262d968-1fda-4f06-a755-917a53a03e7e\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nExample 4: List all files in 'my-project' matching the exact names included in the query parameters:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/files?project=rfranklin/my-project&name=dbsnp_137.b37.vcf&name=1000G_phase1.indels.b37.vcf&name=Mills_and_1000G_gold_standard.indels.b37.sites.vcf HTTP/1.1\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\",\n      \"language\": \"http\"\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/files?project=my-project&name=dbsnp_137.b37.vcf&name=1000G_phase1.indels.b37.vcf&name=Mills_and_1000G_gold_standard.indels.b37.sites.vcf\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nExample 5: List all files in 'my-project' matching the exact tags included in the parameters:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/files?project=rfranklin/my-project&tag=test1b&tag=my_first_project&fields=_all HTTP/1.1\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\",\n      \"language\": \"http\"\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/files?project=franklin/my-project&tag=test1b&tag=my_first_project\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"See tags in the response body\",\n  \"body\": \"Set the query parameter `fields` to `_all` to display tags within the response body, since tags is not automatically displayed in the response body.\"\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?offset=0&limit=25&project=RFranklin/my-project\\\",\\n  \\\"items\\\": [\\n    {\\n      \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/files/568cf5dce4b0307bc0462060\\\",\\n      \\\"id\\\": \\\"568cf5dce4b0307bc0462060\\\",\\n      \\\"name\\\": \\\"1000G_phase1.indels.b37.vc\\\",\\n      \\\"project\\\": \\\"RFranklin/my-project\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/files/566aad1de4b0c560b469ea80\\\",\\n      \\\"id\\\": \\\"566aad1de4b0c560b469ea80\\\",\\n      \\\"name\\\": \\\"1000G_omni2.5.b37.vcf\\\",\\n      \\\"project\\\": \\\"RFranklin/my-project\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/files/568cf5f4e4b0307bc0462062\\\",\\n      \\\"id\\\": \\\"568cf5f4e4b0307bc0462062\\\",\\n      \\\"name\\\": \\\"1000G_phase1.snps.high_confidence.b37.vcf\\\",\\n      \\\"project\\\": \\\"RFranklin/my-project\\\"\\n    }\\n  ],\\n  \\\"links\\\": []\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"/files","slug":"list-files-in-a-project","type":"endpoint","title":"List files (primary method)"}

getList files (primary method)

/files

This call returns a list of all files in a specified project with specified properties that you can access. For each file, the call returns: * Its ID * Its filename The project to find files from is specified as a query parameter in the call. Further file properties to filter by can also be specified as query parameters. Don't forget that projects on the Platform are specified by their [short names](http://docs.cancergenomicscloud.org/v1.0/docs/the-cgc-api#section-identifying-projects-users-apps-files-tasks-and-inputs). [block:callout] { "type": "success", "title": "File IDs", "body": "The file IDs returned by this call are useful for issuing further queries to get more information about a particular file." } [/block] [block:code] { "codes": [ { "code": "https://cgc-api.sbgenomics.com/v2/files", "language": "text", "name": "Path" } ] } [/block] [block:callout] { "type": "warning", "title": "Alias call", "body": "There is a second method for listing files in a project: [`GET projects/{project_owner}/{project_name}/files`](http://docs.cancergenomicscloud.org/v1.0/docs/list-files-secondary-method). The call listed here is the primary and preferred method for performing this operation." } [/block] ##Request ###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": "" }, "cols": 2, "rows": 1 } [/block] ###Query Parameters You can use query parameters, listed in the table below, to return specific results. See the tip box below for details on `OR` and `AND` operations while filtering. Below the table, you'll see examples of API requests using various parameters. [block:callout] { "type": "success", "title": "Tips for filtering", "body": "When filtering on any resource, including the same field several times with different filtering criteria results in an implicit `OR` operation for that field and the different criteria. \n\nWhen filtering by different specified fields, an implicit `AND` is performed between those criteria. Thus, the call in Example 3 above would return files matching the specified project AND sample ID AND library." } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Description", "0-0": "`project_owner`\n_required_", "6-0": "<a name=\"tags\"></a>`tag`", "5-0": "`fields`", "0-1": "string", "5-1": "string", "6-1": "string", "6-2": "List files containing this tag. Note that the tag must be an exact complete string for the results to match. Multiple tags can be separated by an OR operation, as shown in example 5 below. The OR operation is implied when the same parameter is queried multiple times in the same API request.\n\nKeep in mind that tags are different from metadata. Learn more about [tagging your files](tag-your-files) on the Platform.", "5-2": "Selector specifying a subset of fields to include in the response.", "0-2": "The owner of the project you are listing files from.", "3-0": "`metadata.{field}`", "3-1": "string", "3-2": "List only files with that have the specified value in metadata field.\n\nMultiple instances of the same metadata field are implicitly separated by an `OR` operation. Conversely, different metadata fields are implicitly separated by an `AND` operation, as shown in example 3 below.", "2-0": "`name`", "2-1": "string", "2-2": "List file with this name. Note that the name must be an exact complete string for the results to match. \n\nMultiple names can be separated by an `OR` operation, as shown in example 4 below. The `OR` operation is implied when the same parameter is queried multiple times in the same API request", "4-0": "`origin.task`", "4-1": "string", "4-2": "List only files produced by task specified by ID in this field", "1-0": "`project`\n_required_", "1-2": "The project's [short name](doc:the-cgc-api#section-project-short-names)" }, "cols": 3, "rows": 7 } [/block] [block:callout] { "type": "success", "title": "Limit your results", "body": "Don't forget that you can [use filtering with the `limit` parameter](the-cgc-api#section-response-pagination) to restrict the number of files returned by this call." } [/block] ###Example requests Since file filtering is a powerful feature, we have included some example usages. Example 1: List all files in the project 'my-project': [block:code] { "codes": [ { "code": "GET /v2/files?project=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/files?project=RFranklin/my-project\"", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] Example 2: List all files in 'my-project' with a specific sample ID [block:code] { "codes": [ { "code": "GET /v2/files?project=rfranklin/my-project&metadata.sample_id=SAMPLE1 HTTP/1.1\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74", "language": "http", "name": "HTTP" }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X GET \"https://cgc-api.sbgenomics.com/v2/files?project=RFranklin/my-project&metadata.sample_id=SAMPLE1\"", "language": "curl", "name": "cURL" } ] } [/block] Example 3: List all files in 'my-project' that were produced by a specific task with a specific library and sample ID: [block:code] { "codes": [ { "code": "GET /v2/files?project=rfranklin/my-project&metadata.sample_id=ERR315335&metadata.library_id=HiSeqX_R HTTP/1.1\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74", "language": "http", "name": "HTTP" }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X GET \"https://cgc-api.sbgenomics.com/v2/files?project=my-project&metadata.sample_id=ERR315335&origin.task=1262d968-1fda-4f06-a755-917a53a03e7e\"", "language": "curl" } ] } [/block] Example 4: List all files in 'my-project' matching the exact names included in the query parameters: [block:code] { "codes": [ { "code": "GET /v2/files?project=rfranklin/my-project&name=dbsnp_137.b37.vcf&name=1000G_phase1.indels.b37.vcf&name=Mills_and_1000G_gold_standard.indels.b37.sites.vcf HTTP/1.1\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74", "language": "http" }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X GET \"https://cgc-api.sbgenomics.com/v2/files?project=my-project&name=dbsnp_137.b37.vcf&name=1000G_phase1.indels.b37.vcf&name=Mills_and_1000G_gold_standard.indels.b37.sites.vcf\"", "language": "curl" } ] } [/block] Example 5: List all files in 'my-project' matching the exact tags included in the parameters: [block:code] { "codes": [ { "code": "GET /v2/files?project=rfranklin/my-project&tag=test1b&tag=my_first_project&fields=_all HTTP/1.1\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74", "language": "http" }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X GET \"https://cgc-api.sbgenomics.com/v2/files?project=franklin/my-project&tag=test1b&tag=my_first_project\"", "language": "curl" } ] } [/block] [block:callout] { "type": "success", "title": "See tags in the response body", "body": "Set the query parameter `fields` to `_all` to display tags within the response body, since tags is not automatically displayed in the response body." } [/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?offset=0&limit=25&project=RFranklin/my-project\",\n \"items\": [\n {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/files/568cf5dce4b0307bc0462060\",\n \"id\": \"568cf5dce4b0307bc0462060\",\n \"name\": \"1000G_phase1.indels.b37.vc\",\n \"project\": \"RFranklin/my-project\"\n },\n {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/files/566aad1de4b0c560b469ea80\",\n \"id\": \"566aad1de4b0c560b469ea80\",\n \"name\": \"1000G_omni2.5.b37.vcf\",\n \"project\": \"RFranklin/my-project\"\n },\n {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/files/568cf5f4e4b0307bc0462062\",\n \"id\": \"568cf5f4e4b0307bc0462062\",\n \"name\": \"1000G_phase1.snps.high_confidence.b37.vcf\",\n \"project\": \"RFranklin/my-project\"\n }\n ],\n \"links\": []\n}", "language": "json" } ], "sidebar": true } [/block]