Home

Returns the details of the given entity

GET
api/databases/{dbid}/entities/{entity}/{id}
This request is used for getting the properties' values of the given entity as well as its system parameters, such as:
Id - Entity ID
Code - Entity Code
EditingUser - Reference to the user (if any) who is editing the given entity now
Revision - Entity Revision Number (it is increased automatically each time entity gets modified and saved)
IsNew - Value that shows whether entity has just been created and not saved yet ('true'), or not ('false')
InfoName - Entity MetaName
ETag - Entity Tag (it changes automatically each time entity gets modified and saved)
ModifiedStamp - Date and time the entity 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

Response:

Content

Name Type Options Description
Code String  Entity code
EditingUser ObjectRef  User that edits entity at this time
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
IsNew Boolean  New entity and never been saved
Modified Boolean  If the entity is edited shows whether there is changes
ModifiedStamp Date  Last modified of object
Properties Array of name: value  List of properties of an object
Revision Integer  Revision of entity

Request:
  1. GET api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Task/7ce10c00-ea30-4ab4-ab57-87bec4fb558f
  2. Accept: text/json
  3. Accept-Encoding: deflate
  4. Host: localhost:6496
  5. Cookie: sid=d8ee1782-edf8-4ca0-88df-514db7d23043
Response:
  1. Transfer-Encoding: chunked
  2. Content-Encoding: 
  3. Cache-Control: no-store
  4. Content-Type: text/json; charset=utf-8
  5. Date: Fri, 21 Dec 2012 14:52:21 GMT
  6. ETag: "3"
  7. Last-Modified: Fri, 21 Dec 2012 14:31:09 GMT
  8. Server: Microsoft-HTTPAPI/2.0
  9.  
  10. {
  11.   "Code": "T188",
  12.   "Modified": false,
  13.   "Revision": 3,
  14.   "IsNew": false,
  15.   "Id": "7ce10c00-ea30-4ab4-ab57-87bec4fb558f",
  16.   "InfoName": "Task",
  17.   "ETag": "634917042696780591",
  18.   "ModifiedStamp": "2012-12-21T16:31:09.6780591+02:00",
  19.   "IsMarkedAsDeleted": false,
  20.   "Properties": {
  21.     "Id": "7ce10c00-ea30-4ab4-ab57-87bec4fb558f",
  22.     "MaxScheduleItemsFinish": "1753-01-01T02:00:00+02:00",
  23.     "Complete": 0.0,
  24.     "Code": "T188",
  25.     "Owner": {
  26.       "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Users/ae18dea5-4f60-4f70-ae31-d8052984e31e",
  27.       "Title": "admin"
  28.     },
  29.     "StartedTime": "2012-12-18T16:55:55.2381966+02:00",
  30.     "ClosedTime": null,
  31.     "Estimate": {
  32.       "Value": 8.0,
  33.       "Kind": 1,
  34.       "PureWorkTime": 0.33333333333333331,
  35.       "Title": "8 Hours"
  36.     },
  37.     "Remain": {
  38.       "Value": 8.0,
  39.       "Kind": 1,
  40.       "PureWorkTime": 0.33333333333333331,
  41.       "Title": "8 Hours"
  42.     },
  43.     "Actual": {
  44.       "Value": 2.0,
  45.       "Kind": 1,
  46.       "PureWorkTime": 0.083333333333333329,
  47.       "Title": "2 Hours"
  48.     },
  49.     "PreviusNonBlockedState": null,
  50.     "AssignmentsDisplayValue": {
  51.       "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/tables/SubEntityItemsDisplayValues/cf8932a8-ec82-4318-8de4-089fc721153f",
  52.       "Title": "admin"
  53.     },
  54.     "AssignmentsFilterValue": " $ ",
  55.     "PredecessorsDisplayValue": null,
  56.     "PredecessorsFilterValue": null,
  57.     "SchedleStart": null,
  58.     "SchedleFinish": null,
  59.     "IsScheduled": false,
  60.     "EntityCreator": {
  61.       "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Users/ae18dea5-4f60-4f70-ae31-d8052984e31e",
  62.       "Title": "admin"
  63.     },
  64.     "EntityCreatedTime": "2012-12-18T16:55:54.9051966+02:00",
  65.     "EntityModifiedTime": "2012-12-21T16:31:09.5660479+02:00",
  66.     "Name": "New task name",
  67.     "Note": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Task/7ce10c00-ea30-4ab4-ab57-87bec4fb558f/data/Note",
  68.     "NoteLite": "abcdef",
  69.     "Project": null,
  70.     "State": {
  71.       "Value": "Vqs.Tm.Shared.TmTaskStates.InProgress",
  72.       "Title": "In Progress"
  73.     },
  74.     "Reason": {
  75.       "Value": "Vqs.Tm.Shared.TmTaskReasons.Started",
  76.       "Title": "Started"
  77.     },
  78.     "WorkflowCustomization": null,
  79.     "TreeLinks": [
  80.       {
  81.         "ParentId": "7ce10c00-ea30-4ab4-ab57-87bec4fb558f",
  82.         "ChildId": "7ce10c00-ea30-4ab4-ab57-87bec4fb558f",
  83.         "Distance": 0
  84.       }
  85.     ],
  86.     "TreeCodePath": " $H ",
  87.     "TimeLogItemsCount": 2,
  88.     "Deviation": {
  89.       "Value": -1.9999999999999996,
  90.       "Kind": 1,
  91.       "PureWorkTime": -0.083333333333333315,
  92.       "Title": "-2 Hours"
  93.     },
  94.     "OverdueRisk": true,
  95.     "Folder": null,
  96.     "Template": null,
  97.     "TimeEventSubscriptionFlags": null,
  98.     "Follow": 188.0,
  99.     "Priority": {
  100.       "Value": 0,
  101.       "Title": "D"
  102.     },
  103.     "StackValue": 500,
  104.     "Parent": null,
  105.     "IsHaveDueDate": true,
  106.     "DueDate": "2012-12-28T00:00:00+02:00",
  107.     "IsRecurrence": false,
  108.     "RecurrenceInfo": null,
  109.     "RecurrenceTaskUsers": {
  110.       "Values": [
  111.         {
  112.           "Id": "ae18dea5-4f60-4f70-ae31-d8052984e31e",
  113.           "DisplayText": "admin"
  114.         }
  115.       ],
  116.       "DisplayText": "admin"
  117.     },
  118.     "RecurrenceTaskReminderForStart": null,
  119.     "RecurrenceTaskReminderForFinish": null,
  120.     "RecurrenceTaskRollupOptions": {
  121.       "DuplicatedFields": [
  122.         {
  123.           "Id": "Owner",
  124.           "DisplayText": "Owner"
  125.         },
  126.         {
  127.           "Id": "Estimate",
  128.           "DisplayText": "Estimate"
  129.         },
  130.         {
  131.           "Id": "Note",
  132.           "DisplayText": "Note"
  133.         },
  134.         {
  135.           "Id": "Project",
  136.           "DisplayText": "Project"
  137.         },
  138.         {
  139.           "Id": "Folder",
  140.           "DisplayText": "Folder"
  141.         },
  142.         {
  143.           "Id": "Template",
  144.           "DisplayText": "Template"
  145.         },
  146.         {
  147.           "Id": "Priority",
  148.           "DisplayText": "U/I"
  149.         },
  150.         {
  151.           "Id": "StackValue",
  152.           "DisplayText": "Priority"
  153.         },
  154.         {
  155.           "Id": "ReminderAt",
  156.           "DisplayText": "Remind at"
  157.         },
  158.         {
  159.           "Id": "DuplicateField_DueDate",
  160.           "DisplayText": "Due date"
  161.         },
  162.         {
  163.           "Id": "Assignments",
  164.           "DisplayText": "Assigned To"
  165.         },
  166.         {
  167.           "Id": "Links",
  168.           "DisplayText": "Links"
  169.         }
  170.       ]
  171.     },
  172.     "OverdueProcessed": false,
  173.     "Overdue": false,
  174.     "SubTasksCount": 0,
  175.     "PhaseDueDate": null,
  176.     "ReminderAt": null,
  177.     "ReminderAtHash": null,
  178.     "ReminderBeforeDueDate": null,
  179.     "ReminderBeforeDueDateHash": null,
  180.     "CommentLite": null,
  181.     "LinksCount": 0,
  182.     "LinksEntityCodes": null
  183.   }
  184. }