Help & Support
Follow

Application API (v1): Get Taskboard Updates

This method is very similar to Get Board Updates and is useful for tracking changes to a Taskboard as they occur. This method takes a Board version number and returns any events that have occurred with the Taskboard since the given version. The Board version is included in the response from Get a Card's Taskboard. Once you have a Board version, you can use this method to know when the Taskboard has been updated (e.g. Task 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/v1/board/{boardId}/card/{cardId}/tasks/boardversion/{version}

Sample request:

https://myaccount.leankit.com/kanban/api/v1/board/256064019/card/256718504/tasks/boardversion/10

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": 256711250,
          "Description": null,
          "Index": 0,
          "Active": false,
          "Title": "ToDo",
          "CardLimit": 0,
          "ClassType": 0,
          "Type": 1,
          "ActivityId": null,
          "ActivityName": null,
          "CardContextId": 0,
          "Width": 2,
          "ParentLaneId": 0,
          "Cards": [
            {
              "SystemType": "Card",
              "LaneId": 256711250,
              "Title": "Task 1",
              "Description": null,
              "Type": {
                "Id": 256291537
              },
              "TypeId": 256291537,
              "Priority": 1,
              "PriorityText": "Normal",
              "TypeName": "Subtask",
              "TypeIconPath": null,
              "TypeColorHex": "#F8F7D2",
              "Size": 0,
              "Active": false,
              "Color": "#F8F7D2",
              "Version": 2,
              "AssignedUsers": [],
              "CardContexts": [],
              "IsBlocked": false,
              "BlockReason": null,
              "BlockStateChangeDate": null,
              "Index": 0,
              "StartDate": null,
              "DueDate": null,
              "ExternalSystemName": null,
              "ExternalSystemUrl": null,
              "ExternalCardID": null,
              "Tags": null,
              "CountOfOldCards": 0,
              "LastMove": "10/15/2015 09:06:13 AM",
              "LastActivity": "10/15/2015 09:06:13 AM",
              "DateArchived": null,
              "CommentsCount": 0,
              "LastComment": null,
              "AttachmentsCount": 0,
              "LastAttachment": null,
              "SubscriptionId": 0,
              "AssignedUserName": "",
              "AssignedUserId": 0,
              "AssignedUserIds": [],
              "GravatarLink": "",
              "SmallGravatarLink": "",
              "Id": 256718506,
              "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": 0,
              "TaskBoardCompletedCardCount": 0,
              "TaskBoardCompletedCardSize": 0,
              "TaskBoardTotalCards": 0,
              "TaskBoardTotalSize": 0,
              "CurrentContext": null,
              "ParentCardId": null
            }
          ],
          "Orientation": 0,
          "TaskBoardId": 256573921,
          "ChildLaneIds": null,
          "SiblingLaneIds": null,
          "LaneState": "lane"
        }
      ],
      "Events": [
        {
          "CardId": 256776817,
          "EventType": "CardDeletedEvent",
          "EventDateTime": "10/15/2015 11:06:19 AM",
          "Message": "David Neal deleted the Card [A Card to Delete].",
          "ToLaneId": 256711250,
          "FromLaneId": null,
          "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": 5,
      "NewPayload": null
    }
  ],
  "ReplyCode": 200,
  "ReplyText": "CheckForUpdates successfully called."
}

 

 

 

 

 

 

Doc ID: 1191983329

Have more questions? Submit a request