See all operations
POST: projects/{project_id}/test-folders/{test_case_folder_id}/test-cases/search?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 testCases in the system that match the provided filter
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/search?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, null = all releases
|
Request Body
<ArrayOfRemoteFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v5_0.DataObjects">
<RemoteFilter>
<DateRangeValue i:nil="true" />
<IntValue i:nil="true" />
<MultiValue i:nil="true" />
<PropertyName i:nil="true" />
<StringValue i:nil="true" />
</RemoteFilter>
</ArrayOfRemoteFilter>
[{"DateRangeValue":null,
"IntValue":null,
"MultiValue":null,
"PropertyName":null,
"StringValue":null}]
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.
<ArrayOfRemoteTestCase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v5_0.DataObjects">
<RemoteTestCase>
<ArtifactTypeId>0</ArtifactTypeId>
<ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
<CustomProperties i:nil="true" />
<IsAttachments>false</IsAttachments>
<ProjectId i:nil="true" />
<ActualDuration i:nil="true" />
<AuthorId i:nil="true" />
<AuthorName i:nil="true" />
<AutomationAttachmentId i:nil="true" />
<AutomationEngineId i:nil="true" />
<ComponentIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<CreationDate>0001-01-01T00:00:00</CreationDate>
<Description i:nil="true" />
<EstimatedDuration i:nil="true" />
<ExecutionDate i:nil="true" />
<ExecutionStatusId i:nil="true" />
<ExecutionStatusName i:nil="true" />
<IsSuspect>false</IsSuspect>
<IsTestSteps>false</IsTestSteps>
<LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
<Name i:nil="true" />
<OwnerId i:nil="true" />
<OwnerName i:nil="true" />
<ProjectName i:nil="true" />
<TestCaseFolderId i:nil="true" />
<TestCaseId i:nil="true" />
<TestCasePriorityId i:nil="true" />
<TestCasePriorityName i:nil="true" />
<TestCaseStatusId>0</TestCaseStatusId>
<TestCaseStatusName i:nil="true" />
<TestCaseTypeId>0</TestCaseTypeId>
<TestCaseTypeName i:nil="true" />
<TestSteps i:nil="true" />
</RemoteTestCase>
</ArrayOfRemoteTestCase>
[{"ArtifactTypeId":0,
"ConcurrencyDate":"\/Date(-62135578800000-0500)\/",
"CustomProperties":null,
"IsAttachments":false,
"ProjectId":null,
"ActualDuration":null,
"AuthorId":null,
"AuthorName":null,
"AutomationAttachmentId":null,
"AutomationEngineId":null,
"ComponentIds":null,
"CreationDate":"\/Date(-62135578800000-0500)\/",
"Description":null,
"EstimatedDuration":null,
"ExecutionDate":null,
"ExecutionStatusId":null,
"ExecutionStatusName":null,
"IsSuspect":false,
"IsTestSteps":false,
"LastUpdateDate":"\/Date(-62135578800000-0500)\/",
"Name":null,
"OwnerId":null,
"OwnerName":null,
"ProjectName":null,
"TestCaseFolderId":null,
"TestCaseId":null,
"TestCasePriorityId":null,
"TestCasePriorityName":null,
"TestCaseStatusId":0,
"TestCaseStatusName":null,
"TestCaseTypeId":0,
"TestCaseTypeName":null,
"TestSteps":null}]