{"_id":"56c5062ebdcde80d00498694","category":{"_id":"56c50628bdcde80d00498638","pages":["56c5062ebdcde80d00498690","56c5062ebdcde80d00498691","56c5062ebdcde80d00498692","56c5062ebdcde80d00498693","56c5062ebdcde80d00498694","56c5062ebdcde80d00498695"],"version":"56c50626bdcde80d00498635","__v":1,"project":"54774d9af3736008009e9e0e","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-03-17T14:16:14.542Z","from_sync":false,"order":2,"slug":"classes","title":"Data Classes"},"editedParams2":true,"editedParams":true,"parentDoc":null,"project":"54774d9af3736008009e9e0e","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"},"githubsync":"","user":"54774c47f3736008009e9e0c","__v":0,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-16T16:47:24.041Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"curl -X PATCH \\\n-H \"X-API-KEY: ACCOUNT_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"description\":\"List of all known witchers\"}' \\\n\"https://api.syncano.io/v1.1/instances/INSTANCE_NAME/classes/DATA_CLASS_NAME\"","language":"curl"},{"code":"import syncano \nfrom syncano.models import Class\n\nsyncano.connect(api_key='ACCOUNT_KEY', instance_name='INSTANCE_NAME')\n\nclass_instance = Class.please.get(name='CLASS_NAME')\n\nclass_instance.description = \"New description\"\nclass_instance.schema.add(\n    {\"name\": \"name\", \"type\": \"string\"},\n    {\"name\": \"illustrator\", \"type\": \"string\"}\n)\nclass_instance.save()","language":"python"},{"language":"javascript","code":"var Syncano = require('syncano');\nvar connection = Syncano({accountKey: 'ACCOUNT_KEY'});\nvar Class = connection.Class;\n\nvar query = {\n  \"name\":\"witchers\",\n  \"instanceName\": \"INSTANCE_NAME\"\n};\nvar update = {\n  \"description\":\"List of all known Witchers\"\n};\n\nClass.please().update(query, update).then(callback);"}]},"method":"patch","results":{"codes":[{"name":"","code":"{\n  \"status\": \"ready\",\n  \"group\": null,\n  \"name\": \"witchers\",\n  \"links\": {\n    \"self\": \"/v1.1/instances/rivia/classes/witchers/\",\n    \"objects\": \"/v1.1/instances/rivia/classes/witchers/objects/\"\n  },\n  \"group_permissions\": \"create_objects\",\n  \"created_at\": \"2015-05-18T18:59:56.220333Z\",\n  \"description\": \"List of all known witchers\",\n  \"updated_at\": \"2016-03-10T19:28:52.986094Z\",\n  \"objects_count\": 5,\n  \"metadata\": {},\n  \"revision\": 4,\n  \"other_permissions\": \"create_objects\",\n  \"schema\": [\n    {\n      \"type\": \"string\",\n      \"name\": \"name\"\n    },\n    {\n      \"filter_index\": true,\n      \"type\": \"string\",\n      \"name\": \"city\"\n    }\n  ]\n}","language":"json","status":200},{"name":"","code":"{\n  \"non_field_errors\": [\n    \"Revision mismatch. Expected 3, got 1.\"\n  ]\n}","language":"json","status":400},{"status":403,"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}"},{"language":"json","code":"{\n  \"detail\": \"Not found\"\n}","status":404}]},"settings":"56c50c06d1b8770d00922288","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":"54e2124741678e0d009f22e6","ref":"","in":"body","required":false,"desc":"Data Class description","default":"","type":"string","name":"descritption"},{"_id":"555a8eca4bf0e119004a2545","ref":"","in":"body","required":false,"desc":"Additional JSON metadata associated with the class","default":"","type":"object","name":"metadata"},{"_id":"54e2124741678e0d009f22e5","ref":"","in":"body","required":false,"desc":"Data Class schema","default":"","type":"mixed","name":"schema"},{"_id":"555a8dfdbcb32e19006f81ea","ref":"","in":"body","required":false,"desc":"Expected revision (version) of the data class","default":"","type":"int","name":"expected_revision"},{"_id":"555a8e28147f91190092d200","ref":"","in":"body","required":false,"desc":"Group ID of a group associated with the data class (group owner)","default":"","type":"int","name":"group"},{"_id":"555a8ea6147f91190092d201","ref":"","in":"body","required":false,"desc":"Permission of users inside a group associated with the Data Class. Can be of type: \"none\", \"read\", \"create_objects\".","default":"none","type":"string","name":"group_permissions"},{"_id":"555a909b4bf0e119004a2546","ref":"","in":"body","required":false,"desc":"Permission of users not belonging to a group associated with the Data Class. Can be of type: \"none\", \"read\", \"create_objects\".","default":"none","type":"string","name":"other_permissions"}],"url":"/instances/:instance_name/classes/:data_class_name/"},"isReference":true,"order":4,"body":"Lets you edit the properties of a selected Data Class. To update a Data Class, you will need to use an `account_key` - using an instance `api_key` will not work.","excerpt":"Update a class","slug":"class-edit-patch","type":"endpoint","title":"Data Class - update"}

patchData Class - update

Update a class

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name
class_name:
required
string
Data Class name

Body Params

descritption:
string
Data Class description
metadata:
object
Additional JSON metadata associated with the class
schema:
mixed
Data Class schema
expected_revision:
integer
Expected revision (version) of the data class
group:
integer
Group ID of a group associated with the data class (group owner)
group_permissions:
stringnone
Permission of users inside a group associated with the Data Class. Can be of type: "none", "read", "create_objects".
other_permissions:
stringnone
Permission of users not belonging to a group associated with the Data Class. Can be of type: "none", "read", "create_objects".

Examples


Result Format


Documentation

Lets you edit the properties of a selected Data Class. To update a Data Class, you will need to use an `account_key` - using an instance `api_key` will not work.

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 }}