{"_id":"56c5062fbdcde80d0049869e","editedParams":true,"version":{"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z","categories":["56c50628bdcde80d00498636","56c50628bdcde80d00498637","56c50628bdcde80d00498638","56c50628bdcde80d00498639","56c50628bdcde80d0049863a","56c50628bdcde80d0049863b","56c50628bdcde80d0049863c","56c50628bdcde80d0049863d","56c50628bdcde80d0049863e","56c50628bdcde80d0049863f","56c50628bdcde80d00498640","56c50628bdcde80d00498641","56c50628bdcde80d00498642","56c50628bdcde80d00498643","56c50628bdcde80d00498644","56c50628bdcde80d00498645","56c50628bdcde80d00498646","56c50628bdcde80d00498647","56c506a018f0c90d002808de","56c6b0baf795cf0d003ec13e","56fe58eb5a08190e00085149","571764513cf2960e0009a635","571fc008ffbc6a2000b25bb5","5739ca371f4b740e00b06e09","577522f197a3830e004bcc1b","57753d5ffecd260e00d86ce6","57adb71efaa7a10e004495b6"],"is_deprecated":true,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"API v1.1","version_clean":"0.1.1","version":"0.1.1"},"parentDoc":null,"user":"54774c47f3736008009e9e0c","__v":2,"githubsync":"","category":{"_id":"56c50628bdcde80d00498639","__v":1,"project":"54774d9af3736008009e9e0e","pages":["56c5062fbdcde80d0049869a","56c5062fbdcde80d0049869b","56c5062fbdcde80d0049869c","56c5062fbdcde80d0049869d","56c5062fbdcde80d0049869e","56c5062fbdcde80d0049869f"],"version":"56c50626bdcde80d00498635","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-03-17T14:15:35.496Z","from_sync":false,"order":3,"slug":"data-objects","title":"Data Objects"},"project":"54774d9af3736008009e9e0e","editedParams2":true,"updates":["5593e03547f40b17003609e4"],"next":{"pages":[],"description":""},"createdAt":"2015-02-20T14:12:20.592Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"channel_room\": null,\n  \"group\": null,\n  \"name\": \"Geralt\",\n  \"links\": {\n    \"self\": \"/v1.1/instances/rivia/classes/witchers/objects/32/\"\n  },\n  \"city\": \"Rivia\",\n  \"group_permissions\": \"none\",\n  \"created_at\": \"2016-03-10T20:01:31.915670Z\",\n  \"owner_permissions\": \"full\",\n  \"updated_at\": \"2016-03-10T20:01:31.915692Z\",\n  \"other_permissions\": \"none\",\n  \"owner\": null,\n  \"id\": 32,\n  \"channel\": null,\n  \"revision\": 1\n}","language":"json","status":200},{"code":"{\n  \"detail\": \"JSON parse error - Expecting property name enclosed in double quotes: line 4 column 1 (char 45)\"\n}","status":400,"language":"json"},{"code":"{\n  \"detail\": \"No such API Key.\"\n}","language":"json","status":403},{"status":404,"language":"json","code":"{\n  \"detail\": \"Not found\"\n}"}]},"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"code":"curl -X PATCH \\\n-H \"X-API-KEY: API_KEY\" \\\n-H \"X-USER-KEY: USER_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"name\":\"Geralt\",\n     \"city\":\"Rivia\"}' \\\n\"https://api.syncano.io/v1.1/instances/INSTANCE_NAME/classes/DATA_CLASS_NAME/objects/OBJECT_ID/\"","name":"","language":"curl"},{"language":"python","code":"import syncano\nfrom syncano.models import Object\n\nconnection = syncano.connect(api_key=\"API_KEY\", user_key=\"USER_KEY\", instance_name=\"INSTANCE_NAME\")\n\nObject.please.update(\n    id=\"OBJECT_ID\",\n    data={\"name\":\"Geralt\", \"city\":\"Rivia\"},\n    class_name=\"CLASS_NAME\"\n)"},{"name":"Android","code":"final Book book = new Book();\nbook.id = 16;\nbook.author = \"Ernest Hemingway\";\nbook.title = \"The Old Man and the Sea\";\n\nResponse <Book> responseUpdate = syncano.updateObject(book).send();","language":"java"},{"code":"var Syncano = require('syncano');\nvar connection = Syncano({apiKey: 'API_KEY',\n                          userKey: 'USER_KEY', \n                          defaults: { \n                                      instanceName: \"INSTANCE_NAME\", \n                                      className: \"CLASS_NAME\"\n                                    }\n                         });\nvar DataObject = connection.DataObject;\n\nvar update = {\n  name: \"Not Geralt\", \n  city: \"Not Rivia\"\n};\nvar params = {\n  id: 5\n};\n\nDataObject.please().update(params, update).then(callback);","language":"javascript","name":null}]},"method":"patch","auth":"required","params":[{"_id":"54d8b350628f540d00f3e4ae","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance_name"},{"_id":"54dc9b86ac05560d003359a9","ref":"","in":"path","required":true,"desc":"Data Class name","default":"","type":"string","name":"class_name"},{"_id":"54e73da43323130d002e684a","ref":"","in":"path","required":true,"desc":"Data Object ID","default":"","type":"int","name":"data_object_id"},{"_id":"555ced7515a89b0d00c1b010","ref":"","in":"body","required":false,"desc":"ID of an  owner (user who should own the object)","default":"","type":"int","name":"owner"},{"_id":"555ced7515a89b0d00c1b00f","ref":"","in":"body","required":false,"desc":"ID of a group (group owning the object)","default":"","type":"int","name":"group"},{"_id":"555ced7515a89b0d00c1b00e","ref":"","in":"body","required":false,"desc":"Name of a channel to which post real-time updates about object creation/changes/deletion","default":"","type":"string","name":"channel"},{"_id":"555ced7515a89b0d00c1b00d","ref":"","in":"body","required":false,"desc":"Name of a channel room inside chosen channel that will receive real-time notification","default":"","type":"string","name":"channel_room"},{"_id":"555ced7515a89b0d00c1b00c","ref":"","in":"body","required":false,"desc":"Permissions to an object for its owner. Can be one of \"none\", \"read\", \"write\", \"full\".","default":"","type":"string","name":"owner_permissions"},{"_id":"555ced7515a89b0d00c1b00b","ref":"","in":"body","required":false,"desc":"Permissions to an object for its group. Can be one of \"none\", \"read\", \"write\", \"full\".","default":"","type":"string","name":"group_permissions"},{"_id":"555ced7515a89b0d00c1b00a","ref":"","in":"body","required":false,"desc":"Permissions to an object for everyone. Can be one of \"none\", \"read\", \"write\", \"full\".","default":"","type":"string","name":"other_permissions"},{"_id":"555ced7515a89b0d00c1b009","ref":"","in":"body","required":false,"desc":"Expected revision (version) of the object","default":"","type":"int","name":"expected_revision"}],"url":"/instances/:instance_name/classes/:data_class_name/objects/:data_object_id/"},"isReference":true,"order":3,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Authentication & API Keys\",\n  \"body\": \"To make this request you have to use Account key or combination of API key and User key.\\n\\nUsing Account key is potentially dangerous because it gives to end user or application administrator rights.\\nTo avoid possible security breaches it's suggested to use combination of API key and User key.\\n\\nFor further information about this topic please check Syncano Documentation:\\n [Connecting with API key](http://docs.syncano.io/docs/authentication#connecting-with-an-api-key)\\n[User key usage](http://docs.syncano.io/docs/user-management#user-authentication)\\n\\nIf you want to test out the request right from the docs add your authentication key(s) by using green key icon below.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"You won’t be able to send custom property values in our docs. \\nE.g., if your Data Object has a `city` attribute, you won’t be able to add it here, with the “Try it out” feature.\\nThis is limit only exists in our docs and you can do this from the Syncano Dashboard, libraries or by using direct api calls.\"\n}\n[/block]\nUpdates a Data Object.","excerpt":"Update an object","slug":"data-object-update-patch","type":"endpoint","title":"Data Object - update"}

