See all operations
POST: projects/{project_id}/test-folders
Description
Creates a new test case 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/v7_0/RestService.svc/projects/{project_id}/test-folders
Request Parameters
|
Name
|
Description
|
|
project_id
|
The id of the current project
|
Request Body
|
Property
|
Description
|
|
TestCaseFolderId
|
The id of the test case folder
|
|
Guid
|
The unique identifier for the artifact
|
|
ProjectId
|
The id of the project this folder belongs to
|
|
Name
|
The name of the test case folder
|
|
Description
|
The description of the test case folder
|
|
LastUpdateDate
|
The date the test case folder was last updated
|
|
ProjectName
|
The display name of the project that the test case folder belongs to
|
|
ParentTestCaseFolderId
|
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 cases in the folder
|
|
CountCaution
|
The count of blocked test cases in the folder
|
|
CountFailed
|
The count of blocked test cases in the folder
|
|
CountNotApplicable
|
The count of blocked test cases in the folder
|
|
CountNotRun
|
The count of blocked test cases in the folder
|
|
CountPassed
|
The count of blocked test cases in the folder
|
<RemoteTestCaseFolder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<ActualDuration i:nil="true" />
<CountBlocked>0</CountBlocked>
<CountCaution>0</CountCaution>
<CountFailed>0</CountFailed>
<CountNotApplicable>0</CountNotApplicable>
<CountNotRun>0</CountNotRun>
<CountPassed>0</CountPassed>
<Description i:nil="true" />
<EstimatedDuration i:nil="true" />
<ExecutionDate i:nil="true" />
<Guid i:nil="true" />
<IndentLevel i:nil="true" />
<LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
<Name i:nil="true" />
<ParentTestCaseFolderId i:nil="true" />
<ProjectId>0</ProjectId>
<ProjectName i:nil="true" />
<TestCaseFolderId i:nil="true" />
</RemoteTestCaseFolder>
{"TestCaseFolderId":null,
"Guid":null,
"ProjectId":0,
"IndentLevel":null,
"Name":null,
"Description":null,
"LastUpdateDate":"0001-01-01T00:00:00",
"ExecutionDate":null,
"EstimatedDuration":null,
"ProjectName":null,
"ParentTestCaseFolderId":null,
"ActualDuration":null,
"CountBlocked":0,
"CountCaution":0,
"CountFailed":0,
"CountNotApplicable":0,
"CountNotRun":0,
"CountPassed":0}
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
|
|
TestCaseFolderId
|
The id of the test case folder
|
|
Guid
|
The unique identifier for the artifact
|
|
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 case folder
|
|
Description
|
The description of the test case folder
|
|
LastUpdateDate
|
The date the test case folder was last updated
|
|
ExecutionDate
|
The date the test cases in the folder were last executed
|
|
EstimatedDuration
|
The estimated time to execute the test case
|
|
ProjectName
|
The display name of the project that the test case folder belongs to
|
|
ParentTestCaseFolderId
|
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 cases in the folder
|
|
CountCaution
|
The count of blocked test cases in the folder
|
|
CountFailed
|
The count of blocked test cases in the folder
|
|
CountNotApplicable
|
The count of blocked test cases in the folder
|
|
CountNotRun
|
The count of blocked test cases in the folder
|
|
CountPassed
|
The count of blocked test cases in the folder
|
<RemoteTestCaseFolder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<ActualDuration i:nil="true" />
<CountBlocked>0</CountBlocked>
<CountCaution>0</CountCaution>
<CountFailed>0</CountFailed>
<CountNotApplicable>0</CountNotApplicable>
<CountNotRun>0</CountNotRun>
<CountPassed>0</CountPassed>
<Description i:nil="true" />
<EstimatedDuration i:nil="true" />
<ExecutionDate i:nil="true" />
<Guid i:nil="true" />
<IndentLevel i:nil="true" />
<LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
<Name i:nil="true" />
<ParentTestCaseFolderId i:nil="true" />
<ProjectId>0</ProjectId>
<ProjectName i:nil="true" />
<TestCaseFolderId i:nil="true" />
</RemoteTestCaseFolder>
{"TestCaseFolderId":null,
"Guid":null,
"ProjectId":0,
"IndentLevel":null,
"Name":null,
"Description":null,
"LastUpdateDate":"0001-01-01T00:00:00",
"ExecutionDate":null,
"EstimatedDuration":null,
"ProjectName":null,
"ParentTestCaseFolderId":null,
"ActualDuration":null,
"CountBlocked":0,
"CountCaution":0,
"CountFailed":0,
"CountNotApplicable":0,
"CountNotRun":0,
"CountPassed":0}