{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"examples":{"codes":[]},"method":"post","params":[]},"next":{"description":"","pages":[]},"title":"Get details of multiple files","type":"endpoint","slug":"get-details-of-multiple-files","excerpt":"","body":"This call returns the details of multiple specified files, including file names and file metadata. The maximum number of files you can retrieve the details for per call is 100.\n\n##Request\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"https://cavatica-api.sbgenomics.com/v2/bulk/files/get\",\n \"language\": \"text\",\n \"name\": \"Path\"\n }\n ]\n}\n[/block]\n###Example request\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"POST v2/bulk/files/get\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75\",\n \"language\": \"http\",\n \"name\": null\n },\n {\n \"code\": \"curl -X POST \\\\\\n https://cavatica-api.sbgenomics.com/v2/bulk/files/get \\\\\\n -H 'Content-Type: application/json' \\\\\\n -H 'X-SBG-Auth-Token: b04aa2a2e98348a1a3a75ca677ea7fd7' \\\\\\n -d '{\\n \\\"file_ids\\\" : [\\\"5a97d4741c94edbe85904936\\\", \\\"5a97d4741c94edbe85904909\\\"]\\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 CAVATICA [authentication token](doc:get-your-authentication-token).\",\n \"h-2\": \"\",\n \"1-0\": \" Content-Type\\n*required* \",\n \"1-1\": \"`application/json`\"\n },\n \"cols\": 2,\n \"rows\": 2\n}\n[/block]\n###Request body\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Key\",\n \"h-1\": \"Data type\",\n \"h-2\": \"Description\",\n \"0-0\": \"`file_ids`\",\n \"0-1\": \"string\",\n \"0-2\": \"The IDs of the files you are querying for details. Separate file IDs with a comma. The maximum number of files you can retrieve the details for per call is 100.\"\n },\n \"cols\": 3,\n \"rows\": 1\n}\n[/block]\n##Response\n\n[See a list of CAVATICA-specific response codes that may be contained in the body of the response](doc:api-status-codes).\n\n###Response body\n\nThe response contains information about all of the files which were queried.\n\n###Example response body\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"items\\\": [\\n {\\n \\\"resource\\\": {\\n \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/files/5a97d4741c94edbe85904936\\\",\\n \\\"id\\\": \\\"5a97d4741c94edbe85904936\\\",\\n \\\"name\\\": \\\"1000G_phase1.snps.high_confidence.b37.vcf\\\",\\n \\\"size\\\": 7313069069,\\n \\\"project\\\": \\\"rfranklin/my-project\\\",\\n \\\"created_on\\\": \\\"2018-03-01T10:22:44Z\\\",\\n \\\"modified_on\\\": \\\"2018-03-01T10:22:44Z\\\",\\n \\\"storage\\\": {\\n \\\"type\\\": \\\"PLATFORM\\\"\\n },\\n \\\"origin\\\": {},\\n \\\"tags\\\": [],\\n \\\"metadata\\\": {}\\n }\\n },\\n {\\n \\\"resource\\\": {\\n \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/files/5a97d4741c94edbe85904936\\\",\\n \\\"id\\\": \\\"5a97d4741c94edbe85904909\\\",\\n \\\"name\\\": \\\"C835.HCC1143_BL.4.contig_1_mpileup_SNPs.filtered.Somatic.hc.and_more.concat.sorted.reordered.vcf\\\",\\n \\\"size\\\": 5313069069,\\n \\\"project\\\": \\\"rfranklin/my-project\\\",\\n \\\"created_on\\\": \\\"2018-03-01T10:22:44Z\\\",\\n \\\"modified_on\\\": \\\"2018-03-01T10:22:44Z\\\",\\n \\\"storage\\\": {\\n \\\"type\\\": \\\"PLATFORM\\\"\\n },\\n \\\"origin\\\": {},\\n \\\"tags\\\": [],\\n \\\"metadata\\\": {}\\n }\\n }\\n }\\n ]\\n}\",\n \"language\": \"json\",\n \"name\": \"Example response body\"\n }\n ],\n \"sidebar\": true\n}\n[/block]","updates":[],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ad73a6bf7096b000395601a","project":"5773dcfc255e820e00e1cd4d","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5773dcfc255e820e00e1cd51","5773df36904b0c0e00ef05ff","577baf92451b1e0e006075ac","577bb183b7ee4a0e007c4e8d","577ce77a1cf3cb0e0048e5ea","577d11865fd4de0e00cc3dab","578e62792c3c790e00937597","578f4fd98335ca0e006d5c84","578f5e5c3d04570e00976ebb","57bc35f7531e000e0075d118","57f801b3760f3a1700219ebb","5804d55d1642890f00803623","581c8d55c0dc651900aa9350","589dcf8ba8c63b3b00c3704f","594cebadd8a2f7001b0b53b2","59a562f46a5d8c00238e309a","5a2aa096e25025003c582b58","5a2e79566c771d003ca0acd4","5a3a5166142db90026f24007","5a3a52b5bcc254001c4bf152","5a3a574a2be213002675c6d2","5a3a66bb2be213002675cb73","5a3a6e4854faf60030b63159","5c8a68278e883901341de571","5cb9971e57bf020024523c7b","5cbf1683e2a36d01d5012ecd","5dc15666a4f788004c5fd7d7","5eaff69e844d67003642a020","5eb00899b36ba5002d35b0c1","5eb0172be179b70073dc936e","5eb01b42b36ba5002d35ebba","5eb01f202654a20136813093","5eb918ef149186021c9a76c8","5f0839d3f4b24e005ebbbc29","5f893e508c9862002d0614a9","6024033e2b2f6f004dfe994c","60a7a12f9a06c70052b7c4db","60a7ab97266a4700161507c4","60b0c84babba720010a8b0b5"],"_id":"5773dcfc255e820e00e1cd50","__v":39,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"BULK API ACTIONS","slug":"bulk-api-actions","order":26,"from_sync":false,"reference":false,"_id":"5ad5eab10a46a3000376af1f","project":"5773dcfc255e820e00e1cd4d","version":"5773dcfc255e820e00e1cd50","createdAt":"2018-04-17T12:38:09.296Z","__v":0},"user":"566590c83889610d0008a253","createdAt":"2018-04-18T12:30:35.024Z","githubsync":"","__v":0,"parentDoc":null}