Rally lookback API Start Parameter

book

Article ID: 207656

calendar_today

Updated On:

Products

CA Agile Central SaaS (Rally)

Issue/Introduction

Could you please let me know why we might be seeing different behavior from the API? Specifically, why we were able to start our index at 1 before, and now must start it at 0?

The way Rally Lookback API has been providing the fetched records are changed in a way that the looping logic in the packages is required to handle the index 0 in order to download all the row counts successfully (it previously was able to download all the records successfully with index 1 to start).

 

Environment

Release : SAAS

Component : AGILE CENTRAL

Resolution

Please note for WSAPI:

The start index for queries begins at 1. The default is 1.

Example: start=1

https://rally1.rallydev.com/slm/doc/webservice/

For Lookback API:

The CA Agile Central Lookback API's start option is zero-indexed. This differs from Agile Central's ALM WSAPI parameter of the same name.

Example: start=0

https://rally1.rallydev.com/analytics/doc/#/manual