API Endpoint
{{apiUrl}}/api/v1/advancedTestPlan/bulk?projectKey={{projectKey}}
View or Run in Postman
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 Structure
1. Root Object
data (Array, Required)
A list of advanced test plans to be created in bulk.
2. Test Plan Object (data[])
Each item in the data array is a Test Plan object with the following fields:
name (String, Required)
Name of the advanced test plan.
Example: "Sprint 1 Test Plan"
startDate (String, Optional, Format: YYYY-MM-DD)
Start date of the test plan.
Example: "2025-03-26"
endDate (String, Optional, Format: YYYY-MM-DD)
End date of the test plan.
Example: "2025-04-10"
testPlanFolder (Object, Optional)
Parent folder where the advanced test plan will be created.
If not provided, the plan is created under the main repository folder.
identifier (String, Optional)
Unique identifier of the test plan folder.
Example:"4df41ddc-facf-11ef-892e-2e4c1a6a0f74"
requirements (Object, Optional)
Contains the assets you want to link to the advanced test plan.
requirements.issue (Array, Optional)
List of Jira issues to link.
Each item includes:
key (String, Required)
Jira issue key.
Example:"TF-1"
requirements.testFolder (Array, Optional)
List of test folders to link.
Each item includes:
identifier (String, Required)
Unique identifier of the test folder.
Example:"4df41ddc-facf-11ef-892e-2e4c1a6a0f74"
Example Request
{
"data": [
{
"name": "TEST-1",
"startDate": "2025-03-14",
"endDate": "2025-03-14",
"testPlanFolder": { },
"requirements": {
"issue": [ {"key": "TT-1"}, {"key": "TT-3"} ],
"testFolder": [ { "identifier": "4df41ddc-facf-11ef-892e-2e4c1a6a0f74" } ]
}
},
{
"name": "TEST-2",
"startDate": "2025-03-14",
"endDate": "2025-03-14",
"testPlanFolder": { },
"requirements": {
"issue": [ {"key": "TT-2"}, {"key": "TT-4"} ],
"testFolder": [ { "identifier": "4df41ddc-facf-11ef-892e-2e4c1a6a0f74" } ]
}
},
{
"name": "TEST-3",
"startDate": "2025-03-14",
"endDate": "2025-03-14",
"testPlanFolder": {},
"requirements": {
"issue": [ {"key": "TT-3"}, {"key": "TT-5"} ],
"testFolder": [ { "identifier": "4df41ddc-facf-11ef-892e-2e4c1a6a0f74" } ]
}
},
{
"name": "TEST-4",
"startDate": "2025-03-14",
"endDate": "2025-03-14",
"testPlanFolder": { },
"requirements": {
"issue": [ {"key": "TT-1"}, {"key": "TT-5"} ],
"testFolder": [ { "identifier": "4df41ddc-facf-11ef-892e-2e4c1a6a0f74" } ]
}
},
{
"name": "TEST-5",
"startDate": "2025-03-14",
"endDate": "2025-03-14",
"testPlanFolder": { },
"requirements": {
"issue": [ {"key": "TT-2"}, {"key": "TT-3"}, {"key": "TT-4"} ],
"testFolder": [ { "identifier": "4df41ddc-facf-11ef-892e-2e4c1a6a0f74" } ]
}
}
]
}
Example Response
{
"success": true,
"message": "Advanced Test Plan/s created successfully",
"data": [
{
"identifier": "0403a89d-0ac3-11f0-b619-a6332c493f52",
"name": "TEST-1",
"iterationIdentifier": "0404ecee-0ac3-11f0-b619-a6332c493f52",
"tpKey": "TT-P79"
},
{
"identifier": "04211097-0ac3-11f0-b619-a6332c493f52",
"name": "TEST-2",
"iterationIdentifier": "04220207-0ac3-11f0-b619-a6332c493f52",
"tpKey": "TT-P80"
},
{
"identifier": "043d03d8-0ac3-11f0-b619-a6332c493f52",
"name": "TEST-3",
"iterationIdentifier": "043df957-0ac3-11f0-b619-a6332c493f52",
"tpKey": "TT-P81"
},
{
"identifier": "045c154e-0ac3-11f0-b619-a6332c493f52",
"name": "TEST-4",
"iterationIdentifier": "045cf166-0ac3-11f0-b619-a6332c493f52",
"tpKey": "TT-P82"
},
{
"identifier": "0479aef3-0ac3-11f0-b619-a6332c493f52",
"name": "TEST-5",
"iterationIdentifier": "047aa77a-0ac3-11f0-b619-a6332c493f52",
"tpKey": "TT-P83"
}
]
}