SpiraPlan: REST Web Service (v5.0)

See all operations

GET: projects/{project_id}/test-folders/{test_case_folder_id}/test-cases?starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}&release_id={release_id}

Description

Retrieves a list of test cases in the specified test case folder

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-folders/{test_case_folder_id}/test-cases?starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}&release_id={release_id}

Request Parameters

Name Description
project_id The id of the current project
test_case_folder_id The id of the test case folder (null = root folder)
starting_row The first row to return (starting with 1)
number_of_rows The number of rows to return
sort_field The field to sort by
sort_direction The sort direction [ASC|DESC]
release_id The id of the release the test cases were actually ran against, null = all releases

Request Body

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