See all operations

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

Description

Retrieves a single test set in the system

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/v7_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

Request Body

Nothing Expected

Nothing Expected

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	(Not used in this version of the API)
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
CreatorGuid	The guid of the creator.
OwnerGuid	The guid of the owner.
ReleaseId	The id of the release that the test set is assigned-to
ReleaseGuid	The guid of the release
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
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
TestSetFolderId	The ID of the test set folder this test set belongs to (NULL = root)
EstimatedDuration	The total estimated duration for all the test cases in this set
ActualDuration	The total actual duration for all the test cases in this set
IsAutoScheduled	Is this test set auto-scheduled when a build associated with the release runs
IsDynamic	Is this a dynamic test set
DynamicQuery	The underlying query if this is a dynamic test set
TestConfigurationSetId	The id of any test configuration set to be used with this test set
BuildExecuteTimeInterval	The interval between a build finishing and the test being execution (if auto-scheduled)
ProjectId	The id of the project that the artifact belongs to
ProjectGuid	The guid of the project that the artifact belongs to
ArtifactTypeId	The type of artifact that we have
ConcurrencyDate	The datetime used to track optimistic concurrency to prevent edit conflicts
CustomProperties	The list of associated custom properties/fields for this artifact
IsAttachments	Does this artifact have any attachments?
Tags	The list of meta-tags that should be associated with the artifact
Guid	The unique identifier for the artifact

<RemoteTestSet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
  <ArtifactTypeId>0</ArtifactTypeId>
  <ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
  <CustomProperties i:nil="true" />
  <Guid i:nil="true" />
  <IsAttachments>false</IsAttachments>
  <ProjectGuid i:nil="true" />
  <ProjectId>0</ProjectId>
  <Tags i:nil="true" />
  <ActualDuration i:nil="true" />
  <AutomationHostId i:nil="true" />
  <BuildExecuteTimeInterval i:nil="true" />
  <CountBlocked i:nil="true" />
  <CountCaution i:nil="true" />
  <CountFailed i:nil="true" />
  <CountNotApplicable i:nil="true" />
  <CountNotRun i:nil="true" />
  <CountPassed i:nil="true" />
  <CreationDate>0001-01-01T00:00:00</CreationDate>
  <CreatorGuid i:nil="true" />
  <CreatorId i:nil="true" />
  <CreatorName i:nil="true" />
  <Description i:nil="true" />
  <DynamicQuery i:nil="true" />
  <EstimatedDuration i:nil="true" />
  <ExecutionDate i:nil="true" />
  <IndentLevel i:nil="true" />
  <IsAutoScheduled>false</IsAutoScheduled>
  <IsDynamic>false</IsDynamic>
  <LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
  <Name i:nil="true" />
  <OwnerGuid i:nil="true" />
  <OwnerId i:nil="true" />
  <OwnerName i:nil="true" />
  <PlannedDate i:nil="true" />
  <ProjectName i:nil="true" />
  <RecurrenceId i:nil="true" />
  <RecurrenceName i:nil="true" />
  <ReleaseGuid i:nil="true" />
  <ReleaseId i:nil="true" />
  <ReleaseVersionNumber i:nil="true" />
  <TestConfigurationSetId i:nil="true" />
  <TestRunTypeId i:nil="true" />
  <TestSetFolderId i:nil="true" />
  <TestSetId i:nil="true" />
  <TestSetStatusId>0</TestSetStatusId>
  <TestSetStatusName i:nil="true" />
</RemoteTestSet>

{"TestSetId":null,
"IndentLevel":null,
"TestSetStatusId":0,
"CreatorId":null,
"OwnerId":null,
"CreatorGuid":null,
"OwnerGuid":null,
"ReleaseId":null,
"ReleaseGuid":null,
"AutomationHostId":null,
"TestRunTypeId":null,
"RecurrenceId":null,
"Name":null,
"Description":null,
"CreationDate":"0001-01-01T00:00:00",
"LastUpdateDate":"0001-01-01T00:00:00",
"PlannedDate":null,
"ExecutionDate":null,
"CountPassed":null,
"CountFailed":null,
"CountCaution":null,
"CountBlocked":null,
"CountNotRun":null,
"CountNotApplicable":null,
"CreatorName":null,
"OwnerName":null,
"ProjectName":null,
"TestSetStatusName":null,
"ReleaseVersionNumber":null,
"RecurrenceName":null,
"TestSetFolderId":null,
"EstimatedDuration":null,
"ActualDuration":null,
"IsAutoScheduled":false,
"IsDynamic":false,
"DynamicQuery":null,
"TestConfigurationSetId":null,
"BuildExecuteTimeInterval":null,
"ProjectId":0,
"ProjectGuid":null,
"ArtifactTypeId":0,
"ConcurrencyDate":"0001-01-01T00:00:00",
"CustomProperties":null,
"IsAttachments":false,
"Tags":null,
"Guid":null}