API Endpoint
{{apiUrl}}/api/v1/testFolder/bulk?projectKey={{projectKey}}
This api makes use of project key as a query parameter to create test folders in bulk.
HEADERS
To authenticate the API request, you need to provide the Vansah Connect Token that is generated from the Jira workspace's Vansah configuration page.
Authorization | {{vansahConnectToken}}
|
Request Body
data (Array, Required):
Provide list of test folders to create for any project
data[].name (String, Required):
Provide the name of the test folderExample:
"Sprint 1 Test Folder"
data[].type (String, Required):
The type of the test entity, which is"testfolder"in this case.Example:
"testfolder"
data[].linkedTestCases (Array of Strings, Optional):
Provide a list of test case identifiers that you want to link to the test folder. This field is optional when creating an empty test folder.Example:
["123e4567-e89b-12d3-a456-426614174000"]
data[].parentIdentifier (UUID, Optional):
Provide a global unique identifier of the parent test folder. Parent test folder is the folder under which you want to create sub-folder. This field is optional when creating a test folder under the main repository.Example:
"123e4567-e89b-12d3-a456-426614174000"
Example Request Body
{
"data": [
{
"name": "Unit Testing",
"linkedTestCases": ["TT-C1", "TF-C2"],
"type": "testfolder",
"parentIdentifier": "7829d1ab-008a-11f0-b619-a6332c493f52"
},
{
"name": "System Testing",
"linkedTestCases": ["TT-C1", "TF-C2"],
"type": "testfolder",
"parentIdentifier": "7829d1ab-008a-11f0-b619-a6332c493f52"
},
{
"name": "Integration Testing",
"linkedTestCases": ["TT-C1", "TF-C2"],
"type": "testfolder",
"parentIdentifier": "7829d1ab-008a-11f0-b619-a6332c493f52"
},
{
"name": "Regression Testing",
"linkedTestCases": ["TT-C1", "TF-C2"],
"type": "testfolder",
"parentIdentifier": "7829d1ab-008a-11f0-b619-a6332c493f52"
}
]
}
Example Response Body
{
"success": true,
"message": "Bulk Test Folder/s created successfully",
"data": [
{
"name": "Unit Testing",
"identifier": "18843677-037b-11f0-b619-a6332c493f52"
},
{
"name": "System Testing",
"identifier": "187a5cc8-037b-11f0-b619-a6332c493f52"
},
{
"name": "Integration Testing",
"identifier": "18842905-037b-11f0-b619-a6332c493f52"
},
{
"name": "Regression Testing",
"identifier": "18829f87-037b-11f0-b619-a6332c493f52"
}
]
}