Service Description: KanbanCardService
Service EPR: https://login.swiftkanban.com/axis2/services/KanbanCardService
Service Status : Active
Available Operations:
- addCard
- getCard
- getCardsByFilter
- moveCardOnBoard
- blockCard
- unblockCard
- moveCardtoReady
- moveCardToBacklog
- getCardDetails
- getCardsModifiedSincedate
- archiveCard
- updateCard
- getSmartLaneDetails
- addMultipleCard
- updateMultipleCard
- archiveMultipleCard
- getMultipleCard
- moveMultipleCardToReady
- moveMultipleCardOnBoard
- moveMultipleCardToBacklog
- deleteCard
- deleteMultipleCard
- convertCard
- transferCard
- getBoardCards
- discardAbortCard
- discardAbortMultipleCard
Note: Any mention of Iteration or Project in any Web Service operations are equivalent to Sprint or Board in the SwiftKanban User Interface (UI).
addCard
Input Elements
Description | Creates a new card |
projectId | Id of the project that you get from getProject of ProjectService Example: 8 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
mode | Not used as of now |
fields | List of fields with name and value for each field. Field name will be available from the getCardMetadata method. The type of value to be passed information will be available in the same method. If the field is of the list of value (LOV) type pass any relevantLOVitem value. Example: name=cardSize and its value = M |
Output | If successful, the response returns details of new card added. |
Input response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>rtiwari#digite.com</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:addCardDetails> <kan:projectId>40186</kan:projectId> <kan:cardType>KanbanDefect</kan:cardType> <kan:userLoginId>rtiwari#digite.com</kan:userLoginId> <kan:mode></kan:mode> <kan:fields> <!--Zero or more repetitions:--> <kan:field name="name">test defect</kan:field> <kan:field name="cardSize">M</kan:field> <kan:field name="classOfService">Expedite</kan:field> <kan:field name="Category">PM</kan:field> <kan:field name="currentOwner">rtiwari#digite.com</kan:field> </kan:fields> </kan:addCardDetails> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:getCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:fields> <ns:field ns:name="id">606748</ns:field> <ns:field ns:name="name">test defect</ns:field> <ns:field ns:name="priority">0</ns:field> <ns:field ns:name="defectType">0</ns:field> <ns:field ns:name="severity">0</ns:field> <ns:field ns:name="rootCause">0</ns:field> <ns:field ns:name="currentState">Active</ns:field> <ns:field ns:name="release">0</ns:field> <ns:field ns:name="currentOwner_userId">rtiwari#digite.com</ns:field> <ns:field ns:name="currentOwner">Ravi Tiwari</ns:field> <ns:field ns:name="currentQueue">Backlog</ns:field> <ns:field ns:name="createdBy">rtiwari#digite.com</ns:field> <ns:field ns:name="createdDate">2015-08-31T09:19:52Z</ns:field> <ns:field ns:name="modifiedBy">rtiwari#digite.com</ns:field> <ns:field ns:name="modifiedDate">2015-08-31T09:19:52Z</ns:field> <ns:field ns:name="workspaceType">KanbanProject</ns:field> <ns:field ns:name="workspaceId">1540764</ns:field> <ns:field ns:name="cardSize">M</ns:field> <ns:field ns:name="classOfService">Expedite</ns:field> <ns:field ns:name="defectNumber">DEF31</ns:field> <ns:field ns:name="Category">PM</ns:field> <ns:field ns:name="workType">KanbanDefect</ns:field> <ns:field ns:name="Hot_Fix_Release">0</ns:field> <ns:field ns:name="HF_Merged">0</ns:field> <ns:field ns:name="summaryType">leaf</ns:field> <ns:field ns:name="dateIdentified">2015-08-31T09:19:52Z</ns:field> <ns:field ns:name="iteration">0</ns:field> <ns:field ns:name="ExternalCardId">DEF31</ns:field> <ns:field ns:name="currentSwimId">N/A</ns:field> <ns:field ns:name="currentSwimName">N/A</ns:field> <ns:field ns:name="currentQueueId">N/A</ns:field> </ns:fields> </ns:getCardResponse>
Note: currentSwimId, currentSwimName, and currentQueueId have values as N/A because the card is created in backlog.
Note2: addCard method (SOAP) and post method of CardService (REST Url: /card-operations/boards/{boardId}/cards) of webservice will add cards based on the Board Policy of the default lane configuration. Like web application, If the default column for card addition in the Board policy is not set, then the card, added via the SOAP or REST webservice will be placed in the Backlog. If the policy is set to a specific column then the card will be added in that column only.
getCard
Input Elements
Description | Fetches card details |
projectId | Id of the project that you get from getProject of ProjectService Example: 8 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
cardUniqueId | card unique id that you will get in add card response |
Output | If successful, the response returns details of a particular card. |
Input Request Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>rtiwari#digite.com</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:getCardRequest> <kan:projectId>40186</kan:projectId> <kan:cardUniqueId>606543</kan:cardUniqueId> <kan:cardType>KanbanDefect</kan:cardType> <kan:userLoginId>rtiwari#digite.com</kan:userLoginId> </kan:getCardRequest> </soapenv:Body> </soapenv:Envelope>
Output Request Example
<ns:getCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:fields> <ns:field ns:name="id">606543</ns:field> <ns:field ns:name="name">defect1</ns:field> <ns:field ns:name="priority">Low</ns:field> <ns:field ns:name="defectType">0</ns:field> <ns:field ns:name="severity">0</ns:field> <ns:field ns:name="rootCause">0</ns:field> <ns:field ns:name="currentState">Active</ns:field> <ns:field ns:name="release">0</ns:field> <ns:field ns:name="currentOwner_userId">rtiwari#digite.com</ns:field> <ns:field ns:name="currentOwner">Ravi Tiwari</ns:field> <ns:field ns:name="currentQueue">Ready</ns:field> <ns:field ns:name="createdBy">rtiwari#digite.com</ns:field> <ns:field ns:name="createdDate">2015-08-27T05:11:25Z</ns:field> <ns:field ns:name="modifiedBy">rtiwari#digite.com</ns:field> <ns:field ns:name="modifiedDate">2015-08-31T08:23:17Z</ns:field> <ns:field ns:name="workspaceType">KanbanProject</ns:field> <ns:field ns:name="workspaceId">1540764</ns:field> <ns:field ns:name="resolvedBy">Unassigned</ns:field> <ns:field ns:name="cardSize">M</ns:field> <ns:field ns:name="classOfService">Standard Class</ns:field> <ns:field ns:name="defectNumber">DEF23</ns:field> <ns:field ns:name="Category">Platform</ns:field> <ns:field ns:name="FoundInRelease">0</ns:field> <ns:field ns:name="workType">KanbanDefect</ns:field> <ns:field ns:name="Hot_Fix_Release">0</ns:field> <ns:field ns:name="HF_Merged">0</ns:field> <ns:field ns:name="summaryType">leaf</ns:field> <ns:field ns:name="dateIdentified">2015-08-27T05:11:25Z</ns:field> <ns:field ns:name="iteration">0</ns:field> <ns:field ns:name="smartLane">Kanban board</ns:field> <ns:field ns:name="ExternalCardId">DEF23</ns:field> <ns:field ns:name="currentSwimId">1547904</ns:field> <ns:field ns:name="currentSwimName">Kanban board</ns:field> <ns:field ns:name="currentQueueId">1599633</ns:field> </ns:fields> </ns:getCardResponse>
Note: In case if the card is not on the board, then the value for currentSwimId, currentSwimName and currentQueueId will be N/A.
getCardsByFilter
Input Elements
Description | Fetches a list of cards on applying a filter |
projectId | Id of the project that you get from getProject of ProjectService Example: 8 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
FilterType | Type of filter Example: compund |
Output | If successful, the response returns a list of cards on applying a filter. |
Input Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>[email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:getCardsByFilterInput> <kan:projectId>1</kan:projectId> <kan:userLoginId>[email protected]</kan:userLoginId> <kan:cardType>UserStory</kan:cardType> <kan:FilterType kan:type="compound"> <kan:filterGroup kan:op="or"> <kan:FilterAttribute kan:field="CurrentQueue" kan:criteria="=" kan:value="Backlog"/> <kan:FilterAttribute kan:field="CurrentQueue" kan:criteria="=" kan:value="Ready"/> </kan:filterGroup> <kan:filterGroup kan:op="and"> <kan:FilterAttribute kan:field="priority" kan:criteria="=" kan:value="Medium"/> </kan:filterGroup> </kan:FilterType> </kan:getCardsByFilterInput> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:getCardsByFilterResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:Cards> <ns:Card ns:CardSequenceNumber="UST1" ns:cardId="520098"/> <ns:Card ns:CardSequenceNumber="UST19" ns:cardId="522507"/> </ns:Cards> </ns:getCardsByFilterResponse>
Valid Criteria
Integer, Long, Double, Date itemType | = , != , <= , >= , < , > Example: <kan:FilterAttribute kan:field=”classOfService” kan:criteria=”!=” kan:value=”Expedite”/> |
String itemType | = , != , contains, !contains, startsWith, endsWithcontains, !contains, startsWith, endsWith have been introduced in SwiftKanban v. 4.14. Example: <kan:FilterAttribute kan:field=”name” kan:criteria=”startsWith” kan:value=”user”/> |
String itemType used in lookup fields | =, != Example: <kan:FilterAttribute kan:field=”classOfService” kan:criteria=”!=” kan:value=”Expedite”/> |
Person (currentOwner, createdBy, modifiedBy and others), KanbanRelease, KanbanIteration, Boolean itemType | = , != <Require an example> |
Sample of Valid Input Response
<kan:getCardsByFilterInput> <kan:projectId>40352</kan:projectId> <kan:userLoginId></kan:userLoginId> <kan:cardType>UserStory</kan:cardType> <kan:FilterType kan:type="compound"> <!--Zero or more repetitions:--> <kan:filterGroup kan:op="and"> <!--1 or more repetitions:--> <kan:FilterAttribute kan:field="name" kan:criteria="startsWith" kan:value="user"/> <kan:FilterAttribute kan:field="name" kan:criteria="endsWith" kan:value="card"/> <kan:FilterAttribute kan:field="description" kan:criteria="!contains" kan:value="defect"/> <kan:FilterAttribute kan:field="smartLane" kan:criteria="contains" kan:value="Kanban board"/> <kan:FilterAttribute kan:field="Priority" kan:criteria="=" kan:value="Low"/> <kan:FilterAttribute kan:field="classOfService" kan:criteria="!=" kan:value="Expedite"/> </kan:filterGroup> </kan:FilterType> </kan:getCardsByFilterInput>
Sample of Valid Output Response
<ns:getCardsByFilterResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:Cards> <ns:Card ns:CardSequenceNumber="UST1" ns:CreationDate="2017-02-23T09:40:18Z" ns:ModifiedDate="2017-02-23T09:49:51Z" ns:cardId="618069"/> </ns:Cards> </ns:getCardsByFilterResponse>
Sample of Invalid Input Response
<kan:getCardsByFilterInput> <kan:projectId>40352</kan:projectId> <kan:userLoginId></kan:userLoginId> <kan:cardType>UserStory</kan:cardType> <kan:FilterType kan:type="compound"> <!--Zero or more repetitions:--> <kan:filterGroup kan:op="and"> <!--1 or more repetitions:--> <kan:FilterAttribute kan:field="name" kan:criteria=">" kan:value="user"/> <kan:FilterAttribute kan:field="description" kan:value="card"/> <kan:FilterAttribute kan:field="Priority" kan:criteria="contains" kan:value="Low"/> <kan:FilterAttribute kan:field="classOfService" kan:criteria="endsWith" kan:value="Expedite"/> <kan:FilterAttribute kan:field="currentOwner" kan:criteria="contains" kan:value="[email protected]"/> <kan:FilterAttribute kan:field="release" kan:criteria=">=" kan:value="release 4.14"/> <kan:FilterAttribute kan:field="manualProgress" kan:criteria="startsWith" kan:value="1"/> <kan:FilterAttribute kan:field="iteration" kan:criteria="=" kan:value="iteration"/>
Sample of Invalid Output Response
Note: If you enter any invalid criteria in your input response (refer the above row), the output response will display error message instead of empty result. See the instances of error messages in the following response.
<ns:getCardsByFilterResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:Exception> <ns:Request> <kan:getCardsByFilterInput xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <kan:projectId>40352</kan:projectId> <kan:userLoginId/> <kan:cardType>UserStory</kan:cardType> <kan:FilterType kan:type="compound"> <!--Zero or more repetitions:--> <kan:filterGroup kan:op="and"> <!--1 or more repetitions:--> <kan:FilterAttribute kan:criteria=">" kan:field="name" kan:value="user"/> <kan:FilterAttribute kan:field="description" kan:value="card"/> <kan:FilterAttribute kan:criteria="contains" kan:field="Priority" kan:value="Low"/> <kan:FilterAttribute kan:criteria="endsWith" kan:field="classOfService" kan:value="Expedite"/> <kan:FilterAttribute kan:criteria="contains" kan:field="currentOwner" kan:value="[email protected]"/> <kan:FilterAttribute kan:criteria=">=" kan:field="release" kan:value="release 4.14"/> <kan:FilterAttribute kan:criteria="startsWith" kan:field="manualProgress" kan:value="1"/> <kan:FilterAttribute kan:criteria="=" kan:field="iteration" kan:value="iteration"/> </kan:filterGroup> </kan:FilterType> </kan:getCardsByFilterInput> </ns:Request> <ns:Errors> <ns:errorMessage ns:details="Invalid criteria : > in FilterAttribute tag for field : name"/> <ns:errorMessage ns:details="criteria attribute is mandatory in FilterAttribute tag for field : description"/> <ns:errorMessage ns:details="Invalid criteria : contains in FilterAttribute tag for field : Priority"/> <ns:errorMessage ns:details="Invalid criteria : endswith in FilterAttribute tag for field : classOfService"/> <ns:errorMessage ns:details="Invalid criteria : contains in FilterAttribute tag for field : currentOwner"/> <ns:errorMessage ns:details="Invalid criteria : >= in FilterAttribute tag for field : release"/> <ns:errorMessage ns:details="Invalid criteria : startswith in FilterAttribute tag for field : manualProgress"/> <ns:errorMessage ns:details="Invalid field value : iteration in FilterAttribute tag for field : iteration"/> </ns:Errors> </ns:Exception> </ns:getCardsByFilterResponse>
moveCardOnBoard
Input Elements
Description | Moves a card across lanes on board |
projectId | Id of the project that you get from getProject of ProjectService Example: 8 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
cardUniqueId | card unique Id that you will get in add/update/get card response Example: 5698 |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
fromQkeyId | Id of queue from where you want to move the card Example: 23046 |
toQkeyId | Id of the queue to where you want to move the card Example: 23047 |
fromSwimId | Id of the swim lane where the card exists now Example: 10456 |
toSwimId | Id of the swim lane to where you want to move the card Example: 10456 |
Output | If successful, the response returns a list of cards on applying a filter |
Input Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>[email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:moveCardOnBoardDetails> <kan:projectId>1</kan:projectId> <kan:cardType>UserStory</kan:cardType> <kan:cardUniqueId>522507</kan:cardUniqueId><kan:fromQkeyId>1600329</kan:fromQkeyId> <kan:toQkeyId>1605332</kan:toQkeyId><kan:fromSwimId>1542546</kan:fromSwimId> <kan:toSwimId>1546983</kan:toSwimId>
Output Response Example
<kan:userLoginId>[email protected]</kan:userLoginId> </kan:moveCardOnBoardDetails> </soapenv:Body> </soapenv:Envelope> <ns:moveCardOnBoardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:StatusMsg>Successful</ns:StatusMsg> </ns:moveCardOnBoardResponse>
blockCard
Input Elements
Description | Blocks a card on board |
projectId | Id of the project that you get from getProject of ProjectService Example: 8 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
cardUniqueId | card unique id that you will get in add / update / get card response Example: 5698 |
blockComment | comment text giving details for doing comment Example: Not able to reproduce the defect |
Output | If successful blocks the card on the board |
Input Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>[email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:blockCardDetails> <kan:projectId>1</kan:projectId> <kan:cardType>UserStory</kan:cardType> <kan:cardUniqueId>524129</kan:cardUniqueId> <kan:userLoginId>[email protected]</kan:userLoginId> <kan:blockComment>in faucibus orci luctus et ultrices posuere cubilia Curae; Phasellus</kan:blockComment> </kan:blockCardDetails> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:blockCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:result>Successful</ns:result> </ns:blockCardResponse>
unblockCard
Input Elements
Description | Unblocks a blocked card on board |
projectId | Id of the project that you get from getProject of ProjectService Example: 8 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
cardUniqueId | card unique id that you will get in add/update/get card response Example: 5698 |
unblockComment | Reason for unblocking Example: Reproducible on dev server |
Output | If successful unblocks a blocked card on the board |
Input Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>[email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:unblockCardDetails> <kan:projectId>104</kan:projectId> <kan:cardType>KanbanDefect</kan:cardType> <kan:cardUniqueId>520158</kan:cardUniqueId> <kan:unblockComment>unblocking</kan:unblockComment> <kan:userLoginId>[email protected]</kan:userLoginId> </kan:unblockCardDetails> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:unblockCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:result>Successful</ns:result> </ns:unblockCardResponse>
moveCardtoReady
Input Elements
Description | Moves a card from backlog/archive to board to any queue and swim lane provided in request |
projectId | Id of the project that you get from getProject of ProjectService Example: 8 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
cardUniqueId | card unique Id that you will get in add/update/get card response Example: 5698 |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
queueId | Ready queue Id that you will get from getSmartLaneDetails Example: 23045 |
swimId | Swim lane Id to which the Ready queue belongs Example: 10456 |
Output | If successful, the card is moved to the Ready queue of a given swim lane |
Input Response Elements
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>[email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:moveCardtoReadyDetails> <kan:cardType>UserStory</kan:cardType> <kan:cardUniqueId>520251</kan:cardUniqueId> <kan:projectId>1</kan:projectId> <kan:queueId>1600334</kan:queueId> <kan:swimId>1542546</kan:swimId> <kan:userLoginId>[email protected]</kan:userLoginId> </kan:moveCardtoReadyDetails> </soapenv:Body> </soapenv:Envelope>
Output Response Elements
<ns:moveCardtoReadyResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:result ns:CardType="KanbanDefect" ns:cardUniqueId="520158" ns:CurrentQueue="Ready" /> </ns:moveCardtoReadyResponse>
moveCardToBacklog
Input Elements
Description | Moves a card from board to the backlog |
projectId | Id of the project that you get from getProject of ProjectService Example: 8 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
cardUniqueId | card unique id that you will get in add/update/get card response Example: 5698 |
Output | If successful moves a card from board to the backlog |
Input Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>[email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:moveCardToBacklogDetails> <kan:projectId>104</kan:projectId> <kan:cardType>KanbanDefect</kan:cardType> <kan:cardUniqueId>520158</kan:cardUniqueId> <kan:userLoginId>[email protected]</kan:userLoginId> </kan:moveCardToBacklogDetails> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:moveCardToBacklogResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:result>Successful</ns:result> </ns:moveCardToBacklogResponse>
getCardDetails
Input Elements
Description | Fetches details of card of only selected fields passed in request |
projectId | Id of the project that you get from getProject of ProjectService Example: 8 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
cardUniqueId | card unique id that you will get in add/update/get card response Example: 5698 |
FieldNames | List of field names for which the details to be fetched. Get the field names from getCardMetada method Example: names = cardSize,classOfService,description |
Output | If successful returns details of card of only selected fields passed in request |
Input Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>[email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:getCardDetailsRequest> <kan:projectId>104</kan:projectId> <kan:cardUniqueId>520158</kan:cardUniqueId> <kan:cardType>KanbanDefect</kan:cardType> <kan:userLoginId>[email protected]</kan:userLoginId> <!--Zero or more repetitions:--> <kan:FieldNames>name</kan:FieldNames> <kan:FieldNames>priority</kan:FieldNames> <kan:FieldNames>description</kan:FieldNames> </kan:getCardDetailsRequest> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:getCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:fields> <ns:field ns:name="id">520158</ns:field> <ns:field ns:name="currentQueue">Backlog</ns:field> <ns:field ns:name="defectNumber">DEF3</ns:field> <ns:field ns:name="release">0</ns:field> <ns:field ns:name="iteration">0</ns:field> <ns:field ns:name="ExternalCardId">DEF3</ns:field> </ns:fields> </ns:getCardResponse>
getCardsModifiedSincedate
Input Elements
Description | Fetches details of cards modified in a given time interval. If the end date is null it will take the current system date and time as the end date. |
projectId | Id of the project that you get from getProject of ProjectService Example: 8 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
startDate | ISO date for Cards created from this date Example: 2013-02-01T08:34:23Z |
endDate | ISO date for Cards created till this date Example: 2013-02-07T10:34:00Z |
Output | If successful returns details of cards modified in a given time interval |
Input Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>[email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:getCardsModifiedSincedateInput> <kan:projectId>3</kan:projectId> <kan:cardType>UserStory</kan:cardType> <kan:startDate>2009-12-25T10:49:52Z</kan:startDate> <kan:endDate>null</kan:endDate> <kan:userLoginId>[email protected]</kan:userLoginId> </kan:getCardsModifiedSincedateInput> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:getCardsModifiedSincedateResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:Cards> <ns:Card ns:CardSequenceNumber="UST1" ns:CreationDate="2012-01-16T09:35:12Z" ns:ItemId="520178" ns:ModifiedDate="2012-01-16T09:35:12Z"/> <ns:Card ns:CardSequenceNumber="UST2" ns:CreationDate="2012-01-16T09:35:12Z" ns:ItemId="520179" ns:ModifiedDate="2012-03-30T04:17:23Z"/> </ns:Cards> </ns:getCardsModifiedSincedateResponse>
archiveCard
Input Elements
Description | Archives a particular card on the board |
projectId | Id of the project that you get from getProject of ProjectService Example: 8 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
cardUniqueId | card unique Id that you will get in add / update / get card response |
Output | If successful archives the card on the board |
Input Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>[email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:archiveCardDetails> <kan:projectId>104</kan:projectId> <kan:cardType>KanbanDefect</kan:cardType> <kan:cardUniqueId>521365</kan:cardUniqueId> <kan:userLoginId></kan:userLoginId> </kan:archiveCardDetails> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:archiveCardResponse xmlns:ns=”http://kanbancard.webservices.kanban.app.digite.com/”> <ns:result>Successful</ns:result> </ns:archiveCardResponse>
updateCard
Input Elements
Description | Updates selected fields of a card passed in request |
projectId | Id of the project that you get from getProject of ProjectService Example: 8 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of to log on to SwiftKanban Example: [email protected] |
cardUniqueId | card unique id that you will get in add/update/get card response Example: 5698 |
fields | List of fields with name and value for each field. Field name will be available from the getCardMetadata method. The type of value to be passed information will be available in the same method. If the field is of LOV type, pass any relevant LOV item value. Example: name=cardSize and its value = L |
Output | If successful updates selected fields of a card passed in request |
Input Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>rtiwari#digite.com</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:updateCardDetails> <kan:projectId>40186</kan:projectId> <kan:cardType>KanbanDefect</kan:cardType> <kan:cardUniqueId>606543</kan:cardUniqueId> <kan:userLoginId>rtiwari#digite.com</kan:userLoginId> <kan:fields> <kan:field name="priority">High</kan:field> </kan:fields> </kan:updateCardDetails> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:getCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:fields> <ns:field ns:name="id">606543</ns:field> <ns:field ns:name="name">defect1</ns:field> <ns:field ns:name="priority">High</ns:field> <ns:field ns:name="defectType">0</ns:field> <ns:field ns:name="severity">0</ns:field> <ns:field ns:name="rootCause">0</ns:field> <ns:field ns:name="currentState">Active</ns:field> <ns:field ns:name="release">0</ns:field> <ns:field ns:name="currentOwner_userId">rtiwari#digite.com</ns:field> <ns:field ns:name="currentOwner">Ravi Tiwari</ns:field> <ns:field ns:name="currentQueue">Ready</ns:field> <ns:field ns:name="createdBy">rtiwari#digite.com</ns:field> <ns:field ns:name="createdDate">2015-08-27T05:11:25Z</ns:field> <ns:field ns:name="modifiedBy">rtiwari#digite.com</ns:field> <ns:field ns:name="modifiedDate">2015-08-31T09:25:08Z</ns:field> <ns:field ns:name="workspaceType">KanbanProject</ns:field> <ns:field ns:name="workspaceId">1540764</ns:field> <ns:field ns:name="resolvedBy">Unassigned</ns:field> <ns:field ns:name="cardSize">M</ns:field> <ns:field ns:name="classOfService">Standard Class</ns:field> <ns:field ns:name="defectNumber">DEF23</ns:field> <ns:field ns:name="Category">Platform</ns:field> <ns:field ns:name="FoundInRelease">0</ns:field> <ns:field ns:name="workType">KanbanDefect</ns:field> <ns:field ns:name="Hot_Fix_Release">0</ns:field> <ns:field ns:name="HF_Merged">0</ns:field> <ns:field ns:name="summaryType">leaf</ns:field> <ns:field ns:name="dateIdentified">2015-08-27T05:11:25Z</ns:field> <ns:field ns:name="iteration">0</ns:field> <ns:field ns:name="smartLane">Kanban board</ns:field> <ns:field ns:name="ExternalCardId">DEF23</ns:field> <ns:field ns:name="currentSwimId">1547904</ns:field> <ns:field ns:name="currentSwimName">Kanban board</ns:field> <ns:field ns:name="currentQueueId">1599633</ns:field> </ns:fields> </ns:getCardResponse>
Note: In case if the card is not on the board, then the value for currentSwimId, currentSwimName and currentQueueId will be N/A.
getSmartLaneDetails
Input Elements
Description | Fetches details of smart lanes on board. |
projectId | Id of the project that you get from getProject of ProjectService Example: 8 |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
Output | If successful returns names and Ids of smart lanes on a board along with name and Id of every queue in each swim lane |
Input Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>[email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:getSmartLaneDetailsInput> <kan:projectId>104</kan:projectId> <kan:userLoginId>[email protected]</kan:userLoginId> </kan:getSmartLaneDetailsInput> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:getSmartLaneDetailsResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:projectId ns:projectId="104"/> <ns:isSmartLanesEnabled ns:isSmartLanesEnabled="N"/> <ns:SwimLanes> <ns:SwimLane ns:laneId="1546990" ns:laneName="Kanban board"> <ns:KanbanQueues> <ns:queue ns:displayName="Ready" ns:isParent="N" ns:queueId="1605318" ns:queueName="Ready"/> <ns:queue ns:displayName="Develop#In-Progress" ns:isParent="N" ns:queueId="1605320" ns:queueName="In-Progress"/> <ns:queue ns:displayName="Validate" ns:isParent="N" ns:queueId="1605322" ns:queueName="Validate"/> <ns:queue ns:displayName="Approve" ns:isParent="N" ns:queueId="1605323" ns:queueName="Approve"/> </ns:KanbanQueues> </ns:SwimLane> </ns:SwimLanes> </ns:getSmartLaneDetailsResponse>
addMultipleCard
Input Elements
Description | Creates multiple new cards |
projectId | Id of the project that you get from getProject of ProjectService Example: 40218 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
fields | List of fields with name and value for each field. Field name will be available from the getCardMetadata method. The type of value to be passed information will be available in the same method. If the field is of LOV type, pass any relevant LOV item value. Example: name=cardSize and its value = L |
Output | If successful, the response returns details of new cards added |
Input Request Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>dolton.d#digite.com</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:addMultipleCardInput> <kan:userLoginId>[email protected]</kan:userLoginId> <kan:card> <kan:projectId>40185</kan:projectId> <kan:cardType>KanbanDefect</kan:cardType> <kan:mode></kan:mode> <kan:fields> <kan:field name="currentOwner">[email protected]</kan:field> <kan:field name="name">test add card 1</kan:field> <kan:field name="cardSize">M</kan:field> <kan:field name="priority">High</kan:field> <kan:field name="Category">Product</kan:field> </kan:fields> </kan:card> <kan:card> <kan:projectId>40185</kan:projectId> <kan:cardType>KanbanIssue</kan:cardType> <kan:mode></kan:mode> <kan:fields> <kan:field name="currentOwner">[email protected]</kan:field> <kan:field name="name">test add card 2</kan:field> <kan:field name="cardSize">S</kan:field> <kan:field name="priority">Medium</kan:field> <kan:field name="Category">PM</kan:field> <kan:field name="classOfService">Expedite</kan:field> </kan:fields> </kan:card> </kan:addMultipleCardInput> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:addMultipleCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:card> <ns:projectId>40185</ns:projectId> <ns:cardType>KanbanDefect</ns:cardType> <ns:cardUniqueId>606085</ns:cardUniqueId> <ns:cardSeqNumber>DEF20</ns:cardSeqNumber> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card added successfully</ns:responseMsg> </ns:card> <ns:card> <ns:projectId>40185</ns:projectId> <ns:cardType>KanbanIssue</ns:cardType> <ns:cardUniqueId>524025</ns:cardUniqueId> <ns:cardSeqNumber>ISS8</ns:cardSeqNumber> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card added successfully</ns:responseMsg> </ns:card> </ns:addMultipleCardResponse>
updateMultipleCard
Input Elements
Description | Updates selected fields of the multiple cards passed in request |
projectId | Id of the project that you get from getProject of ProjectService Example: 40218 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
cardUniqueId | Card unique id that you will get in add/update/get card response Example: 606645 |
fields | List of fields with name and value for each field. Field name will be available from the getCardMetadata method. The type of value to be passed information will be available in the same method. If the field is of LOV type, pass any relevant LOV item value. Example: name=cardSize and its value = L |
Output | If successful, updates selected fields of the multiple cards passed in the request. |
Input Request Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>dolton.d#digite.com</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:updateMultipleCardInput> <kan:userLoginId>[email protected]</kan:userLoginId> <kan:card> <kan:projectId>40185</kan:projectId> <kan:cardType>KanbanIssue</kan:cardType> <kan:cardUniqueId>524025</kan:cardUniqueId> <kan:fields> <kan:field name="name">Issue modified</kan:field> </kan:fields> </kan:card> <kan:card> <kan:projectId>40185</kan:projectId> <kan:cardType>KanbanDefect</kan:cardType> <kan:cardUniqueId>606085</kan:cardUniqueId> <kan:fields> <kan:field name="priority">Critical</kan:field> </kan:fields> </kan:card> </kan:updateMultipleCardInput> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:updateMultipleCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:card> <ns:projectId>40185</ns:projectId> <ns:cardType>KanbanIssue</ns:cardType> <ns:cardUniqueId>524025</ns:cardUniqueId> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card updated successfully</ns:responseMsg> </ns:card> <ns:card> <ns:projectId>40185</ns:projectId> <ns:cardType>KanbanDefect</ns:cardType> <ns:cardUniqueId>606085</ns:cardUniqueId> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card updated successfully</ns:responseMsg> </ns:card> </ns:updateMultipleCardResponse>
archiveMultipleCard
Input Elements
Description | Archives particular cards on the board |
projectId | Id of the project that you get from getProject of ProjectService Example: 40218 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
cardUniqueId | Card unique id that you will get in add/update/get card response Example: 606645 |
fields | List of fields with name and value for each field. Field name will be available from the getCardMetadata method. The type of value to be passed information will be available in the same method. If the field is of LOV type, pass any relevant LOV item value. Example: name=cardSize and its value = L |
Output | If successful, archives the particular cards on the board |
Input Request Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>dolton.d#digite.com</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:archiveMultipleCardInput> <kan:userLoginId>[email protected]</kan:userLoginId> <kan:card> <kan:projectId>40185</kan:projectId> <kan:cardType>KanbanDefect</kan:cardType> <kan:cardUniqueId>606085</kan:cardUniqueId> </kan:card> <kan:card> <kan:projectId>40185</kan:projectId> <kan:cardType>KanbanIssue</kan:cardType> <kan:cardUniqueId>524025</kan:cardUniqueId> </kan:card> </kan:archiveMultipleCardInput> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:archiveMultipleCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:card> <ns:projectId>40185</ns:projectId> <ns:cardType>KanbanDefect</ns:cardType> <ns:cardUniqueId>606085</ns:cardUniqueId> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card Archived successfully</ns:responseMsg> </ns:card> <ns:card> <ns:projectId>40185</ns:projectId> <ns:cardType>KanbanIssue</ns:cardType> <ns:cardUniqueId>524025</ns:cardUniqueId> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card Archived successfully</ns:responseMsg> </ns:card> </ns:archiveMultipleCardResponse>
getMultipleCard
Input Elements
Description | Fetches multiple card details |
projectId | Id of the project that you get from getProject of ProjectService Example: 8 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
cardUniqueId | card unique id that you will get in add card response |
Output | If successful, the response returns details of a particular card. |
Input Request Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>[email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:getMultipleCardRequest> <kan:userLoginId></kan:userLoginId> <!--1 or more repetitions:--> <kan:card> <kan:projectId>1</kan:projectId> <kan:cardUniqueId>DEF7</kan:cardUniqueId> <kan:cardType>KanbanDefect</kan:cardType> </kan:card> <kan:card> <kan:projectId>1</kan:projectId> <kan:cardUniqueId>DCMG1</kan:cardUniqueId> <kan:cardType>DCMG</kan:cardType> </kan:card> </kan:getMultipleCardRequest> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <ns:getMultipleCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:card> <ns:projectId>1</ns:projectId> <ns:cardType>DCMG</ns:cardType> <ns:cardUniqueId>DCMG1</ns:cardUniqueId> <ns:responseStatus>Successful</ns:responseStatus> <ns:fields> <ns:field ns:name="cardNumber">DCMG1</ns:field> <ns:field ns:name="name">Document card</ns:field> <ns:field ns:name="currentOwner_userId">[email protected]</ns:field> <ns:field ns:name="currentOwner">Dinanath Parab</ns:field> <ns:field ns:name="priority">Medium</ns:field> <ns:field ns:name="classOfService">Standard Class</ns:field> <ns:field ns:name="cardSize">M</ns:field> <ns:field ns:name="currentState">Active</ns:field> <ns:field ns:name="summaryType">leaf</ns:field> <ns:field ns:name="release">0</ns:field> <ns:field ns:name="workType">DCMG</ns:field> <ns:field ns:name="currentQueue">Ready</ns:field> <ns:field ns:name="tags">0</ns:field> <ns:field ns:name="smartLane">Kanban Board</ns:field> <ns:field ns:name="createdBy">[email protected]</ns:field> <ns:field ns:name="createdDate">2018-12-03T03:42:03Z</ns:field> <ns:field ns:name="modifiedBy">[email protected]</ns:field> <ns:field ns:name="modifiedDate">2018-12-03T03:43:55Z</ns:field> <ns:field ns:name="workspaceType">KanbanProject</ns:field> <ns:field ns:name="workspaceId">1546781</ns:field> <ns:field ns:name="id">1538568</ns:field> <ns:field ns:name="dateIdentified">2018-12-03T03:42:03Z</ns:field> <ns:field ns:name="ExternalCardId">DCMG1</ns:field> <ns:field ns:name="currentSwimId">1551930</ns:field> <ns:field ns:name="currentSwimName">Kanban Board</ns:field> <ns:field ns:name="currentQueueId">1610937</ns:field> </ns:fields> </ns:card> <ns:card> <ns:projectId>1</ns:projectId> <ns:cardType>KanbanDefect</ns:cardType> <ns:cardUniqueId>DEF7</ns:cardUniqueId> <ns:responseStatus>Successful</ns:responseStatus> <ns:fields> <ns:field ns:name="defectNumber">DEF7</ns:field> <ns:field ns:name="name">Unblock Card</ns:field> <ns:field ns:name="currentOwner_userId">[email protected]</ns:field> <ns:field ns:name="currentOwner">Dinanath Parab</ns:field> <ns:field ns:name="priority">Medium</ns:field> <ns:field ns:name="classOfService">Standard Class</ns:field> <ns:field ns:name="cardSize">M</ns:field> <ns:field ns:name="currentQueue">Develop#In-Progress</ns:field> <ns:field ns:name="iteration">0</ns:field> <ns:field ns:name="smartLane">Kanban Board</ns:field> <ns:field ns:name="workType">KanbanDefect</ns:field> <ns:field ns:name="currentState">Active</ns:field> <ns:field ns:name="release">0</ns:field> <ns:field ns:name="summaryType">leaf</ns:field> <ns:field ns:name="createdBy">[email protected]</ns:field> <ns:field ns:name="createdDate">2015-07-29T10:44:41Z</ns:field> <ns:field ns:name="modifiedBy">[email protected]</ns:field> <ns:field ns:name="modifiedDate">2018-12-03T03:43:59Z</ns:field> <ns:field ns:name="workspaceType">KanbanProject</ns:field> <ns:field ns:name="workspaceId">1546781</ns:field> <ns:field ns:name="dateIdentified">2015-07-29T10:44:41Z</ns:field> <ns:field ns:name="id">530001</ns:field> <ns:field ns:name="ExternalCardId">DEF7</ns:field> <ns:field ns:name="currentSwimId">1551930</ns:field> <ns:field ns:name="currentSwimName">Kanban Board</ns:field> <ns:field ns:name="currentQueueId">1610939</ns:field> </ns:fields> </ns:card> </ns:getMultipleCardResponse> </soapenv:Body> </soapenv:Envelope>
moveMultipleCardToReady
Input Elements
Description | Moves the cards from backlog/archive to board to any queue and swim lane provided in request |
projectId | Id of the project that you get from getProject of ProjectService Example: 40218 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
cardUniqueId | Card unique id that you will get in add/update/get card response Example: 606645 |
queueId | Queue Id that you will get from getSmartLaneDetails Example: 243566 |
swimId | Swim lane Id to which the queue belongs Example: 456546 |
Output | If successful, the cards are moved to the queue of the given swim lane. |
Input Request Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>dolton.d#digite.com</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:moveMultipleCardToReadyInput> <kan:userLoginId>[email protected]</kan:userLoginId> <kan:card> <kan:cardType>KanbanDefect</kan:cardType> <kan:cardUniqueId>606085</kan:cardUniqueId> <kan:projectId>40185</kan:projectId> <kan:queueId>1599073</kan:queueId> <kan:swimId>1547699</kan:swimId> </kan:card> <kan:card> <kan:cardType>KanbanIssue</kan:cardType> <kan:cardUniqueId>524025</kan:cardUniqueId> <kan:projectId>40185</kan:projectId> <kan:queueId>1599074</kan:queueId> <kan:swimId>1547700</kan:swimId> </kan:card> </kan:moveMultipleCardToReadyInput> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:moveMultipleCardToReadyResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:card> <ns:projectId>40185</ns:projectId> <ns:cardType>KanbanDefect</ns:cardType> <ns:cardUniqueId>606085</ns:cardUniqueId> <ns:queueId>1599073</ns:queueId> <ns:swimId>1547699</ns:swimId> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card Moved successfully</ns:responseMsg> </ns:card> <ns:card> <ns:projectId>40185</ns:projectId> <ns:cardType>KanbanIssue</ns:cardType> <ns:cardUniqueId>524025</ns:cardUniqueId> <ns:queueId>1599074</ns:queueId> <ns:swimId>1547700</ns:swimId> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card Moved successfully</ns:responseMsg> </ns:card> </ns:moveMultipleCardToReadyResponse>
moveMultipleCardOnBoard
Input Elements
Description | Moves cards across lanes or across queues on board |
projectId | Id of the project that you get from getProject of ProjectService Example: 40218 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
cardUniqueId | Card unique id that you will get in add/update/get card response Example: 606645 |
fromQkeyId | Id of queue where the card exists now Example: 243566 |
toQkeyId | Id of the queue to where you want to move the card Example: 567567 |
fromSwimId | Id of the swim lane where the card exists now Example: 76867 |
toSwimId | Id of the swim lane to where you want to move the card Example: 123123 |
Output | If successful, the cards are moved to the queue of the given swim lane |
Input Request Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>dolton.d#digite.com</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:moveMultipleCardOnBoardInput> <kan:userLoginId>[email protected]</kan:userLoginId> <kan:card> <kan:projectId>40185</kan:projectId> <kan:cardType>KanbanDefect</kan:cardType> <kan:cardUniqueId>606085</kan:cardUniqueId> <kan:fromQkeyId>1599073</kan:fromQkeyId> <kan:toQkeyId>1599074</kan:toQkeyId> <kan:fromSwimId>1547699</kan:fromSwimId> <kan:toSwimId>1547700</kan:toSwimId> </kan:card> <kan:card> <kan:projectId>40185</kan:projectId> <kan:cardType>KanbanIssue</kan:cardType> <kan:cardUniqueId>524025</kan:cardUniqueId> <kan:fromQkeyId>1599074</kan:fromQkeyId> <kan:toQkeyId>1599073</kan:toQkeyId> <kan:fromSwimId>1547700</kan:fromSwimId> <kan:toSwimId>1547699</kan:toSwimId> </kan:card> </kan:moveMultipleCardOnBoardInput> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:moveMultipleCardOnBoardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:card> <ns:projectId>40185</ns:projectId> <ns:cardType>KanbanDefect</ns:cardType> <ns:cardUniqueId>606085</ns:cardUniqueId> <ns:fromSwimId>1599073</ns:fromSwimId> <ns:fromQkeyId>1547699</ns:fromQkeyId> <ns:toSwimId>1599074</ns:toSwimId> <ns:toQkeyId>1547700</ns:toQkeyId> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card moved successfully</ns:responseMsg> </ns:card> <ns:card> <ns:projectId>40185</ns:projectId> <ns:cardType>KanbanIssue</ns:cardType> <ns:cardUniqueId>524025</ns:cardUniqueId> <ns:fromSwimId>1599074</ns:fromSwimId> <ns:fromQkeyId>1547700</ns:fromQkeyId> <ns:toSwimId>1599073</ns:toSwimId> <ns:toQkeyId>1547699</ns:toQkeyId> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card moved successfully</ns:responseMsg> </ns:card> </ns:moveMultipleCardOnBoardResponse>
moveMultipleCardToBacklog
Input Elements
Description | Moves multiple cards from the board to the backlog |
projectId | Id of the project that you get from getProject of ProjectService Example: 40218 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
cardUniqueId | Card unique id that you will get in add/update/get card response Example: 606645 |
Output | If successful moves multiple cards from to the backlog |
Input Request Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>dolton.d#digite.com</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:moveMultipleCardToBacklogInput> <kan:userLoginId>[email protected]</kan:userLoginId> <kan:card> <kan:projectId>40185</kan:projectId> <kan:cardType>KanbanDefect</kan:cardType> <kan:cardUniqueId>606085</kan:cardUniqueId> </kan:card> <kan:card> <kan:projectId>40185</kan:projectId> <kan:cardType>KanbanIssue</kan:cardType> <kan:cardUniqueId>524025</kan:cardUniqueId> </kan:card> </kan:moveMultipleCardToBacklogInput> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:moveMultipleCardToBacklogResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:card> <ns:projectId>40185</ns:projectId> <ns:cardType>KanbanDefect</ns:cardType> <ns:cardUniqueId>606085</ns:cardUniqueId> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card moved to Backlog successfully</ns:responseMsg> </ns:card> <ns:card> <ns:projectId>40185</ns:projectId> <ns:cardType>KanbanIssue</ns:cardType> <ns:cardUniqueId>524025</ns:cardUniqueId> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card moved to Backlog successfully</ns:responseMsg> </ns:card>
deleteCard
Input Elements
Description | Deletes a particular card on the board |
projectId | Id of the project that you get from getProject of ProjectService Example: 40218 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
cardUniqueId | Card unique id that you will get in add/update/get card response Example: 606645 |
Output | If successful deletes the particular card on the board. |
Input Request Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"><soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>[email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:deleteCardInput> <kan:projectId>2</kan:projectId> <kan:cardType>KanbanDefect</kan:cardType> <kan:cardUniqueId>DEF4</kan:cardUniqueId> <kan:userLoginId></kan:userLoginId> </kan:deleteCardInput> </soapenv:Body> </soapenv:Envelope>
<ns:deleteCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:projectId>2</ns:projectId> <ns:cardType>KanbanDefect</ns:cardType> <ns:cardUniqueId>DEF4</ns:cardUniqueId> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card Deleted successfully.</ns:responseMsg> </ns:deleteCardResponse>
deleteMultipleCard
Input Elements
Description | Deletes particular cards on the board |
projectId | Id of the project that you get from getProject of ProjectService Example: 40218 |
cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
cardUniqueId | Card unique id that you will get in add/update/get card response Example: 606645 |
Output | If successful deletes the particular cards on the board. |
Input Request Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>[email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:deleteMultipleCardInput> <kan:userLoginId></kan:userLoginId> <kan:card> <kan:projectId>2</kan:projectId> <kan:cardType>UserStory</kan:cardType> <kan:cardUniqueId>UST3</kan:cardUniqueId> </kan:card> <kan:card> <kan:projectId>2</kan:projectId> <kan:cardType>KanbanDefect</kan:cardType> <kan:cardUniqueId>DEF7</kan:cardUniqueId> </kan:card> </kan:deleteMultipleCardInput> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:deleteMultipleCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:card> <ns:projectId>2</ns:projectId> <ns:cardType>UserStory</ns:cardType> <ns:cardUniqueId>UST3</ns:cardUniqueId> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card Deleted successfully</ns:responseMsg> </ns:card> <ns:card> <ns:projectId>2</ns:projectId> <ns:cardType>KanbanDefect</ns:cardType> <ns:cardUniqueId>DEF7</ns:cardUniqueId> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card Deleted successfully</ns:responseMsg> </ns:card>
convertCard
Input Elements
Description | Converts a card to the required card type. |
userLoginId | mail address of user to log in to SwiftKanban, Example: [email protected] |
projectId | ProjectId of project in which card exists. |
cardUniqueId | Id of the card which we want to convert. |
cardType | Original card type which we want to convert. |
destinationCardType | Card type into which we want to convert the card. |
breakRelation | Relations need to be removed or not. Consider the following scenario: ENHC is linked to UST and TASK in card type links, but there is no link between DEF and UST. Suppose ENHC10 is linked with UST20, and we are trying to convert ENHC10 card to a Defect card type. Now if breakRelation value set to true: There will be no relation between UST20 and newly created target card DEF1. if breakRelation value set to false: Card conversion will fail. |
Suppose we are trying to convert ENHC10 to a TASK card type, then as the relation is already defined between these two card types, break relation parameter will be ignored and card will be converted.OutputIf successful, the response return converted card details.
Input Request Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>[email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:convertCardInput> <kan:projectId>40020</kan:projectId> <kan:cardType>TASK</kan:cardType> <kan:cardUniqueId>TASK536</kan:cardUniqueId> <kan:destinationCardType>KanbanDefect</kan:destinationCardType> <kan:breakRelation>true</kan:breakRelation> <kan:userLoginId></kan:userLoginId> </kan:convertCardInput> </soapenv:Body> </soapenv:Envelope>
Output Request Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <ns:convertCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:projectId>40020</ns:projectId> <ns:cardUniqueId>DEF12</ns:cardUniqueId> <ns:cardType>KanbanDefect</ns:cardType> <ns:responseMsg>Card Converted Successfully</ns:responseMsg> <ns:responseStatus>Successful</ns:responseStatus> </ns:convertCardResponse> </soapenv:Body> </soapenv:Envelope>
Failure Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <ns:convertCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:Exception> <ns:Request> <kan:convertCardInput xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <kan:projectId>40020</kan:projectId> <kan:cardType>TASK</kan:cardType> <kan:cardUniqueId>TASK536</kan:cardUniqueId> <kan:destinationCardType>KanbanDefect</kan:destinationCardType> <kan:breakRelation>true</kan:breakRelation> <kan:userLoginId/> </kan:convertCardInput> </ns:Request> <ns:Errors> <ns:errorMessage ns:details="Error while validating relations for given card type. "/> </ns:Errors> </ns:Exception> </ns:convertCardResponse> </soapenv:Body> </soapenv:Envelope>
transferCard
Input Elements
Description | Transfer card to a particular queue on a board |
userLoginId | Email address of user to log in to SwiftKanban, Example: [email protected] |
cardUniqueId | Unique Id of the card to be transferred Example: UST312,142 |
cardType | Card Type of the card to be transferred Example: UserStory |
projectId | Id of the board to which the card belongs Example: 1 |
destinationProjectId | Id of the board where the card will be transferred Example: 2 |
destinationSwimId | Id of swim where the card will be transferred Example: 12 |
destinationQueueId | Id of queue where the card will be transferred Example: 41 |
Output | If successful, the response returns that the card was transferred successfully with the new card id and card type. |
Input Request Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>[email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">welcome123</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:transferCardInput> <kan:userLoginId>[email protected]</kan:userLoginId> <kan:cardUniqueId>UST312</kan:cardUniqueId> <kan:cardType>UserStory</kan:cardType> <kan:projectId>1</kan:projectId> <kan:destinationProjectId>2</kan:destinationProjectId> <kan:destinationSwimId>12</kan:destinationSwimId> <kan:destinationQueueId>41</kan:destinationQueueId> </kan:transferCardInput> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <ns:transferCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card transferred successfully</ns:responseMsg> <ns:cardUniqueId>UST142</ns:cardUniqueId> <ns:cardType>UserStory</ns:cardType> <ns:projectId>2</ns:projectId> </ns:transferCardResponse> </soapenv:Body> </soapenv:Envelope>
Failure Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <ns:transferCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:Exception> <ns:Request> <kan:transferCardInput xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <kan:userLoginId>[email protected]</kan:userLoginId> <kan:cardUniqueId>UST312</kan:cardUniqueId> <kan:cardType>UserStory</kan:cardType> <kan:projectId>1</kan:projectId> <kan:destinationProjectId>2</kan:destinationProjectId> <kan:destinationSwimId>12</kan:destinationSwimId> <kan:destinationQueueId>41</kan:destinationQueueId> </kan:transferCardInput> </ns:Request> <ns:Errors> <ns:errorMessage ns:details="KanbanCardService.transfer Failed :You do not have sufficient rights to delete the card. "/> </ns:Errors> </ns:Exception> </ns:transferCardResponse> </soapenv:Body> </soapenv:Envelope>
getBoardCards
Input Elements
Description | Fetches details of cards from Boards |
ProjectId | Id of that project that you get from getProject of ProjectService Example: 9 |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
Output | If successful returns details of all cards are available on Board. |
Input response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username>IntegrationUser_1024080</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">test12345</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:getBoardCardsRequest> <kan:projectId>9</kan:projectId> <kan:userLoginId> [email protected]</kan:userLoginId> </kan:getBoardCardsRequest> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:getBoardCardsResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:boardCards> <ns:card ns:CardSequenceNumber="UST1" ns:cardUniqueId="11111" ns:cardType="UserStory" ns:name="Test card1" ns:CreationDate="2017-01-01T09:19:52Z" ns:createdBy=" [email protected]" ns:ModifiedDate="2017-01-01T09:19:52Z" ns:modifiedBy=" [email protected]"/> <ns:card ns:CardSequenceNumber="UST2" ns:cardUniqueId="22222" ns:cardType="UserStory" ns:name="Test card2" ns:CreationDate="2017-01-01T09:19:52Z" ns:createdBy=" [email protected]" ns:ModifiedDate="2017-01-01T09:19:52Z" ns:modifiedBy=" [email protected]"/> <ns:card ns:CardSequenceNumber="ENHC1" ns:cardUniqueId="22222" ns:cardType="ENHC" ns:name="Test card3" ns:CreationDate="2017-01-02T09:19:52Z" ns:createdBy=" [email protected]" ns:ModifiedDate="2017-01-01T09:19:52Z" ns:modifiedBy=" [email protected]"/> <ns:card ns:CardSequenceNumber="ENHC2" ns:cardUniqueId="22223" ns:cardType="CDEF" ns:name="Test card4" ns:CreationDate="2017-01-03T09:19:52Z" ns:createdBy=" [email protected]" ns:ModifiedDate="2017-01-01T09:19:52Z" ns:modifiedBy=" [email protected]"/> </ns:boardCards> <ns:backlogCards> <ns:card ns:CardSequenceNumber="UST3" ns:cardUniqueId="33333" ns:cardType="KanbanDefect" ns:name="Test BK card1" ns:CreationDate="2017-01-01T09:19:52Z" ns:createdBy=" [email protected]" ns:ModifiedDate="2017-01-01T09:19:52Z" ns:modifiedBy=" [email protected]"/> <ns:card ns:CardSequenceNumber="UST4" ns:cardUniqueId="44444" ns:cardType="UserStory" ns:name="Test BK card2" ns:CreationDate="2017-01-01T09:19:52Z" ns:createdBy=" [email protected]" ns:ModifiedDate="2017-01-01T09:19:52Z" ns:modifiedBy=" [email protected]"/> </ns:backlogCards> </ns:getBoardCardsResponse>
discardAbortCard
Input Elements
Description | Discard/Abort Card type for discard/abort with the details. |
ProjectId | Id of that project that you get from getProject of ProjectService Example: 40201 |
cardType | Card type of the card obtained from getCardListForProject output Example: KanbanDefect |
cardUniqueId | card unique id that you will get in add card response |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
discardAbortReason | getting from master list of abort/discard |
discardAbortComment | should have a one liner comment instead of single word |
Output | If successful returns card is abort/discard. |
Input Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username> [email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ABCD</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:discardAbortCardRequest> <kan:projectId>40201</kan:projectId> <kan:cardType>KanbanDefect</kan:cardType> <kan:cardUniqueId>DEF39</kan:cardUniqueId> <kan:userLoginId> [email protected]</kan:userLoginId> <kan:discardAbortReason>Merged</kan:discardAbortReason> <kan:discardAbortComment>Discard</kan:discardAbortComment> </kan:discardAbortCardRequest> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <ns:discardAbortCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:result>Successful</ns:result> </ns:discardAbortCardResponse> </soapenv:Body> </soapenv:Envelope>
discardAbortMultipleCard
Input Elements
Description | Discard/Abort multipleCards which you need to discard/abort with the details. |
ProjectId | Id of that project that you get from getProject of ProjectService Example: 40201 |
cardType | Card type of the card obtained from getCardListForProject output Example: KanbanDefect |
cardUniqueId | card unique id that you will get in add card response |
userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
discardAbortReason | getting from master list of abort/discard |
discardAbortComment | should have a one liner comment instead of single word |
Output | If successful returns all Cards are abort/discard successfully. |
Input Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:kan="http://kanbancard.webservices.kanban.app.digite.com/"> <soapenv:Header> <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1"> <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-31571602"> <wsse:Username> [email protected]</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ABCD</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <kan:discardAbortMultipleCardRequest> <kan:userLoginId> [email protected]</kan:userLoginId> <!--1 or more repetitions:--> <kan:card> <kan:projectId>40201</kan:projectId> <kan:cardType>KanbanDefect</kan:cardType> <kan:cardUniqueId>614051</kan:cardUniqueId> <kan:discardAbortReason>Merged</kan:discardAbortReason> <kan:discardAbortComment>Discard</kan:discardAbortComment> </kan:card> <kan:card> <kan:projectId>40201</kan:projectId> <kan:cardType>KanbanDefect</kan:cardType> <kan:cardUniqueId>DEF48</kan:cardUniqueId> <kan:discardAbortReason>Merged</kan:discardAbortReason> <kan:discardAbortComment>Discard</kan:discardAbortComment> </kan:card> <kan:card> <kan:projectId>40201</kan:projectId> <kan:cardType>KanbanDefect</kan:cardType> <kan:cardUniqueId>DEF40</kan:cardUniqueId> <kan:discardAbortReason>Dropped</kan:discardAbortReason> <kan:discardAbortComment>Abort</kan:discardAbortComment> </kan:card> </kan:discardAbortMultipleCardRequest> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <ns:discardAbortMultipleCardResponse xmlns:ns="http://kanbancard.webservices.kanban.app.digite.com/"> <ns:card> <ns:projectId>40201</ns:projectId> <ns:cardType>KanbanDefect</ns:cardType> <ns:cardUniqueId>DEF40</ns:cardUniqueId> <ns:discardAbortComment>Abort</ns:discardAbortComment> <ns:discardAbortReason>Dropped</ns:discardAbortReason> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card discard/Abort successfully</ns:responseMsg> </ns:card> <ns:card> <ns:projectId>40201</ns:projectId> <ns:cardType>KanbanDefect</ns:cardType> <ns:cardUniqueId>DEF48</ns:cardUniqueId> <ns:discardAbortComment>Discard</ns:discardAbortComment> <ns:discardAbortReason>Merged</ns:discardAbortReason> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card discard/Abort successfully</ns:responseMsg> </ns:card> <ns:card> <ns:projectId>40201</ns:projectId> <ns:cardType>KanbanDefect</ns:cardType> <ns:cardUniqueId>614051</ns:cardUniqueId> <ns:discardAbortComment>Discard</ns:discardAbortComment> <ns:discardAbortReason>Merged</ns:discardAbortReason> <ns:responseStatus>Successful</ns:responseStatus> <ns:responseMsg>Card discard/Abort successfully</ns:responseMsg> </ns:card> </ns:discardAbortMultipleCardResponse> </soapenv:Body> </soapenv:Envelope>