{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","examples":{"codes":[]},"method":"put","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Overwrite a file's metadata","type":"endpoint","slug":"overwrite-a-files-metadata","excerpt":"/files/{file_id}/metadata\n\nFor general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).","body":"This call changes the metadata values for the specified file. \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Metadata on the Platform\",\n  \"body\": \"Learn more about [metadata fields and their values](doc:metadata-on-cavatica) on the CAVATICA.\"\n}\n[/block]\nFiles are specified by their IDs, which you can obtain by making the API call to [list files in a project ](doc:list-files-primary-method).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/files/{file_id}/metadata\",\n      \"language\": \"text\",\n      \"name\": \"API path\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"PUT and PATCH\",\n  \"body\": \"The CAVATICA API has two method to modify file metadata. This method uses the HTTP verb `PUT`, and the other uses the HTTP verb `PATCH`. \\n\\nThe difference between the two concerns the way that they update the information stored about the user. `PATCH` allows you to update just one metadata field. On the other hand, a `PUT` request will fully overwrite the values for all metadata fields. This means that when issuing a `PUT` request you must enter values for every key required to specify the metadata, even if the values for some keys are unchanged. If you don't specify a value for a given metadata field when making the `PUT` request, then any existing value for that field will be reset.\"\n}\n[/block]\n##Request\n\n###Example request\nSince you need to specify values for all metadata fields, it can be easier to send the data as a file, using the option `--data-binary` in cURL.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"PUT /v2/files/5655df71e4b08c5d86970945/metadata HTTP/1.1\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 565357a1e4b09c884b29334a\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --data-binary \\\":::at:::metadata.json\\\" -s -H \\\"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\\\" -H \\\"content-type: application/json\\\" -X PUT \\\"https://cavatica-api.sbgenomics.com/v2/files/5655df71e4b08c5d86970945/metadata\\\"\",\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  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`file_id`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The ID of the file whose details you want to overwrite.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\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##Request body\nIn the body of the request, you should enter key-value pairs corresponding to metadata fields and their values.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Datatype of value\",\n    \"h-2\": \"Description of value\",\n    \"0-0\": \"Freeform -- enter any string\",\n    \"0-1\": \"string\",\n    \"0-2\": \"The value for the corresponding key\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n###Example request body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"foo\\\": \\\"bar\\\",\\n    \\\"my_key_1\\\": \\\"my_value_1\\\",\\n    \\\"my_key_2\\\": \\\"my_value_2\\\",\\n    \\\"platform\\\": \\\"my_platform\\\",\\n    \\\"library_id\\\": \\\"12345\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\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###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"library_id\\\": \\\"12345\\\",\\n  \\\"platform\\\": \\\"my_platform\\\",\\n  \\\"foo\\\": \\\"bar\\\",\\n  \\\"my_key_1\\\": \\\"my_value_1\\\",\\n  \\\"my_key_2\\\": \\\"my_value_2\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n<hr>","updates":[],"order":45,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5774ebbfe719e01900625a89","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"CAVATICA API","slug":"api","order":22,"from_sync":false,"reference":false,"_id":"5773df36904b0c0e00ef05ff","createdAt":"2016-06-29T14:46:14.277Z","version":"5773dcfc255e820e00e1cd50","__v":1,"project":"5773dcfc255e820e00e1cd4d"},"project":"5773dcfc255e820e00e1cd4d","githubsync":"","__v":3,"user":"575e85ac41c8ba0e00259a44","createdAt":"2016-06-30T09:51:59.690Z","parentDoc":null,"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"}}