Application API (v1): Update a Card with WIP Override
LeanKit's Application API v1 is deprecated. New integration projects should use our v2 API suite found here: https://success.planview.com/Planview_LeanKit/LeanKit_API/01_v2.
This method performs the same operation as the Update a Card method but also supports the ability to override WIP limits with a comment.
Violations of a WIP Limit can occur under the following situations:
- The card is being moved as part of the update process and this causes a WIP violation in the destination Lane.
- The Board is set to calculate WIP based on Card size, and a change in the Card size causes a violation of the Lane's WIP limit.
- A user is assigned to the card, and this causes a violation of the User's specified WIP limit.
You must provide a value for the UserWipOverrideComment
property when calling this method. This value will be assigned to the reason for the WIP override.
Request URL (POST):
https://{accountname}.leankit.com/kanban/api/board/{boardId}/UpdateCardWithWipOverride
Sample Request:
https://myaccount.leankit.com/kanban/api/board/10100/UpdateCardWithWipOverride
{ "Id": 256395058, "UserWipOverrideComment": "Because reasons...", "LaneId": 256392766, "Title": "Sample Card 1", "Description": "Updating the card description", "TypeId": 256291536, "Priority": 2, "Size": 4, "IsBlocked": false, "BlockReason": null, "Index": 0, "StartDate": null, "DueDate": null, "ExternalSystemName": null, "ExternalSystemUrl": null, "ExternalCardID": "AZ-1023", "Tags": "web,ux", "AssignedUserIds": [], "ClassOfServiceId": 0 }
Sample Response:
{ "ReplyData": [ { "BoardVersion": 42, "CardDTO": { "SystemType": "Card", "BoardId": 256064019, "BoardTitle": "Sample Board", "LaneId": 256392766, "LaneTitle": "Doing Now", "Title": "Sample Card 1", "Description": "Updating the card description", "Type": { "Id": 256291536 }, "TypeId": 256291536, "Priority": 2, "PriorityText": "High", "TypeName": "New Feature", "TypeIconPath": null, "TypeColorHex": "#93E0E6", "Size": 4, "Active": false, "Color": "#93E0E6", "Icon": "", "Version": 0, "AssignedUsers": [], "IsBlocked": false, "BlockReason": null, "BlockStateChangeDate": null, "Index": 0, "StartDate": null, "DueDate": null, "ExternalSystemName": null, "ExternalSystemUrl": null, "ExternalCardID": "AZ-1023", "ExternalCardIdPrefix": null, "Tags": "web,ux", "ParentBoardId": 0, "ParentTaskboardId": null, "CountOfOldCards": 0, "CardContexts": [], "LastMove": "10/14/2015 03:12:54 PM", "LastActivity": "10/14/2015 03:40:55 PM", "DateArchived": null, "CommentsCount": 0, "LastComment": null, "AttachmentsCount": 0, "LastAttachment": null, "CreateDate": "10/14/2015", "ActualStartDate": "10/14/2015 7:12:54 PM", "ActualFinishDate": null, "AssignedUserName": "", "AssignedUserId": 0, "AssignedUserIds": [], "GravatarLink": "", "SmallGravatarLink": "", "IsOlderThanXDays": false, "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": 0, "TaskBoardCompletedCardCount": 0, "TaskBoardCompletedCardSize": 0, "TaskBoardTotalCards": 0, "TaskBoardTotalSize": 0, "CurrentContext": null, "ParentCardId": null }, "CardSubscription": null } ], "ReplyCode": 202, "ReplyText": "The Card was successfully updated." }