{"_id":"5739d3c051a5cd1700b84c0e","project":"54774d9af3736008009e9e0e","editedParams2":true,"parentDoc":null,"user":"5718db25f8f7de1900683f8c","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,"githubsync":"","editedParams":true,"category":{"_id":"5739ca371f4b740e00b06e09","__v":0,"project":"54774d9af3736008009e9e0e","version":"56c50626bdcde80d00498635","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-16T13:25:11.536Z","from_sync":false,"order":4,"slug":"data-endpoints","title":"Data Endpoints"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-16T14:05:52.696Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","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}","language":"json","status":200}]},"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"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":"curl"},{"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  });","language":"javascript"}]},"method":"post","auth":"required","params":[{"_id":"5739d4e6988aa80e0068d925","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance_name"},{"_id":"5739d4e6988aa80e0068d924","ref":"","in":"body","required":true,"desc":"Data Endpoint name","default":"","type":"string","name":"name"},{"_id":"5739d4e6988aa80e0068d923","ref":"","in":"body","required":true,"desc":"Data Class name with data","default":"","type":"string","name":"class"},{"_id":"5739d5e8ff55262000f4dbd1","ref":"","in":"body","required":false,"desc":"Data Endpoint description","default":"","type":"string","name":"description"},{"_id":"5739d5e8ff55262000f4dbd0","ref":"","in":"body","required":false,"desc":"Sets the number of objects returned in one call","default":"","type":"int","name":"page_size"},{"_id":"5739d5e8ff55262000f4dbcf","ref":"","in":"body","required":false,"desc":"Query used to filter","default":"","type":"object","name":"query"},{"_id":"5739d5e8ff55262000f4dbce","ref":"","in":"body","required":false,"desc":"Fields excluded from returned objects","default":"","type":"string","name":"excluded_fields"},{"_id":"5739d5e8ff55262000f4dbcd","ref":"","in":"body","required":false,"desc":"Field to use when ordering data","default":"","type":"string","name":"order_by"},{"_id":"5739d5e8ff55262000f4dbcc","ref":"","in":"body","required":false,"desc":"Relation to be expanded in returned objects","default":"","type":"string","name":"expand"}],"url":"/instances/:instance_name/endpoints/data/"},"isReference":true,"order":2,"body":"","excerpt":"","slug":"data-endpoints-add","type":"endpoint","title":"Data Endpoints - add"}

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