{"_id":"56c5062ebdcde80d00498690","editedParams":true,"parentDoc":null,"githubsync":"","__v":0,"user":"54774c47f3736008009e9e0c","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"},"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,"project":"54774d9af3736008009e9e0e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-12T11:15:25.699Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"curl -X GET \\\n-H \"X-API-KEY: API_KEY\" \\\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='API_KEY', instance_name=\"INSTANCE_NAME\")\n\nclasses = Class.please.list()","language":"python"},{"code":"var Syncano = require('syncano');\nvar connection = Syncano({apiKey: 'API_KEY'});\nvar Class = connection.Class;\n\nClass.please().list({instanceName: 'INSTANCE_NAME'}).then(callback);","language":"javascript","name":"JavaScript"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"prev\": null,\n  \"objects\": [\n    {\n      \"status\": \"ready\",\n      \"group\": null,\n      \"name\": \"user_profile\",\n      \"links\": {\n        \"self\": \"/v1.1/instances/rivia/classes/user_profile/\",\n        \"objects\": \"/v1.1/instances/rivia/classes/user_profile/objects/\"\n      },\n      \"group_permissions\": \"none\",\n      \"created_at\": \"2015-05-18T18:26:25.278416Z\",\n      \"description\": \"Data Class that holds profiles for users.\",\n      \"updated_at\": \"2015-05-18T18:26:25.278445Z\",\n      \"objects_count\": 6,\n      \"metadata\": {},\n      \"revision\": 1,\n      \"other_permissions\": \"none\",\n      \"schema\": []\n    },\n    {\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 and alive Witchers\",\n      \"updated_at\": \"2015-05-21T18:39:46.555101Z\",\n      \"objects_count\": 5,\n      \"metadata\": {},\n      \"revision\": 3,\n      \"other_permissions\": \"create_objects\",\n      \"schema\": [\n        {\n          \"type\": \"string\",\n          \"name\": \"name\"\n        },\n        {\n          \"order_index\": true,\n          \"filter_index\": true,\n          \"type\": \"string\",\n          \"name\": \"city\"\n        }\n      ]\n    }\n  ],\n  \"next\": null\n}","name":""},{"status":403,"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}"},{"code":"{\n  \"detail\": \"Instance was not found.\"\n}","status":404,"language":"json"}]},"settings":"56c50c06d1b8770d00922288","auth":"required","params":[{"_id":"54d8b350628f540d00f3e4ae","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance_name"}],"url":"/instances/:instance_name/classes/"},"isReference":true,"order":0,"body":"Gets a list of all Data Classes associated with a chosen Instance. This is the only method, next to obtaining Data Class details in the Data Classes endpoint that will work with an instance `api_key`. All other methods (creating new data class, modifying and deleting it) will need an `account_key`.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"API Key vs Account Key\",\n  \"body\": \"As the Account Key acts as an admin key, it has access to every data class - you can list and modify all of them.\\n\\nThe API Key can see all the data classes only if it has the `ignore_acl` flag set to true, or has access to specific data classes added though proper permissions - see [Permissions doc](http://docs.syncano.com/docs/permissions).\\nSo if you use the API Key by itself (without combining it with a User Key), you will only see data classes with `other_permission` set to either `read` or `create_objects`. If `other_permissions` is none, you won't see those data classes listed. \\n\\nIf you use the API Key in combination with a User Key, you will be able to list data classes with `other_permission` set to `read` or `create_objects`, or if the User is a part of the group owning the data class - also if the `group_permission` is seg to to `read` or `create_objects`.\\n\\nSee [Permissions doc](http://docs.syncano.com/docs/permissions) for more information.\"\n}\n[/block]","excerpt":"List available classes","slug":"classes-list","type":"endpoint","title":"Data Class - list"}

getData Class - list

List available classes

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name

Examples


Result Format


Documentation

Gets a list of all Data Classes associated with a chosen Instance. This is the only method, next to obtaining Data Class details in the Data Classes endpoint that will work with an instance `api_key`. All other methods (creating new data class, modifying and deleting it) will need an `account_key`. [block:callout] { "type": "warning", "title": "API Key vs Account Key", "body": "As the Account Key acts as an admin key, it has access to every data class - you can list and modify all of them.\n\nThe API Key can see all the data classes only if it has the `ignore_acl` flag set to true, or has access to specific data classes added though proper permissions - see [Permissions doc](http://docs.syncano.com/docs/permissions).\nSo if you use the API Key by itself (without combining it with a User Key), you will only see data classes with `other_permission` set to either `read` or `create_objects`. If `other_permissions` is none, you won't see those data classes listed. \n\nIf you use the API Key in combination with a User Key, you will be able to list data classes with `other_permission` set to `read` or `create_objects`, or if the User is a part of the group owning the data class - also if the `group_permission` is seg to to `read` or `create_objects`.\n\nSee [Permissions doc](http://docs.syncano.com/docs/permissions) for more information." } [/block]

User Information

Try It Out

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