Returns the list of entities

GET
api/databases/{dbid}/entities/{entity}
This request is used for getting the entity list of the given entity-type. The list can be filtered by using parameters 'filter', 'skip' and 'top'.

Request:

Argument Type Description
dbid GUID  The ID of the database
entity String  The name of the entity
Query parameter Required Default Options Description
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
  2. Accept: text/json
  3. Accept-Encoding: deflate
  4. Host: localhost:6496
  5. Cookie: sid=c424b715-d9fb-4f37-a6eb-8a1932bec70a
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:30:45 GMT
  6. Server: Microsoft-HTTPAPI/2.0
  7.  
  8. {
  9. "IsTooManyItems": false,
  10. "Items": [
  11. {
  12. "Id": "7ce10c00-ea30-4ab4-ab57-87bec4fb558f",
  13. "InfoName": "Task",
  14. "ETag": "634914465552641966",
  15. "ModifiedStamp": "2012-12-18T16:55:55.2641966+02:00",
  16. "IsMarkedAsDeleted": false,
  17. "Properties": {
  18. "Id": "7ce10c00-ea30-4ab4-ab57-87bec4fb558f",
  19. "MaxScheduleItemsFinish": "1753-01-01T02:00:00+02:00",
  20. "Complete": 0.0,
  21. "Code": "T188",
  22. "Owner": {
  23. "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Users/ae18dea5-4f60-4f70-ae31-d8052984e31e",
  24. "Title": "admin"
  25. },
  26. "StartedTime": "2012-12-18T16:55:55.2381966+02:00",
  27. "ClosedTime": null,
  28. "Estimate": {
  29. "Value": 8.0,
  30. "Kind": 1,
  31. "PureWorkTime": 0.33333333333333331,
  32. "Title": "8 Hours"
  33. },
  34. "Remain": {
  35. "Value": 8.0,
  36. "Kind": 1,
  37. "PureWorkTime": 0.33333333333333331,
  38. "Title": "8 Hours"
  39. },
  40. "Actual": {
  41. "Value": 2.0,
  42. "Kind": 1,
  43. "PureWorkTime": 0.083333333333333329,
  44. "Title": "2 Hours"
  45. },
  46. "PreviusNonBlockedState": null,
  47. "AssignmentsDisplayValue": {
  48. "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/tables/SubEntityItemsDisplayValues/cf8932a8-ec82-4318-8de4-089fc721153f",
  49. "Title": "admin"
  50. },
  51. "AssignmentsFilterValue": " $ ",
  52. "PredecessorsDisplayValue": null,
  53. "PredecessorsFilterValue": null,
  54. "SchedleStart": null,
  55. "SchedleFinish": null,
  56. "IsScheduled": false,
  57. "EntityCreator": {
  58. "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Users/ae18dea5-4f60-4f70-ae31-d8052984e31e",
  59. "Title": "admin"
  60. },
  61. "EntityCreatedTime": "2012-12-18T16:55:54.9051966+02:00",
  62. "EntityModifiedTime": "2012-12-18T16:55:55.2371966+02:00",
  63. "Name": "New Task name 87",
  64. "Note": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Task/7ce10c00-ea30-4ab4-ab57-87bec4fb558f/data/Note",
  65. "NoteLite": "abcdef",
  66. "Project": null,
  67. "State": {
  68. "Value": "Vqs.Tm.Shared.TmTaskStates.InProgress",
  69. "Title": "In Progress"
  70. },
  71. "Reason": {
  72. "Value": "Vqs.Tm.Shared.TmTaskReasons.Started",
  73. "Title": "Started"
  74. },
  75. "WorkflowCustomization": null,
  76. "TreeLinks": [
  77. {
  78. "ParentId": "7ce10c00-ea30-4ab4-ab57-87bec4fb558f",
  79. "ChildId": "7ce10c00-ea30-4ab4-ab57-87bec4fb558f",
  80. "Distance": 0
  81. }
  82. ],
  83. "TreeCodePath": " $H ",
  84. "TimeLogItemsCount": 2,
  85. "Deviation": {
  86. "Value": -1.9999999999999996,
  87. "Kind": 1,
  88. "PureWorkTime": -0.083333333333333315,
  89. "Title": "-2 Hours"
  90. },
  91. "OverdueRisk": true,
  92. "Folder": null,
  93. "Template": null,
  94. "TimeEventSubscriptionFlags": null,
  95. "Follow": 188.0,
  96. "Priority": {
  97. "Value": 0,
  98. "Title": "D"
  99. },
  100. "StackValue": 500,
  101. "Parent": null,
  102. "IsHaveDueDate": true,
  103. "DueDate": "2012-12-28T00:00:00+02:00",
  104. "IsRecurrence": false,
  105. "RecurrenceInfo": null,
  106. "RecurrenceTaskUsers": {
  107. "Values": [
  108. {
  109. "Id": "ae18dea5-4f60-4f70-ae31-d8052984e31e",
  110. "DisplayText": "admin"
  111. }
  112. ],
  113. "DisplayText": "admin"
  114. },
  115. "RecurrenceTaskReminderForStart": null,
  116. "RecurrenceTaskReminderForFinish": null,
  117. "RecurrenceTaskRollupOptions": {
  118. "DuplicatedFields": [
  119. {
  120. "Id": "Owner",
  121. "DisplayText": "Owner"
  122. },
  123. {
  124. "Id": "Estimate",
  125. "DisplayText": "Estimate"
  126. },
  127. {
  128. "Id": "Note",
  129. "DisplayText": "Note"
  130. },
  131. {
  132. "Id": "Project",
  133. "DisplayText": "Project"
  134. },
  135. {
  136. "Id": "Folder",
  137. "DisplayText": "Folder"
  138. },
  139. {
  140. "Id": "Template",
  141. "DisplayText": "Template"
  142. },
  143. {
  144. "Id": "Priority",
  145. "DisplayText": "U/I"
  146. },
  147. {
  148. "Id": "StackValue",
  149. "DisplayText": "Priority"
  150. },
  151. {
  152. "Id": "ReminderAt",
  153. "DisplayText": "Remind at"
  154. },
  155. {
  156. "Id": "DuplicateField_DueDate",
  157. "DisplayText": "Due date"
  158. },
  159. {
  160. "Id": "Assignments",
  161. "DisplayText": "Assigned To"
  162. },
  163. {
  164. "Id": "Links",
  165. "DisplayText": "Links"
  166. }
  167. ]
  168. },
  169. "OverdueProcessed": false,
  170. "Overdue": false,
  171. "SubTasksCount": 0,
  172. "PhaseDueDate": null,
  173. "ReminderAt": null,
  174. "ReminderAtHash": null,
  175. "ReminderBeforeDueDate": null,
  176. "ReminderBeforeDueDateHash": null,
  177. "CommentLite": null,
  178. "LinksCount": 0,
  179. "LinksEntityCodes": null
  180. }
  181. },
  182. {
  183. "Id": "7ded1d00-8c8a-4a69-a9a3-01c7a666458c",
  184. "InfoName": "Task",
  185. "ETag": "634914465319761966",
  186. "ModifiedStamp": "2012-12-18T16:55:31.9761966+02:00",
  187. "IsMarkedAsDeleted": false,
  188. "Properties": {
  189. "Id": "7ded1d00-8c8a-4a69-a9a3-01c7a666458c",
  190. "MaxScheduleItemsFinish": "1753-01-01T02:00:00+02:00",
  191. "Complete": 0.0,
  192. "Code": "T131",
  193. "Owner": {
  194. "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Users/ae18dea5-4f60-4f70-ae31-d8052984e31e",
  195. "Title": "admin"
  196. },
  197. "StartedTime": "2012-12-18T16:55:31.9501966+02:00",
  198. "ClosedTime": null,
  199. "Estimate": {
  200. "Value": 8.0,
  201. "Kind": 1,
  202. "PureWorkTime": 0.33333333333333331,
  203. "Title": "8 Hours"
  204. },
  205. "Remain": {
  206. "Value": 8.0,
  207. "Kind": 1,
  208. "PureWorkTime": 0.33333333333333331,
  209. "Title": "8 Hours"
  210. },
  211. "Actual": {
  212. "Value": 2.0,
  213. "Kind": 1,
  214. "PureWorkTime": 0.083333333333333329,
  215. "Title": "2 Hours"
  216. },
  217. "PreviusNonBlockedState": null,
  218. "AssignmentsDisplayValue": {
  219. "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/tables/SubEntityItemsDisplayValues/cf8932a8-ec82-4318-8de4-089fc721153f",
  220. "Title": "admin"
  221. },
  222. "AssignmentsFilterValue": " $ ",
  223. "PredecessorsDisplayValue": null,
  224. "PredecessorsFilterValue": null,
  225. "SchedleStart": null,
  226. "SchedleFinish": null,
  227. "IsScheduled": false,
  228. "EntityCreator": {
  229. "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Users/ae18dea5-4f60-4f70-ae31-d8052984e31e",
  230. "Title": "admin"
  231. },
  232. "EntityCreatedTime": "2012-12-18T16:55:31.6421966+02:00",
  233. "EntityModifiedTime": "2012-12-18T16:55:31.9471966+02:00",
  234. "Name": "New Task name 30",
  235. "Note": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Task/7ded1d00-8c8a-4a69-a9a3-01c7a666458c/data/Note",
  236. "NoteLite": "abcdef",
  237. "Project": null,
  238. "State": {
  239. "Value": "Vqs.Tm.Shared.TmTaskStates.InProgress",
  240. "Title": "In Progress"
  241. },
  242. "Reason": {
  243. "Value": "Vqs.Tm.Shared.TmTaskReasons.Started",
  244. "Title": "Started"
  245. },
  246. "WorkflowCustomization": null,
  247. "TreeLinks": [
  248. {
  249. "ParentId": "7ded1d00-8c8a-4a69-a9a3-01c7a666458c",
  250. "ChildId": "7ded1d00-8c8a-4a69-a9a3-01c7a666458c",
  251. "Distance": 0
  252. }
  253. ],
  254. "TreeCodePath": " #c ",
  255. "TimeLogItemsCount": 2,
  256. "Deviation": {
  257. "Value": -1.9999999999999996,
  258. "Kind": 1,
  259. "PureWorkTime": -0.083333333333333315,
  260. "Title": "-2 Hours"
  261. },
  262. "OverdueRisk": true,
  263. "Folder": null,
  264. "Template": null,
  265. "TimeEventSubscriptionFlags": null,
  266. "Follow": 131.0,
  267. "Priority": {
  268. "Value": 0,
  269. "Title": "D"
  270. },
  271. "StackValue": 500,
  272. "Parent": null,
  273. "IsHaveDueDate": true,
  274. "DueDate": "2012-12-28T00:00:00+02:00",
  275. "IsRecurrence": false,
  276. "RecurrenceInfo": null,
  277. "RecurrenceTaskUsers": {
  278. "Values": [
  279. {
  280. "Id": "ae18dea5-4f60-4f70-ae31-d8052984e31e",
  281. "DisplayText": "admin"
  282. }
  283. ],
  284. "DisplayText": "admin"
  285. },
  286. "RecurrenceTaskReminderForStart": null,
  287. "RecurrenceTaskReminderForFinish": null,
  288. "RecurrenceTaskRollupOptions": {
  289. "DuplicatedFields": [
  290. {
  291. "Id": "Owner",
  292. "DisplayText": "Owner"
  293. },
  294. {
  295. "Id": "Estimate",
  296. "DisplayText": "Estimate"
  297. },
  298. {
  299. "Id": "Note",
  300. "DisplayText": "Note"
  301. },
  302. {
  303. "Id": "Project",
  304. "DisplayText": "Project"
  305. },
  306. {
  307. "Id": "Folder",
  308. "DisplayText": "Folder"
  309. },
  310. {
  311. "Id": "Template",
  312. "DisplayText": "Template"
  313. },
  314. {
  315. "Id": "Priority",
  316. "DisplayText": "U/I"
  317. },
  318. {
  319. "Id": "StackValue",
  320. "DisplayText": "Priority"
  321. },
  322. {
  323. "Id": "ReminderAt",
  324. "DisplayText": "Remind at"
  325. },
  326. {
  327. "Id": "DuplicateField_DueDate",
  328. "DisplayText": "Due date"
  329. },
  330. {
  331. "Id": "Assignments",
  332. "DisplayText": "Assigned To"
  333. },
  334. {
  335. "Id": "Links",
  336. "DisplayText": "Links"
  337. }
  338. ]
  339. },
  340. "OverdueProcessed": false,
  341. "Overdue": false,
  342. "SubTasksCount": 0,
  343. "PhaseDueDate": null,
  344. "ReminderAt": null,
  345. "ReminderAtHash": null,
  346. "ReminderBeforeDueDate": null,
  347. "ReminderBeforeDueDateHash": null,
  348. "CommentLite": null,
  349. "LinksCount": 0,
  350. "LinksEntityCodes": null
  351. }
  352. }
  353. ]
  354. }