Skip to content
22 November 2026

Rally documentation guide and Web Services API explained

Rally's documentation covers everything from setup to reporting, and its Web Services API has specific rules for linking defects and other objects.

Rally documentation guide and Web Services API explained

Rally, the tool that Agile teams use to refine, plan and track their work, publishes its documentation as a set of sections. The landing page lists quarterly release notes that describe new features, changes and defect fixes, along with a set of guides for users, administrators and developers. A separate reference section documents the Web Services API, usually called WSAPI, which lets software read and change Rally data.

What the Rally documentation covers

The Getting Started section introduces the main functions of Rally, explains setup and links to learning resources. Administrators use the Administration section to configure their subscription and to set up workspaces, projects and users for their organization. The Using Rally section gives an overview of features, pages and shortcuts, while the Planning and Tracking sections describe the processes and tools that teams use to move work from design to delivery.

Other sections cover more specific needs. Testing explains how to manage defects, defect suites and tests. Managing Portfolio Items shows how to build higher-level roadmaps with portfolio items, which represent initiatives or features. Configuring Custom Views explains how to group widgets into a customized display, and Reporting describes the charts used to follow team progress. The Integrating with Rally section covers connections to defect trackers, IDEs and testing tools. For organizations that need an on-premise setup, Rally Anywhere is the version that runs inside the customer’s own IT environment. The documentation also states that CA Technologies, a Broadcom Company, obtained Authorization to Operate status for federal agencies, and that Rally is FedRAMP authorized.

How WSAPI handles linked defects

According to the API documentation, WSAPI manipulates one object at a time. The example given is two defects, where defect A is marked as a duplicate of defect B. This can be done in two ways. In the first, the user creates defect A, creates defect B, and then updates defect A to add defect B as a duplicate. In the second, the user creates defect B first, then creates defect A with defect B already in its duplicates list.

The order matters because any referenced object must exist before it can be referenced. Defect A cannot be created with a description of defect B in its duplicates list until defect B has been created.

Reference objects and full objects

A reference object is a key and value pair in which the key is _ref and the value is a metalink to the full object. The metalink returns either the object itself, such as a Defect or a Hierarchical Requirement, or a collection of objects, such as a list of child defects. The documentation gives a Defects reference with the fields _rallyAPIMajor set to 2, _rallyAPIMinor set to 0, and _type set to Defects. To fetch the children of a Hierarchical Requirement, developers use a URL built from the Hierarchical Requirement path and its ObjectID.

Developers who script against Rally should check the reference section before they create linked objects, and should check the quarterly release notes for changes to features and defect fixes.

Author

Florence Wright

Florence Wright, Glasgow native with an editorial-minimal aesthetic, rerouted a social feed to live-cover a Pollok Park remembrance event, prioritising human detail over algorithmic reach. Promotes clarity, humane framing and local resonance; keeps an archive of Polaroids from neighbourhood gatherings as a personal emblem.