patchData Object - update

Update an object

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name
class_name:
required
string
Data Class name
data_object_id:
required
integer
Data Object ID

Body Params

owner:
integer
ID of an owner (user who should own the object)
group:
integer
ID of a group (group owning the object)
channel:
string
Name of a channel to which post real-time updates about object creation/changes/deletion
channel_room:
string
Name of a channel room inside chosen channel that will receive real-time notification
owner_permissions:
string
Permissions to an object for its owner. Can be one of "none", "read", "write", "full".
group_permissions:
string
Permissions to an object for its group. Can be one of "none", "read", "write", "full".
other_permissions:
string
Permissions to an object for everyone. Can be one of "none", "read", "write", "full".
expected_revision:
integer
Expected revision (version) of the object

Examples


Result Format


Documentation

[block:callout] { "type": "warning", "title": "Authentication & API Keys", "body": "To make this request you have to use Account key or combination of API key and User key.\n\nUsing Account key is potentially dangerous because it gives to end user or application administrator rights.\nTo avoid possible security breaches it's suggested to use combination of API key and User key.\n\nFor further information about this topic please check Syncano Documentation:\n [Connecting with API key](http://docs.syncano.io/docs/authentication#connecting-with-an-api-key)\n[User key usage](http://docs.syncano.io/docs/user-management#user-authentication)\n\nIf you want to test out the request right from the docs add your authentication key(s) by using green key icon below." } [/block] [block:callout] { "type": "info", "body": "You won’t be able to send custom property values in our docs. \nE.g., if your Data Object has a `city` attribute, you won’t be able to add it here, with the “Try it out” feature.\nThis is limit only exists in our docs and you can do this from the Syncano Dashboard, libraries or by using direct api calls." } [/block] Updates a Data Object.

User Information

Try It Out

patch
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}