Application API (v1): Add 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 is the same as Add a Card, but also allows you to override a WIP limit. If you attempt to add card and get a response code 900 (WipOverrideCommentRequired), you will need to use this method to add a card and supply a WIP override reason (UserWipOverriderComment).
UserWipOverriderComment
comment field is required.TypeId
is required and must match one of the Card Types for your board. See Get Board Identifiers.- If the card is blocked, you must include a comment in the
BlockReason
property. - All dates must be in the current user's specified date format.
- Multiple tags must be separated by commas.
ClassOfServiceId
is an optional field for specifying a custom icon. See Get Board Identifiers.AssignedUserIds
is an optional array of user IDs. See Get Board Identifiers.Content-Type: application/json
must be included in the HTTP headers for the API to recognize the posted data. See API Basics.- using a position of 9999 will greatly optimize the call
Request URL (POST):
https://{accountname}.leankit.com/kanban/api/board/{boardId}/AddCardWithWipOverride/lane/{laneId}/position/{position}
Sample request:
POST https://myaccount.leankit.com/kanban/api/board/101000/AddCardWithWipOverride/lane/101108/position/9999
{ "Title": "My New Card", "Description": "New Description", "TypeId": 101304, "Priority": 0, "Size": 2, "IsBlocked": false, "BlockReason": "", "DueDate": "01/01/2020", "ExternalSystemName": "Tracking", "ExternalSystemUrl": "http://ourcompanycms.com/1234", "Tags": "small,UI", "ClassOfServiceId": 123222, "ExternalCardID": "DSA-111", "AssignedUserIds": [111,1112,2211], "UserWipOverrideComment": "Reason for overriding WIP limit" }
Response:
ReplyData
contains the new Board Version and the ID of the Card that was added.
{ "ReplyCode": 201, "ReplyText": "The Card was successfully added.", "ReplyData": [ { "BoardVersion": 4, "Lane": null, "CardId": 101001 } ] }