SpiraTeam: REST Web Service (v4.0)

See all operations

GET: projects/{project_id}/test-sets/{test_set_id}

Description

Retrieves a single test set/folder in the system

How to Execute

To access this REST web service, you need to use the following URL:

http://api.inflectra.com/Spira/Services/v4_0/RestService.svc/projects/{project_id}/test-sets/{test_set_id}

Request Parameters

Name Description
project_id The id of the current project
test_set_id The id of the test set/folder

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
TestSetId The id of the test set
IndentLevel The indentation level of the artifact The system uses a set of three-letter segments to denote indent (e.g. AAA followed by AAB, etc.)
TestSetStatusId The id of the test set's status
CreatorId The id of the user who created the test set If no value is provided, the authenticated user is used
OwnerId The id of the user who the test set is assigned-to
ReleaseId The id of the release that the test set is assigned-to
AutomationHostId The id of the automation host the test set is assigned-to
TestRunTypeId The id of the type of test set (1 = Manual, 2 = Automated)
RecurrenceId The id of the recurrence pattern the test set is scheduled for
Name The name of the test set
Description The detailed description of the test set
CreationDate The date the test set was originally created
LastUpdateDate The date the test set was last modified
PlannedDate The date that the test set needs is planned to be executed on
ExecutionDate The date that the test set was last executed by a tester
Folder Is this test set actually a folder
CountPassed How many passed test cases are in the set
CountFailed How many failed test cases are in the set
CountCaution How many cautioned test cases are in the set
CountBlocked How many blocked test cases are in the set
CountNotRun How many test cases in the set have not been run
CountNotApplicable How many test cases in the set are not applicable
CreatorName The display name of the user that created the test set
OwnerName The display name of the user that the test set is assigned-to
ProjectName The display name of the project that the test set belongs to
TestSetStatusName The display name of the status of the test set
ReleaseVersionNumber The version number of the release the test set is scheduled for
RecurrenceName The display name of the recurrence pattern
ProjectId The id of the project that the artifact belongs to The current project is always used for Insert operations for security reasons
ArtifactTypeId The type of artifact that we have (read-only)
ConcurrencyDate The datetime used to track optimistic concurrency to prevent edit conflicts
CustomProperties The list of associated custom properties/fields for this artifact