SpiraTeam: REST Web Service (v4.0)

See all operations

POST: projects/{project_id}/test-folders?parent_test_folder_id={parent_test_folder_id}

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:

http://api.inflectra.com/Spira/Services/v4_0/RestService.svc/projects/{project_id}/test-folders?parent_test_folder_id={parent_test_folder_id}

Request Parameters

Name Description
project_id The id of the current project
parent_test_folder_id Do we want to insert the test case under a parent folder

Request Body

Property Description
TestCaseId The id of the test case
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.)
ExecutionStatusId The execution status id of the test case
AuthorId The id of the user that wrote the test case The authenticated user is used if no value is provided
OwnerId The id of the user that the test case is assigned-to
TestCasePriorityId The id of the priority of the test case
AutomationEngineId The id of the automation engine the associated test script uses (null if manual only)
AutomationAttachmentId The id of the attachment that is being used to store the test script (file or url) Null if manual only
Name The name of the test case
Description The description of the test case
CreationDate The date the test case was created
LastUpdateDate The date the test case was last updated
ExecutionDate The date the test case was last executed
EstimatedDuration The estimated time to execute the test case
Folder Whether this is actually a test case folder or not
Active Whether this test case is marked as active or not
AuthorName The display name of the user that wrote the test case
OwnerName The display name of the user that the test case is assigned-to
ProjectName The display name of the project that the test case belongs to
TestCasePriorityName The display name of the priority of the test case
TestSteps The list of test steps that comprise the test case
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

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
TestCaseId The id of the test case
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.)
ExecutionStatusId The execution status id of the test case
AuthorId The id of the user that wrote the test case The authenticated user is used if no value is provided
OwnerId The id of the user that the test case is assigned-to
TestCasePriorityId The id of the priority of the test case
AutomationEngineId The id of the automation engine the associated test script uses (null if manual only)
AutomationAttachmentId The id of the attachment that is being used to store the test script (file or url) Null if manual only
Name The name of the test case
Description The description of the test case
CreationDate The date the test case was created
LastUpdateDate The date the test case was last updated
ExecutionDate The date the test case was last executed
EstimatedDuration The estimated time to execute the test case
Folder Whether this is actually a test case folder or not
Active Whether this test case is marked as active or not
AuthorName The display name of the user that wrote the test case
OwnerName The display name of the user that the test case is assigned-to
ProjectName The display name of the project that the test case belongs to
TestCasePriorityName The display name of the priority of the test case
TestSteps The list of test steps that comprise the test case
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