Migration of the SOAP API clients for Release 5.1

The new SOAP interface can be accessed at:

http://<hostname:port>/scrumworks-api/api2/scrumworks

The WSDL can be accessed at:

http://<hostname:port>/scrumworks-api/api2/scrumworks?wsdl

Changes in the web service between 5.0 and 5.1

Backlog Items and Custom Statuses

Backlog Item custom statuses are newly introduced in 5.1, but are not exposed in this version of the API for backward compatibility.

A number of existing operations result in a change in a Backlog Item’s status. When this happens, the default status will be chosen automatically.

For example:
  • moveBacklogItemIntoSprint will set the item to the default In Progress status.
  • updateBacklogItem with a completedDate will set the item to the default Done status.

» top

Changes in the web service between 4.3 and 4.4

Accessing the audit information
The new SOAP interface introduces the method getChangesSinceRevision to retrieve changes made in a product since a given revision number. The revision number is global in a ScrumWorks Pro installation and starts at 0.

» top

Web Service object changes
  • The WSO suffix is removed from names of the types
  • The field BacklogItem.backlogItemId is changed to id
  • The field BacklogItem.name replaced title
  • The Budget.productId field replaces product
  • The DashboardReleaseStatistics.hasUnestimatedItems field replaces unestimatedItemsFlag
  • Estimate replaces BacklogItemEstimateWSO and TaskEstimateWSO
  • The field Impediment.description replaces detail
  • The field Impediment.reporter replaces teamMember
  • The field Impediment.lastModifiedDate replaces lastModDate
  • Product adds the programIds field to keep track of the programs products are included in
  • Program adds the productIds field to keep track of the products included
  • The field Release.name replaces title
  • The field Release.endDate replaces releaseDate
  • Added the field Sprint.nonWorkingDays
  • The field Task.name replaces title
  • The field Task.currentEstimate replaces estimatedHours
  • The field Task.taskBoardStatusRank is removed
  • The field TaskHoursSpent.pointPerson replaces userName
  • The field TaskHoursSpent.date replaces dateLong
  • Added the field User.email

» top

Method changes
  • Wherever possible, the methods in the SOAP interface are taking ID's of the objects instead of the actual objects in order to reduce network traffic.
  • Java users: the API is using Lists instead of arrays.
  • getBacklogItemById replaces getBacklogItem
  • getBacklogItemsByIds replaces getBacklogItems
  • getBacklogItemsInProduct replaces getActiveBacklogItems and getInactiveBacklogItems
  • getBacklogItemsInRelease replaces getActiveBacklogItemsForRelease
  • getBacklogItemsForReleaseInProduct replaces getActiveBacklogItemsForReleaseInProduct
  • getBacklogItemsForSprint replaces getActiveBacklogItemsForSprint
  • getSprintInProductForTeam replaces getSprintForTeam
  • deleteBacklogItem replaces markBacklogItemInactive and deleteBacklogItem
  • createSprint replaces createSprint and createSprintWithNonWorkingDays
  • createImpediment takes one argument, doesn't require to specify a product
  • getBacklogItemsForTheme replaces getActiveBacklogItemsForTheme
  • getBacklogItemsForThemeInProduct replaces getActiveBacklogItemsForThemeInProduct
  • addThemeToBacklogItems replaces addBacklogItemsToTheme
  • removeThemeFromBacklogItems replaces removeBacklogItemsFromTheme
  • updateHoursSpentOnTask replaces updateTaskHoursSpent
  • getAllTaskHoursSpentOnTask replaces getTotalTaskHoursSpent
  • getTaskHoursSpentOnTaskByPerson replaces getTaskHoursSpentForTask
  • getSprintsForProduct replaces getSprints

» top

Methods added
  • getTasksForProduct: returns all tasks in the active backlog items in a product.
  • getTeamById: finds a team by its ID.
  • getProductById: finds a product by its ID.
  • getSprintById: finds a sprint by its ID.
  • getChangesSinceRevision: gets changed items since the given revision.
  • getChangesSinceRevisionForTypes: gets changed items since the given revision, restricted by type.
  • getChangesSinceRevisionForIds: gets changed items since the given revision, restricted by ID.
  • getCurrentRevisionInfo: gets the current revision information.
  • getCurrentState: gets the most recent version of all items within the given product.
  • getThemeById: finds a theme by its ID.
  • getUserByUserName: finds an user identified by login name.

» top

Methods removed
  • getTeam(Sprint), use getTeamById instead
  • moveTaskAfter, use moveTasksAfter instead
  • moveTaskIntoBacklogItem, use moveTasksIntoBacklogItem instead
  • markBacklogItemInactive, use deleteBacklogItem instead
  • moveBacklogItemAfter, use moveBacklogItemsAfter instead
  • moveBacklogItemIntoSprint, use moveBacklogItemsIntoSprint
  • moveBacklogItemIntoRelease, moveBacklogItemsIntoRelease, moveBacklogItemsIntoProductRelease are replaced with moveBacklogItemsIntoReleaseAndProduct
  • moveReleaseBefore, use moveReleaseBeforeInProduct
  • moveReleaseAfter, use moveReleaseAfterInProduct
  • createSprintWithNonWorkingDays, updateSprintWithNonWorkingDays, getSprintNonWorkingDays are removed because Sprint has the nonWorkingDays attribute
  • getPermissions
  • log

» top

Documentation Home | Web Client User Guide | Support and Training | ScrumWorks Desktop Client
Copyright © 2011 CollabNet, Inc. All rights reserved.