| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-user-guide/zephyr-test-automation/api-operations-for-automation-jobs.html |
Base URL, authentication, data formats
The operations described below work for both Cloud and On-Premise instances of Zephyr Enterprise. They use the same authentication parameters and data formats that other Zephyr API operations use. For complete information on these, see Zephyr REST API.
Respose codes
The API operations described below use the following response codes:
Response code | Description |
|---|---|
200 | The operation has been completed successfully. |
400 | Error in request data or parameters. For instance, the project or job with the specified id doesn’t exist. |
401 | Authentication error (authentication token is missing). |
403 | Error. You don’t have permissions to perform this operation. |
500 | Internal server error. |
Create an automation job
To create a new automation job, use this operation:
...
The request body is not used. The URL has the following parameters:
Parameter | Description | |||||
|---|---|---|---|---|---|---|
| Integer. The Jira identifier of the desired project (not the project key).
| |||||
| Integer. The Jira identifier of the desired release in that project.
|
Response data
If the operation succeeds, the response status is 200 OK and the response body has a JSON array with information on all the jobs created for the specified project and release.
...
The operation returns 200 OK, if the job or jobs have been deleted successfully. In case of an error, the operation returns one of the error codes.
See Also
ZBot Overview
Script Automation
Suite Automation
Folder Watcher
Create and Manage API Tokens in Zephyr