How to find all sprints in current project using VersionOne Rest API?

Question

Please share a sample REST API query to get the list of all sprints in a given project.

Thanks in advance.

Answer 1

To answer the question, you need to know the mapping of UI terms to underlying asset types. What you see as a sprint in the UI is known as a Timebox and what you see as a project is known as a Scope. You would also need to know that Timebox does not have a direct relationship to Scope. They are many-to-many through the sprint schedule known simply as Schedule in the API.

You can use the query.v1 endpoint to POST the following query:

from: Timebox
where:
  Schedule.ScheduledScopes.Name: The Desired Project

Or, using the rest-1.v1/Data endpoint, you can GET the following query:

<Server Base URI>/rest-1.v1/Data/Timebox?where=Schedule.ScheduledScopes.Name='The Desired Project'