ScrumWorks Pro - Documentation

The ScrumWorks Pro API is a SOAP interface which allows you to access data in ScrumWorks in a safe way. Use the ScrumWorks Pro API for building custom reports, integrations, or other programmatic access to ScrumWorks Pro data; accessing the ScrumWorks Pro database directly may lead to unpredictable results and even data loss.

Starting in version 4.4, ScrumWorks Pro provides multiple versions of its SOAP API. If you are a current customer using the pre-4.4 version of the API, you can continue to use that version safely with a 6.2.0 ScrumWorks Pro installation. If you want to take advantage of the additional features the 6.2.0 version provides, follow the migration instructions below to use the new API.

Documentation - ScrumWorks Pro version 6.2.0

API Documentation - A list of all available methods and classes.
API Migration - The differences between this and the API in ScrumWorks Pro version 4.4 and between 4.3 and 4.4 ScrumWorks Pro versions.
The API can be accessed at http://servername:port/scrumworks-api/api2/scrumworks
The WSDL for the service is at http://servername:port/scrumworks-api/api2/scrumworks?wsdl
A set of Java classes is included with every ScrumWorks Pro server at <install_dir>/apiclient/ScrumWorks-soap.jar.
If you are using the provided ScrumWorks-soap.jar, use the class com.danube.scrumworks.api2.ScrumWorksService to create a connection to the API.

» top

Documentation - through ScrumWorks Pro version 4.3

API Documentation - A list of all available methods.
API Changes by Version - This resource provides a detailed list of changes to the ScrumWorks Pro SOAP by release.
The API can be accessed at http://servername:port/scrumworks-api/api1/scrumworks
The WSDL for the service is at http://servername:port/scrumworks-api/api1/scrumworks?wsdl
A set of Java classes is included with every ScrumWorks Pro server at <install_dir>/apiclient/ScrumWorks-soap.jar.

Our automated Java test for the API is included at <install_dir>/apiclient/TestScrumWorksService.java. This java file will not compile, as it is available purely as a reference example of how to call the services from Java code.

» top