Home

Returns the details of the given edited entity

GET
api/databases/{dbid}/entities/{entity}/{id}/edit
This request is used for getting information about the entity which is being edited, i.e. only this request can return the changed values of the entity which has not been saved yet.

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. POST api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Task/08a11e00-188f-45d0-b767-d8620bedbad2/edit
  2. Accept: text/json
  3. Accept-Encoding: deflate
  4. Host: localhost:6496
  5. Cookie: sid=96e252b0-3147-4a01-819c-16d434b581fa
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 11:41:11 GMT
  6. ETag: "634921260718020940"
  7. Last-Modified: Wed, 26 Dec 2012 11:41:11 GMT
  8. Server: Microsoft-HTTPAPI/2.0
  9.  
  10. {
  11.   "Id": "08a11e00-188f-45d0-b767-d8620bedbad2",
  12.   "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Task/08a11e00-188f-45d0-b767-d8620bedbad2/edit"
  13. }

Request:
  1. GET api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Task/08a11e00-188f-45d0-b767-d8620bedbad2/edit
  2. Accept: text/json
  3. Accept-Encoding: deflate
  4. Host: localhost:6496
  5. Cookie: sid=96e252b0-3147-4a01-819c-16d434b581fa
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 11:41:18 GMT
  6. ETag: "634921260718020940"
  7. Last-Modified: Wed, 26 Dec 2012 11:41:11 GMT
  8. Server: Microsoft-HTTPAPI/2.0
  9.  
  10. {
  11.   "Code": "T2542",
  12.   "EditingUser": {
  13.     "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Users/ae18dea5-4f60-4f70-ae31-d8052984e31e",
  14.     "Title": "admin"
  15.   },
  16.   "Modified": false,
  17.   "Revision": 3,
  18.   "IsNew": false,
  19.   "Id": "94d5484d-d5c4-452a-aacf-ec341cce4526",
  20.   "InfoName": "Task",
  21.   "ETag": "634919716490037030",
  22.   "ModifiedStamp": "2012-12-24T18:47:29.003703+02:00",
  23.   "IsMarkedAsDeleted": false,
  24.   "Properties": {
  25.     "Id": "94d5484d-d5c4-452a-aacf-ec341cce4526",
  26.     "MaxScheduleItemsFinish": "1753-01-01T02:00:00+02:00",
  27.     "Code": "T2542",
  28.     "Owner": {
  29.       "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Users/ae18dea5-4f60-4f70-ae31-d8052984e31e",
  30.       "Title": "admin"
  31.     },
  32.     "StartedTime": null,
  33.     "ClosedTime": null,
  34.     "Estimate": {
  35.       "Value": 8.0,
  36.       "Kind": 1,
  37.       "PureWorkTime": 0.33333333333333331,
  38.       "Title": "8 Hours"
  39.     },
  40.     "Remain": {
  41.       "Value": 8.0,
  42.       "Kind": 1,
  43.       "PureWorkTime": 0.33333333333333331,
  44.       "Title": "8 Hours"
  45.     },
  46.     "Actual": null,
  47.     "PreviusNonBlockedState": null,
  48.     "AssignmentsFilterValue": " $ ",
  49.     "PredecessorsFilterValue": null,
  50.     "EntityCreator": {
  51.       "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Users/ae18dea5-4f60-4f70-ae31-d8052984e31e",
  52.       "Title": "admin"
  53.     },
  54.     "EntityCreatedTime": "2012-12-19T13:20:57.1515586+02:00",
  55.     "EntityModifiedTime": "2012-12-24T18:47:28.536703+02:00",
  56.     "Name": "Changed task name",
  57.     "Note": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Task/94d5484d-d5c4-452a-aacf-ec341cce4526/edit/data/Note",
  58.     "NoteLite": "abcdef",
  59.     "Project": {
  60.       "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/entities/Project/18a6b2ab-cc8b-4e38-b3f6-0641449919f6",
  61.       "Title": "(PRJ24) New Project 2"
  62.     },
  63.     "State": {
  64.       "Value": "Vqs.Tm.Shared.TmTaskStates.Created",
  65.       "Title": "Created"
  66.     },
  67.     "Reason": {
  68.       "Value": "Vqs.Tm.Shared.TmTaskReasons.New",
  69.       "Title": "New"
  70.     },
  71.     "WorkflowCustomization": null,
  72.     "TimeLogItemsCount": 0,
  73.     "Deviation": null,
  74.     "OverdueRisk": false,
  75.     "Folder": null,
  76.     "Template": null,
  77.     "Priority": {
  78.       "Value": 0,
  79.       "Title": "D"
  80.     },
  81.     "StackValue": 500,
  82.     "Parent": null,
  83.     "IsHaveDueDate": true,
  84.     "DueDate": "2012-12-29T00:00:00+02:00",
  85.     "IsRecurrence": false,
  86.     "RecurrenceInfo": null,
  87.     "RecurrenceTaskUsers": {
  88.       "Values": [
  89.         {
  90.           "Id": "ae18dea5-4f60-4f70-ae31-d8052984e31e",
  91.           "DisplayText": "admin"
  92.         }
  93.       ],
  94.       "DisplayText": "admin"
  95.     },
  96.     "RecurrenceTaskReminderForStart": null,
  97.     "RecurrenceTaskReminderForFinish": null,
  98.     "RecurrenceTaskRollupOptions": {
  99.       "DuplicatedFields": [
  100.         {
  101.           "Id": "Owner",
  102.           "DisplayText": "Owner"
  103.         },
  104.         {
  105.           "Id": "Estimate",
  106.           "DisplayText": "Estimate"
  107.         },
  108.         {
  109.           "Id": "Note",
  110.           "DisplayText": "Note"
  111.         },
  112.         {
  113.           "Id": "Project",
  114.           "DisplayText": "Project"
  115.         },
  116.         {
  117.           "Id": "Folder",
  118.           "DisplayText": "Folder"
  119.         },
  120.         {
  121.           "Id": "Template",
  122.           "DisplayText": "Template"
  123.         },
  124.         {
  125.           "Id": "Priority",
  126.           "DisplayText": "U/I"
  127.         },
  128.         {
  129.           "Id": "StackValue",
  130.           "DisplayText": "Priority"
  131.         },
  132.         {
  133.           "Id": "ReminderAt",
  134.           "DisplayText": "Remind at"
  135.         },
  136.         {
  137.           "Id": "DuplicateField_DueDate",
  138.           "DisplayText": "Due date"
  139.         },
  140.         {
  141.           "Id": "Assignments",
  142.           "DisplayText": "Assigned To"
  143.         },
  144.         {
  145.           "Id": "Links",
  146.           "DisplayText": "Links"
  147.         }
  148.       ]
  149.     },
  150.     "ReminderAt": null,
  151.     "ReminderAtHash": null,
  152.     "ReminderBeforeDueDate": null,
  153.     "ReminderBeforeDueDateHash": null,
  154.     "Comment": null,
  155.     "CommentLite": null,
  156.     "LinksCount": 0,
  157.     "LinksEntityCodes": null
  158.   }
  159. }