Home

Returns the details of the given record of the given entity table

GET
api/databases/{dbid}/entities/{entity}/{id}/{table}/{tid}
This request is used for getting the information of the given entity table record as well as its system parameters such as:
Id - Entity table record ID
InfoName - MetaName of entity table
ETag - Tag of entity table record (it changes automatically each time entity table record gets modified and saved)
ModifiedStamp - Date and time the entity table record was last modified

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
tid GUID  The ID of the entity table record

Response:

Content

Name Type Options Description
ETag String  ETag of object
Id GUID  The id of the object
InfoName String  The name of the object
IsMarkedAsDeleted Boolean  Indicates that the object is marked for deletion
ModifiedStamp Date  Last modified of object
Properties Array of name: value  List of properties of an object

Request:
  1. GET api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Task/08a11e00-188f-45d0-b767-d8620bedbad2/TaskScheduleItems/a3570b1d-3a72-427e-ac38-c3324fb97031
  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:42:19 GMT
  6. ETag: "634921333223490762"
  7. Last-Modified: Wed, 26 Dec 2012 13:42:02 GMT
  8. Server: Microsoft-HTTPAPI/2.0
  9.  
  10. {
  11.   "Id": "a3570b1d-3a72-427e-ac38-c3324fb97031",
  12.   "InfoName": "TaskScheduleItems",
  13.   "ETag": "634921333223490762",
  14.   "ModifiedStamp": "2012-12-26T15:42:02.3490762+02:00",
  15.   "IsMarkedAsDeleted": false,
  16.   "Properties": {
  17.     "Id": "a3570b1d-3a72-427e-ac38-c3324fb97031",
  18.     "Users": {
  19.       "Values": [
  20.         {
  21.           "Id": "ae18dea5-4f60-4f70-ae31-d8052984e31e",
  22.           "DisplayText": "admin"
  23.         }
  24.       ],
  25.       "DisplayText": "admin"
  26.     },
  27.     "ReminderForStart": {
  28.       "Offset": {
  29.         "Value": 1.0,
  30.         "Kind": 2,
  31.         "PureWorkTime": 1.0,
  32.         "Title": "1 Days"
  33.       },
  34.       "Users": [
  35.         {
  36.           "Id": "ae18dea5-4f60-4f70-ae31-d8052984e31e",
  37.           "DisplayText": "admin"
  38.         }
  39.       ],
  40.       "HideUsers": false,
  41.       "OffsetKind": -1,
  42.       "Description": "'reminder before start' set via API"
  43.     },
  44.     "ReminderForFinish": null,
  45.     "Start": "2013-01-01T08:00:00+02:00",
  46.     "Finish": "2013-01-01T17:00:00+02:00",
  47.     "AllDay": true,
  48.     "RecurrenceInfo": null,
  49.     "RecurrencePatternId": null,
  50.     "DeletedRecurrences": null,
  51.     "RecurrenceExceptions": null
  52.   }
  53. }