{"_id":"5774e948e719e01900625a7c","user":"575e85ac41c8ba0e00259a44","githubsync":"","parentDoc":null,"project":"5773dcfc255e820e00e1cd4d","__v":3,"category":{"_id":"5773df36904b0c0e00ef05ff","version":"5773dcfc255e820e00e1cd50","__v":0,"project":"5773dcfc255e820e00e1cd4d","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-06-29T14:46:14.277Z","from_sync":false,"order":12,"slug":"api","title":"Cavatica API"},"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-30T09:41:28.626Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"patch","results":{"codes":[]},"settings":"","examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":36,"body":"This call updates the name and the full set metadata for a specified file. \n\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:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Metadata\",\n  \"body\": \"Learn more about [metadata fields and their permissible values](metadata-on-the-seven-bridges-platform) on the Seven Bridges Platform.\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://api.sbgenomics.com/v2/files/{file_id}\",\n      \"language\": \"text\",\n      \"name\": \"Path for Amazon Web Services users\"\n    },\n    {\n      \"code\": \"https://gcp-api.sbgenomics.com/v2/files/{file_id}\",\n      \"language\": \"text\",\n      \"name\": \"Path for Google Cloud Platform users\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"File names and IDs\",\n  \"body\": \"Note that the file name is not the same as its ID. The ID is a hexadecimal string, automatically assigned to a file in a project. The file's name is a human-readable string. For information, please see [the API overview](doc:the-api#section-identifying-projects-users-apps-files-tasks-and-inputs).\"\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"PATCH /v2/files/562e449060b274321afb6091 HTTP/1.1\\nHost: api.sbgenomics.com\\nX-SBG-Auth-Token: 565357a1e4b09c884b29334a\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --data '{\\\"metadata\\\": {disease_type: \\\"Acute Myeloid Leukemia\\\"}} -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"content-type: application/json\\\" -X PATCH \\\"https://api.sbgenomics.com/v2/files/565357a1e4b09c884b29334a\\\"\",\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 Seven Bridges 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\": \"`file_id`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The ID of the file whose details you want to update.\"\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\nYou should enter the body as key-value pairs, with the following format:\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\": \"`name`\",\n    \"1-0\": \"`metadata`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"The new name of the file.\",\n    \"1-1\": \"dictionary of key-value pairs. The keys and values are strings.\",\n    \"1-2\": \"The metadata fields and their values that you want to update.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n###Example request body\nIn the example below, I have submitted a request to change the file name to `\"1_1000Genomes_phase1.snps.high_confidence.b37.vcf\"` and to have the metadata contain only the field `disease_type` with value `\"Acute Myeloid Leukemia\"`.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\\"name\\\": \\\"1_1000Genomes_phase1.snps.high_confidence.b37.vcf\\\"\\n  \\\"metadata\\\": {\\n  \\tdisease_type: \\\"Acute Myeloid Leukemia\\\"\\n    }\\n}\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n##Response\n\n[See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.](doc:api-status-codes) \n\n###Example response body\n\nNotice that the metadata contains only the fields specified in the request body.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://api.sbgenomics.com/v2/files/566aad1de4b0c560b469ea80\\\",\\n  \\\"id\\\": \\\"566aad1de4b0c560b469ea80\\\",\\n  \\\"name\\\": \\\"1_1000Genomes_phase1.snps.high_confidence.b37.vcf\\\",\\n  \\\"size\\\": 363,\\n  \\\"project\\\": \\\"RFranklin/my-project\\\",\\n  \\\"created_on\\\": \\\"2015-12-11T11:01:49Z\\\",\\n  \\\"modified_on\\\": \\\"2016-01-07T12:22:12Z\\\",\\n  \\\"origin\\\": {},\\n  \\\"metadata\\\": {\\n    \\\"disease_type\\\": \\\"Acute Myeloid Leukemia\\\",\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Interpreting the response body\",\n  \"body\": \"The object `origin` denotes the task that produced the file, if it was created by a task on the Seven Bridges Platform.\\n\\nThe dictionary object `metadata` lists the metadata fields and values for the file.\"\n}\n[/block]","excerpt":"files/{file_id}\n\nFor general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).","slug":"update-file-details","type":"endpoint","title":"Update file details"}

patchUpdate file details

files/{file_id} For general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).

