API Changes for Release 6.2.0
In order to add new features or improve existing ones, sometimes the API needs to change. The changes between each version are outlined below.
Quick Links
Version 3.0.0
  • ScrumWorksEndpoint
  • ProductWSO
Version 3.0.1
  • ScrumWorksEndpoint
  • ProductWSO
Version 3.1.0
  • ScrumWorksEndpoint
Version 3.1.1
    Version 3.1.2
      Version 3.2.0
        Version 3.3.0
        • ImpedimentWSO
        Version 3.3.1
          Version 4.0.0
          • ScrumWorksEndpoint
          • BacklogItemWSO
          • ReleaseWSO
          • ProductWSO
          Version 4.1.0
          • ScrumWorksEndpoint
          • ProgramWSO
          • EpicWSO
          • BacklogItemWSO
          • ThemeWSO
          • ProgramThemeWSO
          • UncategorizedBudgetWSO
          • BudgetWSO
          Version 4.2.0
          • TaskWSO
          Version 4.3.0
          • CommentWSO
          • Comment Methods
          Version 4.4.0

            API Documentation

            Documentation Home

            Version 3.0.0

            ScrumWorksEndpoint

            Method added: getSprintsForTeam(ProductWSO product, TeamWSO team)

            Method added: getTeam(SprintWSO sprint)

            Method added: getTimeZone()

            » top

            ProductWSO
            Field removed: roiDecimalPlaces. This is now a fixed value, not a product property.

            » top

            Version 3.0.1

            ScrumWorksEndpoint
            Method added: getTeams(ProductWSO product)

            » top

            ProductWSO
            Field removed: teams. Improve scalability of the ScrumWorks Pro server.

            » top

            Version 3.1.0

            ScrumWorksEndpoint

            Method added: createSprintWithNonWorkingDays(SprintWSO sprint, java.lang.Long[] nonWorkingDays)

            Method added: getSprintNonWorkingDays(java.lang.Long sprintId)

            Method added: updateSprintWithNonWorkingDays(SprintWSO sprint, java.lang.Long[] nonWorkingDays)

            Method renamed: getTeams(ProductWSO) is now getTeamsForProduct(ProductWSO product)

            » top

            Version 3.1.1

            No changes.

            Version 3.1.2

            No changes.

            Version 3.2.0

            No changes.

            Version 3.3.0

            ImpedimentWSO
            Field added: productId. The ID of the Product the Impediment belongs to.

            » top

            Version 3.3.1

            No changes.

            Version 4.0.0

            ScrumWorksEndpoint

            Method changed: createRelease uses ReleaseWSO.productId to determine where to create the Release.

            Method added: getVersion So the version number of the ScrumWorks Pro server can be determined programatically.

            » top

            BacklogItemWSO
            Field changed: themes. Contains the list of product themes and program themes the Backlog Item is associated with.

            » top

            ReleaseWSO

            Field added: archived. Used to archive and restore releases. The last visible release cannot be archived. BacklogItems cannot be moved to archived releases. Archived releases cannot be modified except to restore them.

            Field added: productId. The ID of the Product the Release belongs to.

            Field added: programId. The ID of the Program the Release belongs to. For now, set this value to NULL. This version of the API does not support Releases belonging to Programs.

            Field added: description. The description for a Release belonging to a Program. For now, set this value to NULL. This version of the API does not support creation of a Release belonging to a Program.

            Field removed: rank. To rank a Release use moveReleaseAfter or moveReleaseBefore .

            » top

            ProductWSO
            Field removed: programId. Removed because Products can now belong to multiple Programs. Programs are not yet supported via the API.

            » top

            Version 4.1.0

            ScrumWorksEndpoint

            Convenience

            Method added: getTaskById

            Method added: getImpedimentById

            Method added: getTaskStatuses

            Method added: getProductByName

            Themes

            Method deleted: getBacklogItemsForTheme - This method is replaced by getActiveBacklogItemsForTheme

            Method modified: getActiveBacklogItemsForTheme. gets the active Backlog Items associated with the Product or Program Theme.

            Method added: getActiveBacklogItemsForThemeInProduct.

            Method added: getActiveBacklogItemsForReleaseInProduct

            Method modified: getThemes The method now returns all the Product Themes and Program Themes in the Product. However, you should now use the new getThemesForProduct() method which does the same thing.

            Method added: getThemesForProduct Replaces getThemes, which is still retained for backwards compatibility.

            Method modified: createTheme This method may now be used to create program themes.

            Method modified: deleteTheme This method may now be used to delete program themes.

            Method modified: renameTheme This method may now be used to rename program themes.

            Releases:

            Method modified: moveBacklogItemsIntoRelease Moves backlog items into a product or a program release in a product. Added parameter to specify the product which the release is in. Old functionality is retained by using moveBacklogItemsIntoProductRelease.

            Method added: moveBacklogItemsIntoProductRelease

            Method modified: createRelease This method may now be used to create program releases.

            Method added: moveReleaseBeforeInProduct

            Method added: moveReleaseAfterInProduct

            Programs:

            Method added: getPrograms

            Method added: getProgramById

            Method added: getReleasesForProgram

            Method added: getThemesForProgram

            Epics:

            Method added: getEpicsForRelease

            Method added: getEpicsForReleaseInProduct

            Method added: getProductEpicsForProgramEpic

            Uncategorized Budgets:

            Method added: getUncategorizedBudgetsForRelease

            Method added: getUncategorizedBudgetForReleaseInProduct

            » top

            ProgramWSO

            Class added.

            Purpose: Represents Programs.

            Fields:

            • id: The Program's ID.
            • name: The name of the Program.
            • description: The description of the Program.
            • products: The products included in the Program.

            » top

            EpicWSO

            Class added.

            Purpose: Represents Epics.

            Fields:

            • id: The Epic's ID.
            • release: The Product or Program Release the Epic belongs to.
            • theme: The Theme the Epic represents.
            • description: The description of the Epic.
            • budget (optional): For Epics in a Product, this is the budget value associated with the epic.

            » top

            BacklogItemWSO

            Field added: productId. The ID of the Product the Backlog Item belongs to.

            Field removed: programThemes. Themes have been consolidated into one field.

            Constructor removed: The constructor that took both ThemeWSO and ProgramThemeWSO arrays has been removed. Add any themes for the Backlog Item to the single parameter in the remaining constructor.

            » top

            ThemeWSO
            • Field added: programId. The ID of the Program the theme belongs to, or null for product themes.
            • Field added: productId. The ID of the Product the theme belongs to, or null for program themes.
            Only one of programId or productId may be specified.

            » top

            ProgramThemeWSO
            Class deleted. All Themes are represented by ThemeWSO.

            » top

            UncategorizedBudgetWSO

            Class added.

            Purpose: Represents Uncategorized Budgets.

            Fields:

            • release: The Product or Program Release the Uncategorized Budget belongs to.
            • budget: The Budget for a particular Product.

            » top

            BudgetWSO

            Class added.

            Purpose: Represents Budgets.

            Fields:

            • product: The Product the Budget belongs to.
            • budget: The budget value, or null if no budget has been set.

            » top

            Version 4.2.0

            TaskWSO
            Field changed: estimatedHours. Changed from int to Integer. Set to null for unestimated.

            » top

            Version 4.3.0

            CommentWSO

            Class added.

            Purpose: Represents comments which may be added to tasks or backlog items.

            Fields:

            • text: The comment text.
            • user: The user who made the comment.
            • timestamp: The time and date the comment was made.

            » top

            Comment Methods

            Methods added:

            • getCommentsForBacklogItem
            • getCommentsForTask
            • createCommentForBacklogItem
            • createCommentForTask

            » top

            Version 4.4.0

            Starting with ScrumWorks version 4.4, the changes to the API will result in new endpoints. Please see the main api documentation for instructions on how to access the new API.
            Documentation Home | Web Client User Guide | Support and Training | ScrumWorks Desktop Client
            Copyright © 2013 CollabNet, Inc. All rights reserved.