API Endpoint
{{apiUrl}}/api/v1/advancedTestPlan/bulk?projectKey={{projectKey}}
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 test plan object includes the following properties as key-value pairs:
name(String, Required):Provide the name of the advanced test plan.
Example: "Sprint 1 Test Plan"startDate(String, Optional, Format: YYYY-MM-DD):Provide the start date of the advanced test plan.
Example: "2025-03-26"endDate(String, Optional, Format: YYYY-MM-DD):Provide the end date of the advanced test plan.
Example: "2025-04-10"testPlanFolder(Object, Optional):Provide parent folder identifier under which you want to create advanced test plan. When not provided, it will create advanced test plan under main repository folder.
identifier(String, Optional): Unique identifier of the advanced test plan folder.
Example: "4df41ddc-facf-11ef-892e-2e4c1a6a0f74"
requirements(Object, Optional):Provide details of the asset requirements you want under advanced test plan
issue(Array, Optional): Provide list of Jira issues you would like to link with advanced test plan.key(String, Optional): Issue key from Jira.
Example: "TF-1"
testFolder(Array, Optional): Provide list of test folders you want to link with advanced test plan.identifier(String, Optional): 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"
}
]
}