/
REST Objects Work Item Notification

REST Objects Work Item Notification

5.0.0

Work Item Notification objects can be returned as part of the overall response from a call to the REST Notification Changed Items, or as part of a push-based notification of changes made to Work Items.

See the REST Notification Changed Items for details of how the Work Item Notification object is used as part of that API's response.  

Work Item Notification Object Format

JSON Format
{
  "rowver": 12345,
  "Type": 1,
  "WorkItemType": 1,
  "WorkItem": {
	// Work Item Object
  },
  "CreatedAt": "2017-12-07T07:28:57.387Z"
}

Work Item Notification Object Properties


PropertyTypeRequired?Description
rowverintegerYes

ServiceBroker keeps a record of all updates to Work Items that it is informed about, and assigns each update notification it receives a unique rowver integer value, as a series of ascending integers.

The rowver value in a Work Item Notification object is the unique rowver value that has been assigned to the specific record of a Work Item change.

TypeintegerYes

An indication of the Work Item Type.

WorkItemTypeintegerYes

An indication of the Work Item Type.

WorkItemobjectYesA Work Item object, representing the details of the Work Item as it has been recorded after the change.
CreatedAtstringYesThe date and time of that the Work Item Notification object was created, in ISO-8601 format using pattern YYYY-MM-DDTHH:mm:SS.sssZ. The CreatedAt value must be in UTC.

Related content

REST Objects Work Item
REST Objects Work Item
Read with this
REST Notification Changed Items
REST Notification Changed Items
More like this
Event Notification Object
Event Notification Object
Read with this
WorkItemNotifications REST API 1
WorkItemNotifications REST API 1
More like this