This call updates the name and the full set metadata for a specified file. Files 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). [block:callout] { "type": "warning", "title": "Metadata", "body": "Learn more about [metadata fields and their permissible values](metadata-on-the-seven-bridges-platform) on the Seven Bridges Platform." } [/block] [block:code] { "codes": [ { "code": "https://api.sbgenomics.com/v2/files/{file_id}", "language": "text", "name": "Path for Amazon Web Services users" }, { "code": "https://gcp-api.sbgenomics.com/v2/files/{file_id}", "language": "text", "name": "Path for Google Cloud Platform users" } ] } [/block] [block:callout] { "type": "warning", "title": "File names and IDs", "body": "Note that the file name is not the same as its ID. The ID is a hexadecimal string, automatically assigned to a file in a project. The file's name is a human-readable string. For information, please see [the API overview](doc:the-api#section-identifying-projects-users-apps-files-tasks-and-inputs)." } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "PATCH /v2/files/562e449060b274321afb6091 HTTP/1.1\nHost: api.sbgenomics.com\nX-SBG-Auth-Token: 565357a1e4b09c884b29334a\n", "language": "http", "name": null }, { "code": "curl --data '{\"metadata\": {disease_type: \"Acute Myeloid Leukemia\"}} -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X PATCH \"https://api.sbgenomics.com/v2/files/565357a1e4b09c884b29334a\"", "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 Seven Bridges Platform [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Path parameters [block:parameters] { "data": { "0-0": "`file_id`", "h-0": "Name", "h-1": "Description", "0-1": "The ID of the file whose details you want to update." }, "cols": 2, "rows": 1 } [/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] ##Request body You should enter the body as key-value pairs, with the following format: [block:parameters] { "data": { "h-0": "Key", "h-1": "Datatype of value", "h-2": "Description of value", "0-0": "`name`", "1-0": "`metadata`", "0-1": "string", "0-2": "The new name of the file.", "1-1": "dictionary of key-value pairs. The keys and values are strings.", "1-2": "The metadata fields and their values that you want to update." }, "cols": 3, "rows": 2 } [/block] ###Example request body In the example below, I have submitted a request to change the file name to `"1_1000Genomes_phase1.snps.high_confidence.b37.vcf"` and to have the metadata contain only the field `disease_type` with value `"Acute Myeloid Leukemia"`. [block:code] { "codes": [ { "code": "{\n\t\"name\": \"1_1000Genomes_phase1.snps.high_confidence.b37.vcf\"\n \"metadata\": {\n \tdisease_type: \"Acute Myeloid Leukemia\"\n }\n}", "language": "text" } ] } [/block] ##Response [See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body Notice that the metadata contains only the fields specified in the request body. [block:code] { "codes": [ { "code": "{\n \"href\": \"https://api.sbgenomics.com/v2/files/566aad1de4b0c560b469ea80\",\n \"id\": \"566aad1de4b0c560b469ea80\",\n \"name\": \"1_1000Genomes_phase1.snps.high_confidence.b37.vcf\",\n \"size\": 363,\n \"project\": \"RFranklin/my-project\",\n \"created_on\": \"2015-12-11T11:01:49Z\",\n \"modified_on\": \"2016-01-07T12:22:12Z\",\n \"origin\": {},\n \"metadata\": {\n \"disease_type\": \"Acute Myeloid Leukemia\",\n }\n}", "language": "json" } ], "sidebar": true } [/block] [block:callout] { "type": "success", "title": "Interpreting the response body", "body": "The object `origin` denotes the task that produced the file, if it was created by a task on the Seven Bridges Platform.\n\nThe dictionary object `metadata` lists the metadata fields and values for the file." } [/block]