{"_id":"56c5062fbdcde80d0049869b","editedParams":true,"githubsync":"","project":"54774d9af3736008009e9e0e","editedParams2":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"},"__v":2,"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"},"parentDoc":null,"user":"54774c47f3736008009e9e0c","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-20T13:59:00.316Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","name":"","code":"curl -X GET \\\n-H \"X-API-KEY: API_KEY\" \\\n-H \"X-USER-KEY: USER_KEY\" \\\n\"https://api.syncano.io/v1.1/instances/INSTANCE_NAME/classes/DATA_CLASS_NAME/objects/OBJECT_ID/\""},{"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_instance = Object.please.get(\n    id=\"OBJECT_ID\",\n    class_name=\"CLASS_NAME\"\n)\n\nprint(object_instance.title)\n","language":"python"},{"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\nDataObject.please().get().then(callback);","language":"javascript"}]},"method":"get","results":{"codes":[{"code":"{\n  \"channel_room\": null,\n  \"group\": null,\n  \"name\": \"Geralt\",\n  \"links\": {\n    \"self\": \"/v1.1/instances/rivia/classes/witchers/objects/11/\"\n  },\n  \"city\": \"Rivia\",\n  \"group_permissions\": \"none\",\n  \"created_at\": \"2015-05-20T19:43:13.480389Z\",\n  \"owner_permissions\": \"none\",\n  \"updated_at\": \"2015-05-20T19:43:13.480436Z\",\n  \"other_permissions\": \"none\",\n  \"owner\": null,\n  \"id\": 11,\n  \"channel\": null,\n  \"revision\": 1\n}","language":"json","status":200,"name":""},{"code":"{\n  \"detail\": \"No such API Key.\"\n}","language":"json","status":403},{"status":404,"code":"{\n  \"detail\": \"Not found\"\n}","language":"json"}]},"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":"54e73da43323130d002e684a","ref":"","in":"path","required":true,"desc":"Data Object Id","default":"","type":"int","name":"data_object_id"}],"url":"/instances/:instance_name/classes/:class_name/objects/:data_object_id/"},"isReference":true,"order":0,"body":"[block:callout]\n{\n  \"type\": \"warning\",\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  \"title\": \"Authentication & API Keys\"\n}\n[/block]\nGet details of a Data Object.","excerpt":"Get object details","slug":"data-object-details","type":"endpoint","title":"Data Object - details"}

getData Object - details

Get object details

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

Examples


Result Format


Documentation

[block:callout] { "type": "warning", "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.", "title": "Authentication & API Keys" } [/block] Get details of a Data Object.

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