Home

Returns the list of all records with selected fields of the given entity table

GET
api/databases/{dbid}/entities/{entity}/{id}/{table}/query
This request is used for getting the given entity table records list that includes values of selected fields only. For example, you can get the list of task schedule items, including fields as 'start', 'finish', 'allday' only: ?fields=start;finish;allday
Also this request can contain expressions which will calculate the values of selected fields according to the formulas.

Request:

Argument Type Description
dbid GUID  The ID of the database
entity String  The name of the entity
id GUID  The ID of the entity
table String  The name of the entity table
Query parameter Required Default Options Description
fields 1      Returns selected fields
filter       Sets filter
skip       Returns data starting from the given item
top     Max 200  Returns the given number of data items

Response:

Content

Name Type Options Description
IsTooManyItems Boolean  Is too many result objects
Items Array of Object  Result object list

Request:
  1. GET api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Task/08a11e00-188f-45d0-b767-d8620bedbad2/TaskScheduleItems/query?fields=id;start;finish;users
  2. Accept: text/json
  3. Accept-Encoding: deflate
  4. Host: localhost:6496
  5. Cookie: sid=41f1cc3d-2701-4185-8d3c-8dcd60be24dc
Response:
  1. Transfer-Encoding: chunked
  2. Content-Encoding: 
  3. Cache-Control: no-store
  4. Content-Type: text/json; charset=utf-8
  5. Date: Wed, 26 Dec 2012 13:39:41 GMT
  6. Server: Microsoft-HTTPAPI/2.0
  7.  
  8. {
  9.   "IsTooManyItems": false,
  10.   "Items": [
  11.     {
  12.       "id": "a3570b1d-3a72-427e-ac38-c3324fb97031",
  13.       "start": "2013-01-01T08:00:00+02:00",
  14.       "finish": "2013-01-01T12:00:00+02:00",
  15.       "users": {
  16.         "Values": [
  17.           {
  18.             "Id": "ae18dea5-4f60-4f70-ae31-d8052984e31e",
  19.             "DisplayText": "admin"
  20.           }
  21.         ],
  22.         "DisplayText": "admin"
  23.       }
  24.     },
  25.     {
  26.       "id": "7c7870ab-015a-43ef-b574-cd8f1b3e7a22",
  27.       "start": "2013-01-01T08:00:00+02:00",
  28.       "finish": "2013-01-01T12:00:00+02:00",
  29.       "users": {
  30.         "Values": [
  31.           {
  32.             "Id": "ae18dea5-4f60-4f70-ae31-d8052984e31e",
  33.             "DisplayText": "admin"
  34.           }
  35.         ],
  36.         "DisplayText": "admin"
  37.       }
  38.     }
  39.   ]
  40. }