Service Description: MetadataService
Service EPR: https://login.swiftkanban.com/axis2/services/MetadataService
Service Status: Active
Available Operations:
Note: Any mention of Iteration or Project in any Web Service operations are equivalent to Sprint or Board in the SwiftKanban User Interface (UI).
getCardListForProject
Input Elements
| Description | Fetches all the card types available in a project |
| projectId | Id of the project which you get from getProject of ProjectService Example: 8 |
| userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
| Output | If successful, the response contains a list of all the card types available in a project. For each card, card code, card type, and card name will be given in the response |
Input Request Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ifor="http://iform.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> <ifor:getCardListForProjectInput> <ifor:projectId>1</ifor:projectId> <ifor:userLoginId> [email protected]</ifor:userLoginId> </ifor:getCardListForProjectInput> </soapenv:Body> </soapenv:Envelope>
Output Request Example
<ns:getCardListForProjectResponse xmlns:ns="http://iform.webservices.kanban.app.digite.com/"> <ns:CardTypes> <ns:Card ns:CardCode="DCMG" ns:CardType="DCMG" ns:TypeName="Document Management"/> <ns:Card ns:CardCode="EPIC" ns:CardType="EPIC" ns:TypeName="Epic"/> <ns:Card ns:CardCode="UST" ns:CardType="UserStory" ns:TypeName="User Stories"/> </ns:CardTypes> </ns:getCardListForProjectResponse>
getCardMetadata
Input Elements
| Description | Fetches metadata explanation of the card |
| userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
| cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
| Output | If successful, the response returns metadata explanation of the card. Includes details of all the fields and name of a field, type of input that a field can take and other required information about each field. Field name has to be used in the addCard and UpdateCard web service methods. If the field is of static LOV type, details of items available in the static list will be displayed. If the field is of dynamic list type, dynamic data key will be shown. The list of elements allowed in the dynamic list can be accessed by calling the getDynamicLOVData method. |
Input Response Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ifor="http://iform.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> <ifor:getCardMetadata_Input> <ifor:cardType>KanbanDefect</ifor:cardType> <ifor:userLoginId> [email protected]</ifor:userLoginId> </ifor:getCardMetadata_Input> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:getCardMetadataResponse xmlns:ns="http://iform.webservices.kanban.app.digite.com/"> <ns:Card> <ns:CardMetadataDetails ns:cardId="30637" ns:cardName="Defects" ns:cardRevision="0" ns:cardType="KanbanDefect" ns:description="Defect 1" ns:type="Standard"> <ns:CardFieldDetails> <ns:field ns:defaultValue="" ns:fieldLabel="Id" ns:fieldName="defectNumber" ns:fieldType="Single-Line Text" ns:inputMethod="System Generated" ns:isReadOnly="Yes" ns:isRequired="NO" ns:itemType="String" ns:isUserType="No" /> <ns:field ns:fieldName="currentOwner" ns:fieldLabel=" Current Owner" ns:fieldType="Collection" ns:itemType="PersonMin" ns:isRequired="NO" ns:isReadOnly="NO" ns:isDisabled="NO" ns:inputMethod="Dynamic List" ns:dynamicDataKey="TeamMemberList" ns:isUserType="Yes" /> <ns:field ns:defaultValue="Medium" ns:fieldLabel="Priority" ns:fieldName="priority" ns:fieldType="Single-Line Text" ns:inputMethod="Static List" ns:isReadOnly="NO" ns:isRequired="Yes" ns:itemType="String" ns:staticLovId="1530357" ns:isUserType="No"> <ns:MasterListDetails ns:MasterListId="1530357" ns:MasterListName="Priority" ns:currentState="Active"> <ns:MasterListItems> <ns:MasterListItem ns:currentState="Active" ns:itemLabel="Critical" ns:itemValue="Critical" /> <ns:MasterListItem ns:currentState="Active" ns:itemLabel="High" ns:itemValue="High" /> </ns:MasterListItems> </ns:MasterListDetails> </ns:field> <ns:field ns:defaultValue="" ns:fieldLabel="Estimate (Days)" ns:fieldName="estimates" ns:fieldType="Decimal" ns:inputMethod="Manual Entry" ns:isReadOnly="NO" ns:isRequired="NO" ns:itemType="Double" ns:isUserType="No" /> <ns:field ns:defaultValue="" ns:fieldLabel="Due Date" ns:fieldName="dueDate" ns:fieldType="Date" ns:inputMethod="Manual Entry" ns:isReadOnly="NO" ns:isRequired="NO" ns:itemType="Date" ns:isUserType="No" /> <ns:field ns:defaultValue="" ns:dynamicDataKey="KanbanReleaseList" ns:fieldLabel="Release" ns:fieldName="release" ns:fieldType="RefName" ns:inputMethod="Dynamic List" ns:isReadOnly="NO" ns:isRequired="NO" ns:itemType="com.digite.app.kanban.release.entity.KanbanRelease" ns:isUserType="No" /> <ns:field ns:fieldName="iteration" ns:fieldLabel="Sprint" ns:fieldType="RefName" ns:itemType="com.digite.app.kanban.iteration.entity.KanbanIteration" ns:isRequired="NO" ns:isReadOnly="NO" ns:isDisabled="NO" ns:inputMethod="Dynamic List" ns:dynamicDataKey="KanbanIterationList" ns:isUserType="No" ns:dependentFieldName="release" /> <ns:field ns:defaultValue="0" ns:fieldLabel="Is Related" ns:fieldName="isRelated" ns:fieldType="Single-Line Text" ns:inputMethod="System Generated" ns:isReadOnly="Yes" ns:isRequired="NO" ns:itemType="Boolean" /> <ns:field ns:fieldName="shorttext1" ns:fieldLabel="Country" ns:fieldType="Regular Text" ns:itemType="String" ns:isRequired="NO" ns:isReadOnly="NO" ns:isDisabled="NO" ns:inputMethod="Static List" ns:staticLovId="1531632" ns:isUserType="No"> <ns:MasterListDetails ns:MasterListName="Country" ns:MasterListId="1531632" ns:currentState="Active"> <ns:MasterListItems> <ns:MasterListItem ns:itemValue="-99999" ns:currentState="Active" ns:itemLabel="None" /> <ns:MasterListItem ns:itemValue="Australia" ns:currentState="Active" ns:itemLabel="Australia" /> <ns:MasterListItem ns:itemValue="India" ns:currentState="Active" ns:itemLabel="India" /> </ns:MasterListItems> </ns:MasterListDetails> </ns:field> <ns:field ns:fieldName="shorttext2" ns:fieldLabel="City" ns:fieldType="Regular Text" ns:itemType="String" ns:isRequired="NO" ns:isReadOnly="NO" ns:isDisabled="NO" ns:inputMethod="Static List" ns:staticLovId="1531633" ns:isUserType="No" ns:dependentFieldName="shorttext1"> <ns:MasterListDetails ns:MasterListName="city" ns:MasterListId="1531633" ns:currentState="Active"> <ns:MasterListItems> <ns:MasterListItem ns:itemValue="-99999" ns:currentState="Active" ns:itemLabel="None" /> <ns:MasterListItem ns:itemValue="Delhi" ns:currentState="Active" ns:itemLabel="Delhi"> <ns:dependentItem ns:itemValue="India" /> </ns:MasterListItem> <ns:MasterListItem ns:itemValue="Mumbai" ns:currentState="Active" ns:itemLabel="Mumbai"> <ns:dependentItem ns:itemValue="India" /> </ns:MasterListItem> <ns:MasterListItem ns:itemValue="Perth" ns:currentState="Active" ns:itemLabel="Perth"> <ns:dependentItem ns:itemValue="Australia" /> </ns:MasterListItem> <ns:MasterListItem ns:itemValue="Sydney" ns:currentState="Active" ns:itemLabel="Sydney"> <ns:dependentItem ns:itemValue="Australia" /> </ns:MasterListItem> </ns:MasterListItems> </ns:MasterListDetails> </ns:field> </ns:CardFieldDetails> </ns:CardMetadataDetails> </ns:Card> </ns:getCardMetadataResponse>
getDynamicLOVData
Input Elements
| Description | Fetches list of items allowed in the dynamic data list |
| userLoginId | Email address of user to log on to SwiftKanban Example: [email protected] |
| cardType | Card type of the card obtained from getCardListForProject output Example: UserStory |
| projectId | Id of the project that you get from getProject of ProjectService Example:8 |
| Output | If successful, the response returns list of items allowed in the dynamic data list |
Input Request Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ifor="http://iform.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> <ifor:getDynamicLOVData_Input> <ifor:cardType>KanbanDefect</ifor:cardType> <ifor:projectId>1</ifor:projectId> <ifor:dynamicDataKey>KanbanReleaseList</ifor:dynamicDataKey> <ifor:userLoginId> [email protected]</ifor:userLoginId> </ifor:getDynamicLOVData_Input> </soapenv:Body> </soapenv:Envelope>
Output Response Example
<ns:getDynamicLOVDataResponse xmlns:ns="http://iform.webservices.kanban.app.digite.com/"> <ns:Items> <ns:Items ns:itemLabel="Not Yet Identified" ns:itemValue="0"/> </ns:Items> </ns:getDynamicLOVDataResponse>