{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance_name/classes/","auth":"required","examples":{"codes":[{"name":"","code":"curl -X POST \\\n-H \"X-API-KEY: ACCOUNT_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"name\":\"witchers\",\n     \"description\":\"List of all known Witchers\",\n     \"schema\":[\n          {\"type\":\"string\",\"name\":\"name\"},\n          {\"type\":\"string\",\"name\":\"city\", \"filter_index\":true}]}' \\\n\"https://api.syncano.io/v1.1/instances/INSTANCE_NAME/classes/\"","language":"curl"},{"code":"import syncano\nfrom syncano.models import Class\n\nconnection = syncano.connect(api_key=\"ACCOUNT_KEY\", instance_name='INSTANCE_NAME')\n\nbook_class = Class.please.create(\n    name='witchers',\n    description='List of all known Witchers',\n    schema=[\n        {\"name\": \"name\", \"type\": \"string\"},\n        {\"name\": \"city\", \"type\": \"string\", \"filter_index\": True}\n    ])\n","language":"python"},{"name":"JavaScript","language":"javascript","code":"var Syncano = require('syncano');\nvar connection = Syncano({accountKey: 'ACCOUNT_KEY'});\nvar Class = connection.Class;\n\nvar cls = {\n  \"name\":\"witchers\",\n  \"instanceName\": \"INSTANCE_NAME\",\n  \"description\":\"List of all known Witchers\",\n  \"schema\":[\n    {\"type\":\"string\",\"name\":\"name\"},   \n    {\"type\":\"string\",\"name\":\"city\",\"filter_index\":true}\n  ]\n};\n\nClass.please().create(cls).then(callback);"}]},"method":"post","params":[{"name":"instance_name","type":"string","default":"","desc":"Instance name","required":true,"in":"path","ref":"","_id":"54d8b350628f540d00f3e4ae"},{"name":"name","type":"string","default":"","desc":"Data Class name - max 64 characters.","required":true,"in":"body","ref":"","_id":"54dca97eac05560d003359af"},{"name":"description","type":"string","default":"","desc":"Data Class Description","required":false,"in":"body","ref":"","_id":"54dca97eac05560d003359ae"},{"name":"metadata","type":"object","default":"","desc":"Additional JSON metadata associated with the Class","required":false,"in":"body","ref":"","_id":"555a96f6147f91190092d208"},{"name":"schema","type":"mixed","default":"[{\"type\": \"string\", \"name\": \"parameter_name\"}]","desc":"Data Class schema. It defines the Data Objects that will be created within the Data Class. `type` (i.e. `string`) and `name` are required fields. The very basic schema would look like this: `[{\"type\": \"string\", \"name\": \"parameter_name\"}]` Read more about Data Classes and Data Class schemas [here](http://docs.syncano.com/docs/classes).","required":false,"in":"body","ref":"","_id":"54dca97eac05560d003359ad"},{"name":"group","type":"int","default":"","desc":"Group ID of a group associated with the Class (group owner)","required":false,"in":"body","ref":"","_id":"555a960abcb32e19006f81f6"},{"name":"group_permissions","type":"string","default":"none","desc":"Permission of users inside a group associated with the Class. Can be of type: \"none\", \"read\", \"create_objects","required":false,"in":"body","ref":"","_id":"555a9620bcb32e19006f81f7"},{"name":"other_permissions","type":"string","default":"none","desc":"Permission of users not belonging to a group associated with the Class. Can be of type: \"none\", \"read\", \"create_objects\".","required":false,"in":"body","ref":"","_id":"555a96f6147f91190092d207"}],"results":{"codes":[{"language":"json","status":201,"name":"","code":"{\n  \"status\": \"migrating\",\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\": \"2016-03-10T19:17:56.181118Z\",\n  \"description\": \"List of all known Witchers\",\n  \"updated_at\": \"2016-03-10T19:17:56.181140Z\",\n  \"objects_count\": 0,\n  \"metadata\": {},\n  \"revision\": 1,\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}"},{"code":"{\n  \"detail\": \"No such API Key.\"\n}","language":"json","status":403},{"code":"{\n  \"detail\": \"Instance was not found.\"\n}","language":"json","status":404}]},"settings":"56c50c06d1b8770d00922288"},"next":{"description":"","pages":[]},"title":"Data Class - add","type":"endpoint","slug":"class-add","excerpt":"Add a new class","body":"Creates a new Data Class. To create a new Data Class, you will need to use an `account_key` - using an instance `api_key` will not work.","updates":[],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c5062ebdcde80d00498692","project":"54774d9af3736008009e9e0e","__v":0,"parentDoc":null,"user":"54774c47f3736008009e9e0c","version":{"version":"0.1.1","version_clean":"0.1.1","codename":"API v1.1","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":true,"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"],"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z"},"editedParams":true,"editedParams2":true,"githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":["56c5062ebdcde80d00498690","56c5062ebdcde80d00498691","56c5062ebdcde80d00498692","56c5062ebdcde80d00498693","56c5062ebdcde80d00498694","56c5062ebdcde80d00498695"],"title":"Data Classes","slug":"classes","order":2,"from_sync":false,"reference":true,"_id":"56c50628bdcde80d00498638","createdAt":"2015-03-17T14:16:14.542Z","version":"56c50626bdcde80d00498635","__v":1,"project":"54774d9af3736008009e9e0e"},"createdAt":"2015-02-12T13:19:24.509Z"}

postData Class - add

Add a new class

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name

Body Params

name:
required
string
Data Class name - max 64 characters.
description:
string
Data Class Description
metadata:
object
Additional JSON metadata associated with the Class
schema:
mixed[{"type": "string", "name": "parameter_name"}]
Data Class schema. It defines the Data Objects that will be created within the Data Class. `type` (i.e. `string`) and `name` are required fields. The very basic schema would look like this: `[{"type": "string", "name": "parameter_name"}]` Read more about Data Classes and Data Class schemas [here](http://docs.syncano.com/docs/classes).
group:
integer
Group ID of a group associated with the Class (group owner)
group_permissions:
stringnone
Permission of users inside a group associated with the Class. Can be of type: "none", "read", "create_objects
other_permissions:
stringnone
Permission of users not belonging to a group associated with the Class. Can be of type: "none", "read", "create_objects".

Examples


Result Format


Documentation

Creates a new Data Class. To create a new Data Class, you will need to use an `account_key` - using an instance `api_key` will not work.

User Information

Try It Out

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