Rally - LBAPI: How to use Lookback API to find artifacts that were part of a deleted Timebox

Products

• Rally SaaS

Issue/Introduction

If a user accidentally deletes a timebox such as a release or an iteration, it can be difficult to know the work items that were affected.  This article shows a method to generate a list of the artifacts that were associated with that timebox.

Environment

Release : SAAS

Component : AGILE CENTRAL

Resolution

The following steps are intended for the Chrome browser, however they may be adapted for other browsers with advanced request diagnostics like Firefox.

Install the Lookback API Query custom app here

A video walkthrough is available to show how to install a custom app here

Next, you will need to browse to a work item that was associated with the timebox

Get the Object ID from the URL as shown in the example below:

https://rally1.rallydev.com/#/198278166556/detail/defect/<DEFECT_OID>

Paste the following query into the query field of your Lookback API tool, substituting the object ID from the above step:

{
   "ObjectID":{$in:[<DEFECT_OID>]}
}

 

Set Fields value to  true

Open Developer Tools and click the Network tab

Click Search on the Lookback API Query tool

Go back to the Developer Tools window and look for a line that stars with query.js

Click this entry and click the Preview tab

Expand the Results collection.  There may be multiple numerically sequential entries listed here. 

Expanding the last entry and then expand the _PreviousValues collection to look for a reference to Release or Iteration as applicable.  If no Release or Iteration entry is listed under _PreviousValues, continue expanding the numeric sequences from bottom to top and looking in the _PreviousValues of each one until you find a reference.

Example:

"_PreviousValues": {
    "Release": <RELEASE_OID>
}

Once you find a reference, get that Release/Iteration Object ID

Now go back to the Lookback API Query app and modify the Query as follows, substituting your object ID from above.  Set the date field to a period of time just before the timebox was deleted in the _ValidFrom parameter:

{
    "_PreviousValues.Release": <RELEASE_OID>,
    "_ValidFrom": { "$gte": "2020-01" }
}

Set the Fields value to FormattedID
Click Search

This listed all items that were part of that deleted timebox