Test Automation API Documentation
- Kevin Pham (Deactivated)
- Edward Stolyar (Deactivated)
Zephyr for Jira is now Zephyr Squad! Read more about this |
|---|
Prerequisites
Create a project and add the issue type Test to the project.
Retrieve an access key and a secret key. This can be done by navigating to the Zephyr menu and clicking on API keys.
Limitations
You cannot create test automation tasks for the Cucumber framework.
You cannot get the status of a single automation task.
ZBot jobs cannot be created through the API.
Test Automation API Details and Functions
- 1 Generate JWT Token
- 2 Create Automation Task
- 3 Execute Automation Task
- 4 Update Automation Task
- 5 Get Automation Task Status
- 6 Get All Automation Tasks
- 7 Delete Single Automation Task
- 8 Delete All Automation Tasks
- 9 Update Automation Task Status
- 10 Delete Multiple Automation Tasks at a Time
- 11 Get a Single Automation Task Information
- 12 Bulk Execute Automation Tasks
- 13 Save and Execute Automation Task
- 14 Update and Execute Automation Task
Generate JWT Token
Request URL: https://prod-vortexapi.zephyr4jiracloud.com/api/v1/jwt/generate
Request Header: Content-Type: application/json
Request Method: POST
Request Body:
{
"accessKey":"MDc0MzMwNDMtMTMyYi0zYTVjLWIwYzAtNjg2OTJiMTIwNDVjIDU1NzA1OCUzQWY0YTc5MzEyLTZhMmQtNDAxOS05ZDFlLTcwMTMyYTI2MWUyNiBVU0VSX0RFRkFVTFRfTkFNRQ",
"secretKey":"SwZP386jHYMADQMAsIX3ZgsO7BGjfYx6FxVWU6gdknM",
"accountId":"557058:f4a79312-6a2d-4019-9d1e-70132a261e26"
}Response Body:
JWT eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI1NTcwNTg6ZjRhNzkzMTItNmEyZC00MDE5LTlkMWUtNzAxMzJhMjYxZTI2IiwicXNoIjoiNzhmMDM2NzNjYWMzNDUxMjc5NDA5YTIyYjhmYWViNjFhNDQ1MzQzMDFiNDVhNDA0NGI2ODlmNmU1NjQwMzQzZCIsImlzcyI6Ik1EYzBNek13TkRNdE1UTXlZaTB6WVRWakxXSXdZekF0TmpnMk9USmlNVEl3TkRWaklEVTFOekExT0NVelFXWTBZVGM1TXpFeUxUWmhNbVF0TkRBeE9TMDVaREZsTFRjd01UTXlZVEkyTVdVeU5pQlZVMFZTWDBSRlJrRlZURlJmVGtGTlJRIiwiZXhwIjoxNTgyNTQ3MTk4LCJpYXQiOjE1ODI1NDM1OTh9.nwHTVBIsKQr1wQ_ppGDyf2UBoVxCwUfNx2iu8z_y2fECreate Automation Task
Request URL: https://prod-vortexapi.zephyr4jiracloud.com/api/v1/automation/job/create
Request Header: accessKey: {accessKey} / jwt: {jwt}
Request Method: POST
Request Body:
jobName:Job1
automationFramework:JUNIT
cycleName:Cycle1
folderName:Folder1
appendDateTimeInCycleName:true/false
appendDateTimeInFolderName:true/false
versionName:Unscheduled
projectKey:{projectKey}
cycleStartingDate:
cycleEndingDate:
createNewCycle:true/false
createNewFolder:true/false
file:result.zip
assigneeUser:assignee accountId
jobDescription:DescriptionsResponse Body:
Execute Automation Task
Request URL: https://prod-vortexapi.zephyr4jiracloud.com/api/v1/automation/job/execute
Request Header: accessKey: {accessKey} / jwt: {jwt}
Request Method: POST
Request Body:
Response Body:
Update Automation Task
Request URL: https://prod-vortexapi.zephyr4jiracloud.com/api/v1/automation/job/update
Request Header: accessKey: {accessKey} / jwt: {jwt}
Request Method: PUT
Request Body:
Response Body:
Get Automation Task Status
Request URL: https://prod-vortexapi.zephyr4jiracloud.com/api/v1/automation/job/status/{JobId}
Request Header: accessKey: {accessKey} / jwt: {jwt}
Request Method: GET
Request Body: N/A
Response Body:
Get All Automation Tasks
Request URL: https://prod-vortexapi.zephyr4jiracloud.com/api/v1/automation/job/list/{projectKey}
Request Header: accessKey: {accessKey} / jwt: {jwt}
Request Method: GET
Request Body: N/A
Response Body:
Delete Single Automation Task
Request URL: https://prod-vortexapi.zephyr4jiracloud.com/api/v1/automation/job/{jobId}
Request Header: accessKey: {accessKey} / jwt: {jwt}
Request Method: DELETE
Request Body: N/A
Response Body:
Delete All Automation Tasks
Request URL: https://prod-vortexapi.zephyr4jiracloud.com/api/v1/automation/job/delete/{projectKey}
Request Header: accessKey: {accessKey} / jwt: {jwt}
Request Method: DELETE
Request Body: N/A
Response Body:
Update Automation Task Status
Request URL: https://prod-vortexapi.zephyr4jiracloud.com/api/v1/automation/job/status
Request Header: accessKey: {accessKey} / jwt: {jwt}
Request Method: PUT
Request Body:
Response Body:
Delete Multiple Automation Tasks at a Time
Request URL: https://qabench-vortexapi.zephyr4jiracloud.com/api/v1/automation/delete/jobs
Request Header: accessKey: {accessKey} / jwt: {jwt}
Request Method: DELETE
Request Body:
Response Body:
Get a Single Automation Task Information
Request URL: https://qabench-vortexapi.zephyr4jiracloud.com/api/v1/automation/job/{jobId}
Request Header: accessKey: {accessKey} / jwt: {jwt}
Request Method: GET
Request Body: N/A
Response Body:
Bulk Execute Automation Tasks
Request URL: https://qacloud-vortexapi.zephyr4jiracloud.com/api/v1/automation/bulk/job/execute
Request Header: accessKey: {accessKey} / jwt: {jwt}
Request Method: POST
Request Body:
Response Body:
Save and Execute Automation Task
Request URL: https://qabench-vortexapi.zephyr4jiracloud.com/api/v1/automation/job/saveAndExecute
Request Header: accessKey: {accessKey} / jwt: {jwt}
Request Method: POST
Request Body:
Response Body:
Update and Execute Automation Task
Request URL: https://qabench-vortexapi.zephyr4jiracloud.com/api/v1/automation/job/updateAndExecute
Request Header: accessKey: {accessKey} / jwt: {jwt}
Request Method: PUT
Request Body:
Response Body:
See Also
Test Automation
Import Cucumber Test Results
Continuous Integration
Starting Release 8.2, Zephyr Enterprise documentation is moving from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise Documentation page. https://support.smartbear.com/zephyr-enterprise/docs/en/welcome-to-zephyr-enterprise.html