Application API (v1): Get Board Updates
This method is useful for tracking changes to a Board as they occur. This method takes a Board version number and returns any events that have occurred with the Board since the given version. The Board version is included in the response from Get a Board. Once you have a Board Version, you can use this method to know when board has been updated (e.g. Cards added, updated, or moved).
Possible events include:
- CardCreationEvent
- CardBlockedEvent
- CardDeletedEvent
- CardFieldsChangedEvent
- CardMoveEvent
- CardMoveFromBoardEvent
- CardMoveToBoardEvent
- AttachmentChangeEvent
- BoardEditEvent
- BoardCardTypesChangedEvent
- UserAssignmentEvent
- WipOverrideEvent
Request URL (GET):
https://{accountname}.leankit.com/kanban/api/board/{boardId}/boardversion/{version}/CheckForUpdates
Sample Request:
https://myaccount.leankit.com/kanban/api/board/256064019/boardversion/42/CheckForUpdates
Sample Response (no updates):
{ "ReplyData": [ { "HasUpdates": false, "AffectedLanes": null, "Events": null, "CurrentBoardVersion": 0, "NewPayload": null } ], "ReplyCode": 200, "ReplyText": "CheckForUpdates successfully called." }
Sample Response (with updates):
{ "ReplyData": [ { "HasUpdates": true, "AffectedLanes": [ { "Id": 256392766, "Description": "", "Index": 1, "Active": true, "Title": "Doing Now", "CardLimit": 0, "ClassType": 0, "Type": 2, "ActivityId": null, "ActivityName": "", "CardContextId": 0, "Width": 2, "ParentLaneId": 0, "Cards": [], "Orientation": 0, "TaskBoardId": null, "ChildLaneIds": [], "SiblingLaneIds": null, "LaneState": "lane" }, { "Id": 256392759, "Description": "", "Index": 2, "Active": true, "Title": "Approved", "CardLimit": 0, "ClassType": 1, "Type": 1, "ActivityId": null, "ActivityName": "", "CardContextId": 0, "Width": 1, "ParentLaneId": 256392758, "Cards": [ { "SystemType": "Card", "LaneId": 256392759, "Title": "Sample Card 1", "Description": null, "Type": null, "TypeId": 256291536, "Priority": 1, "PriorityText": "Normal", "TypeName": "New Feature", "TypeIconPath": null, "TypeColorHex": "#93E0E6", "Size": 0, "Active": false, "Color": "#93E0E6", "Version": 5, "AssignedUsers": [], "CardContexts": null, "IsBlocked": false, "BlockReason": "", "BlockStateChangeDate": "", "Index": 0, "StartDate": "", "DueDate": "", "ExternalSystemName": "", "ExternalSystemUrl": "", "ExternalCardID": "AZ-1023", "Tags": "", "CountOfOldCards": 0, "LastMove": "10/14/2015 01:55:05 PM", "LastActivity": "10/14/2015 01:55:05 PM", "DateArchived": null, "CommentsCount": 0, "LastComment": "", "AttachmentsCount": 0, "LastAttachment": "", "SubscriptionId": 0, "AssignedUserName": "", "AssignedUserId": 0, "AssignedUserIds": [], "GravatarLink": "", "SmallGravatarLink": "", "Id": 256395058, "DrillThroughBoardId": null, "HasDrillThroughBoard": false, "DrillThroughStatistics": null, "DrillThroughCompletionPercent": null, "DrillThroughProgressTotal": null, "DrillThroughProgressComplete": null, "DrillThroughProgressSizeComplete": null, "DrillThroughProgressSizeTotal": null, "ClassOfServiceId": 0, "ClassOfServiceTitle": null, "ClassOfServiceIconPath": null, "ClassOfServiceColorHex": null, "ClassOfServiceCustomIconName": null, "ClassOfServiceCustomIconColor": null, "CardTypeIconColor": null, "CardTypeIconName": null, "CurrentTaskBoardId": null, "TaskBoardCompletionPercent": null, "TaskBoardCompletedCardCount": 0, "TaskBoardCompletedCardSize": 0, "TaskBoardTotalCards": null, "TaskBoardTotalSize": null, "CurrentContext": null, "ParentCardId": null } ], "Orientation": 0, "TaskBoardId": null, "ChildLaneIds": [], "SiblingLaneIds": null, "LaneState": "child" } ], "Events": [ { "CardId": 256395058, "EventType": "CardMoveEvent", "EventDateTime": "10/14/2015 01:55:05 PM", "Message": "David Neal moved the Card [(AZ-1023) Sample Card 1] from Doing Now to Not Started - Future Work: Approved.", "ToLaneId": 256392759, "FromLaneId": 256392766, "RequiresBoardRefresh": false, "IsBlocked": false, "BlockedComment": null, "UserId": 62984826, "AssignedUserId": 0, "IsUnassigning": false, "CommentText": null, "WipOverrideComment": null, "WipOverrideLane": 0, "WipOverrideUser": 0, "TaskboardParentCardId": 0, "TaskboardId": 0 } ], "CurrentBoardVersion": 42, "NewPayload": null } ], "ReplyCode": 200, "ReplyText": "CheckForUpdates successfully called." }