SpiraPlan: REST Web Service (v5.0)

See all operations

POST: projects/{project_id}/test-set-folders

Description

Creates a new test set folder 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/v5_0/RestService.svc/projects/{project_id}/test-set-folders

Request Parameters

Name Description
project_id The id of the current project

Request Body

Property Description
TestSetFolderId The id of the test set folder
ProjectId The id of the project this folder belongs to
Name The name of the test set folder
Description The description of the test set folder
CreationDate The date the test set folder was created
LastUpdateDate The date the test set folder was last updated
ProjectName The display name of the project that the test set folder belongs to
ParentTestSetFolderId The ID of the parent folder of this folder (if any)
ActualDuration The actual duration of all the tests in the folder
CountBlocked The count of blocked test sets in the folder
CountCaution The count of blocked test sets in the folder
CountFailed The count of blocked test sets in the folder
CountNotApplicable The count of blocked test sets in the folder
CountNotRun The count of blocked test sets in the folder
CountPassed The count of blocked test sets in the folder

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
TestSetFolderId The id of the test set folder
ProjectId The id of the project this folder belongs to
IndentLevel The indentation level of the folder The system uses a set of three-letter segments to denote indent (e.g. AAA followed by AAB, etc.)
Name The name of the test set folder
Description The description of the test set folder
CreationDate The date the test set folder was created
LastUpdateDate The date the test set folder was last updated
ExecutionDate The date the test sets in the folder were last executed
EstimatedDuration The estimated time to execute the test set
ProjectName The display name of the project that the test set folder belongs to
ParentTestSetFolderId The ID of the parent folder of this folder (if any)
ActualDuration The actual duration of all the tests in the folder
CountBlocked The count of blocked test sets in the folder
CountCaution The count of blocked test sets in the folder
CountFailed The count of blocked test sets in the folder
CountNotApplicable The count of blocked test sets in the folder
CountNotRun The count of blocked test sets in the folder
CountPassed The count of blocked test sets in the folder