{"_id":"5ad741d47097f700030f5b38","project":"5773dcfc255e820e00e1cd4d","version":{"_id":"5773dcfc255e820e00e1cd50","__v":26,"project":"5773dcfc255e820e00e1cd4d","createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5ad5eab10a46a3000376af1f","project":"5773dcfc255e820e00e1cd4d","version":"5773dcfc255e820e00e1cd50","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-04-17T12:38:09.296Z","from_sync":false,"order":15,"slug":"bulk-api-actions","title":"BULK API ACTIONS"},"user":"566590c83889610d0008a253","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-18T13:02:12.460Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"examples":{"codes":[]},"method":"post","auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"This call edits the details for multiple specified files. Use this call to modify the existing information for the files or add new information while preserving omitted parameters. For each of the specified files, the call edits its name, tags, and metadata.\n\nFor each of the specified files, the call sets a new name, new tags, and metadata. The maximum number of files you can edit 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/edit\",\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/edit\\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/update \\\\\\n  -H 'Cache-Control: no-cache' \\\\\\n  -H 'Content-Type: application/json' \\\\\\n  -H 'Postman-Token: 313ceab4-4165-4cff-b9db-146d912f4aaf' \\\\\\n  -H 'X-SBG-Auth-Token: af055f57c30a4e2d99c1fd42101f13da' \\\\\\n  -d '{\\n    \\\"items\\\": [\\n        {\\n            \\\"file_id\\\": \\\"5a97d4741c94edbe8590492a\\\",\\n                \\\"name\\\": \\\"api_test2\\\",\\n                \\\"tags\\\": [\\\"test9\\\"],\\n                \\\"metadata\\\": {\\n                    \\\"sample_id\\\": \\\"sample1\\\"\\n                }\\n        },\\n        {\\n            \\\"file_id\\\": \\\"5a97d4741c94edbe85904949\\\",\\n                \\\"metadata\\\": {\\n                    \\\"sample_id\\\": \\\"sample1\\\"\\n                }\\n        },\\n        {\\n            \\\"file_id\\\": \\\"5a97d4701c94edbe8590471e\\\",\\n                \\\"tags\\\": [\\\"test3\\\"]\\n        },\\n        {\\n            \\\"file_id\\\": \\\"5a97d4741c94edbe8590494c\\\"\\n        }\\n    ]\\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_id`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"The IDs of the file you are editing. The maximum number of files you can edit the details for per call is 100.\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"string\",\n    \"1-2\": \"The new name of the file.\",\n    \"2-0\": \"`tags`\",\n    \"2-1\": \"array\",\n    \"2-2\": \"The tags you want to edit.\",\n    \"3-0\": \"`metadata`\",\n    \"3-1\": \"dictionary of key-value pairs\",\n    \"3-2\": \"The metadata fields and their values that you want to edit.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\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.](ref:api-status-codes).\n\n###Response body\n\nThe response contains information the updated information for all of the edited files.\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\\\": \\\"2b86s8451c94edbe34904936\\\",\\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]","excerpt":"","slug":"edit-details-of-multiple-files","type":"endpoint","title":"Edit details of multiple files"}

postEdit details of multiple files


This call edits the details for multiple specified files. Use this call to modify the existing information for the files or add new information while preserving omitted parameters. For each of the specified files, the call edits its name, tags, and metadata. For each of the specified files, the call sets a new name, new tags, and metadata. The maximum number of files you can edit the details for per call is 100. ##Request [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/bulk/files/edit", "language": "text", "name": "Path" } ] } [/block] ###Example request [block:code] { "codes": [ { "code": "POST v2/bulk/files/edit\nHost: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75", "language": "http", "name": null }, { "code": "curl -X POST \\\n https://cavatica-api.sbgenomics.com/v2/bulk/files/update \\\n -H 'Cache-Control: no-cache' \\\n -H 'Content-Type: application/json' \\\n -H 'Postman-Token: 313ceab4-4165-4cff-b9db-146d912f4aaf' \\\n -H 'X-SBG-Auth-Token: af055f57c30a4e2d99c1fd42101f13da' \\\n -d '{\n \"items\": [\n {\n \"file_id\": \"5a97d4741c94edbe8590492a\",\n \"name\": \"api_test2\",\n \"tags\": [\"test9\"],\n \"metadata\": {\n \"sample_id\": \"sample1\"\n }\n },\n {\n \"file_id\": \"5a97d4741c94edbe85904949\",\n \"metadata\": {\n \"sample_id\": \"sample1\"\n }\n },\n {\n \"file_id\": \"5a97d4701c94edbe8590471e\",\n \"tags\": [\"test3\"]\n },\n {\n \"file_id\": \"5a97d4741c94edbe8590494c\"\n }\n ]\n}'", "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 Cavatica [authentication token](doc:get-your-authentication-token).", "h-2": "", "1-0": " Content-Type\n*required* ", "1-1": "`application/json`" }, "cols": 2, "rows": 2 } [/block] ###Request body [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-0": "`file_id`", "0-1": "string", "0-2": "The IDs of the file you are editing. The maximum number of files you can edit the details for per call is 100.", "1-0": "`name`", "1-1": "string", "1-2": "The new name of the file.", "2-0": "`tags`", "2-1": "array", "2-2": "The tags you want to edit.", "3-0": "`metadata`", "3-1": "dictionary of key-value pairs", "3-2": "The metadata fields and their values that you want to edit." }, "cols": 3, "rows": 4 } [/block] ##Response [See a list of Cavatica-specific response codes that may be contained in the body of the response.](ref:api-status-codes). ###Response body The response contains information the updated information for all of the edited files. ###Example response body [block:code] { "codes": [ { "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\": \"2b86s8451c94edbe34904936\",\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}", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]