{{apiUrl}}/api/v1/run
Example Request
This API endpoint allows you to initiate a run in a Advance Test Plan with the specified parameters. See Collection
{
"asset": {
"type": "plannedRun", // Defines a planned test run
"key": "PVT-P13", // Test plan Key
"iteration": 1 // Iteration num{{apiUrl}}/api/{{nodeApiVersion}}/run
"testPlanAsset": {
"type": "folder", // Can be "folder" or "issue"
"folderPath": "checkautofolder/" // Folder path if type is "folder"
// "key": "PVT-1" // Issue key if type is "issue"
},
"case": {
"key": "PVT-C46" // Linked test case identifier
},
"properties": { // Optional test run details
"environment": { "name": "SYS" }, // Test environment
"release": { "name": "SYS" }, // Release version
"sprint": { "name": "PVT Sprint 1" } // Sprint name
},
"project": {
"key": "PVT" // Jira project key
}
}Example Response
The below response provides the test run key, which is required for subsequent API requests to update test steps, add results, or attach files.
{
"success": true,
"message": "A new Test Run created.",
"data": {
"run": {
"identifier": "a3043da4-e54b-11ee-aa9b556e442d",
"caseTestRunVersion": 5,
"key": 248,
"createdAt": 1738929849,
"updatedAt": 1738929849,
"createdBy": {
"jiraAccountId": "619dc36bd5906ad17b5e"
},
"updatedBy": {
"jiraAccountId": "619dc36bd506ad17b5e"
},
"logs": [],
"overallResult": {
"id": 3,
"name": "UNTESTED"
},
"properties": {
"environment": {
"identifier": "f59aa0d1-511ef-920e-4ea1f06aa7be",
"name": "SYS"
},
"release": null,
"sprint": {
"identifier": "ecb3cecd-91ef-bf2e-aa9b556e442d",
"name": "PVT Sprint 1",
"jiraID": 1
}
},
"asset": {
"identifier": "1ac470735-11ef-e-aa9b556e442d",
"name": "Testing Plan",
"type": "plannedRun",
"plannedRunIteration": {
"identifier": "1ac5e53a-5-11ef-bf2e-aa9b556e442d",
"key": 1,
"createdAt": 1738927043,
"testedAt": 1738929472,
"testedBy": {
"jiraAccountId": "6195986c006ad17b5e"
},
"overallResult": {
"id": 3,
"name": "UNTESTED"
},
"properties": {
"environment": null,
"release": null,
"sprint": null
}
}
}
}
}
}
HEADERS
Authorization
<vansahConnectToken>
Generate a Token from Vansah
Body raw (json)
{
"asset": {
"type": "plannedRun", // Defines a planned test run
"key": "PVT-P13", // Test plan Key
"iteration": 1 // Iteration number
},
"testPlanAsset": {
"type": "folder", // Can be "folder" or "issue"
"folderPath": "checkautofolder/" // Folder path if type is "folder"
// "key": "PVT-1" // Issue key if type is "issue"
},
"case": {
"key": "PVT-C46" // Linked test case identifier
},
"properties": { // Optional test run details
"environment": { "name": "SYS" }, // Test environment
"release": { "name": "SYS" }, // Release version
"sprint": { "name": "PVT Sprint 1" } // Sprint name
},
"project": {
"key": "PVT" // Jira project key
}
}