Do the Rally toolkits hydrate the results upon fetching?

Products

• Rally SaaS
• Rally On-Premise

Issue/Introduction

Do the Rally toolkits hydrate the results upon fetching the resultset?

Environment

Release : SAAS

Component : API FOR AGILE CENTRAL

Resolution

Yes, the Rally toolkits download all requested data from the API during their GET phases.  It is not necessary to iterate the results in order to fetch details about the objects.

For example, using the Pyral for Python toolkit, the following line will perform an unbounded request for user stories (Hierarchical Requirements) to the API 

stories = rally.get('HierarchicalRequirement', fetch='ObjectID,Name,FormattedID', pagesize=100)

If we set a breakpoint immediately after this line, we can examine the stack as shown in the screenshot below:

As the screenshot shows, the requested details of this fetch are already present in a dictionary.  Therefore there is no need to fetch any further data and processing can be performed directly on this data.