{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance_name/endpoints/data/","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"class\": \"employee\",\n    \"description\": \"Gets list of available employees in the company\",\n    \"excluded_fields\": \"surname\",\n    \"expand\": \"team\",\n    \"links\": {\n        \"clear_cache\": \"/v1.1/instances/INSTANCE_NAME/endpoints/data/employees/clear_cache/\",\n        \"get\": \"/v1.1/instances/INSTANCE_NAME/endpoints/data/employees/get/\",\n        \"rename\": \"/v1.1/instances/INSTANCE_NAME/endpoints/data/employees/rename/\",\n        \"self\": \"/v1.1/instances/INSTANCE_NAME/endpoints/data/employees/\"\n    },\n    \"name\": \"employees\",\n    \"order_by\": \"name\",\n    \"page_size\": 5,\n    \"query\": {\n        \"age\": {\n            \"_eq\": \"20\"\n        }\n    }\n}","name":""}]},"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"language":"curl","code":"curl -X POST \\\n-H \"X-API-KEY: ACCOUNT_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"order_by\": \"name\",\n     \"name\": \"employees\",\n     \"excluded_fields\": \"surname\",\n     \"page_size\": 5,\n     \"query\": {\"age\":{\"_eq\":\"20\"}},\n     \"class\": \"employee\",\n     \"expand\": \"team\",\n     \"description\": \"Gets list of available employees in the company\"}' \\\n\"https://api.syncano.io/v1.1/instances/INSTANCE_NAME/endpoints/data/\""},{"language":"javascript","code":"var Syncano = require('syncano');\nvar connection = Syncano({apiKey: 'API_KEY',\n                          userKey: 'USER_KEY', \n                         });\nvar data = { name: 'DATAENDPOINT_NAME',\n                   description: 'DESCRIPTION',\n                   instanceName: 'INSTANCE_NAME',\n                   query: {},\n                   class: 'CLASS_NAME',\n                   order_by: 'FIELD_NAME',\n                   page_size: 5\n                 };\nvar DataEndpoint = connection.DataEndpoint;\n\nDataEndpoint\n  .please()\n  .create(data)\n  .then(function(res) { \n      console.log(res);\n  });"}]},"method":"post","params":[{"name":"instance_name","type":"string","default":"","desc":"Instance name","required":true,"in":"path","ref":"","_id":"5739d4e6988aa80e0068d925"},{"name":"name","type":"string","default":"","desc":"Data Endpoint name","required":true,"in":"body","ref":"","_id":"5739d4e6988aa80e0068d924"},{"name":"class","type":"string","default":"","desc":"Data Class name with data","required":true,"in":"body","ref":"","_id":"5739d4e6988aa80e0068d923"},{"name":"description","type":"string","default":"","desc":"Data Endpoint description","required":false,"in":"body","ref":"","_id":"5739d5e8ff55262000f4dbd1"},{"name":"page_size","type":"int","default":"","desc":"Sets the number of objects returned in one call","required":false,"in":"body","ref":"","_id":"5739d5e8ff55262000f4dbd0"},{"name":"query","type":"object","default":"","desc":"Query used to filter","required":false,"in":"body","ref":"","_id":"5739d5e8ff55262000f4dbcf"},{"name":"excluded_fields","type":"string","default":"","desc":"Fields excluded from returned objects","required":false,"in":"body","ref":"","_id":"5739d5e8ff55262000f4dbce"},{"name":"order_by","type":"string","default":"","desc":"Field to use when ordering data","required":false,"in":"body","ref":"","_id":"5739d5e8ff55262000f4dbcd"},{"name":"expand","type":"string","default":"","desc":"Relation to be expanded in returned objects","required":false,"in":"body","ref":"","_id":"5739d5e8ff55262000f4dbcc"}]},"next":{"description":"","pages":[]},"title":"Data Endpoints - add","type":"endpoint","slug":"data-endpoints-add","excerpt":"","body":"","updates":[],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5739d3c051a5cd1700b84c0e","project":"54774d9af3736008009e9e0e","editedParams2":true,"parentDoc":null,"createdAt":"2016-05-16T14:05:52.696Z","user":"5718db25f8f7de1900683f8c","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"},"__v":2,"githubsync":"","editedParams":true,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Data Endpoints","slug":"data-endpoints","order":4,"from_sync":false,"reference":true,"_id":"5739ca371f4b740e00b06e09","createdAt":"2016-05-16T13:25:11.536Z","__v":0,"project":"54774d9af3736008009e9e0e","version":"56c50626bdcde80d00498635"}}

postData Endpoints - add


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name

Body Params

name:
required
string
Data Endpoint name
class:
required
string
Data Class name with data
description:
string
Data Endpoint description
page_size:
integer
Sets the number of objects returned in one call
query:
object
Query used to filter
excluded_fields:
string
Fields excluded from returned objects
order_by:
string
Field to use when ordering data
expand:
string
Relation to be expanded in returned objects

Examples


Result Format


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