SpiraPlan: REST Web Service (v5.0)

See all operations

POST: projects/{project_id}/test-runs/search?starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}

Description

Retrieves a list of test runs in the system that match the provided filter/sort

Doesn't include the test run steps

How to Execute

To access this REST web service, you need to use the following URL (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):

https://api.inflectra.com/spira/services/v5_0/RestService.svc/projects/{project_id}/test-runs/search?starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}

Request Parameters

Name Description
project_id The id of the current project
starting_row The first row to return (starting with 1)
number_of_rows The number of rows to return
sort_field The field we want to sort on
sort_direction The direction of the sorting (asc|desc)

Request Body

Property Description

Return Data

The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.

Property Description