….
Base URL, authentication, data formats
...
To create a new automation job, use the following this operation:
POST http://<zephyr-server-address>/flex/services/rest/v4/upload-file/automation/create-job-detail
Request data
The request body specifies proeprties of the job to be created.
Expand | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| The request body has an object with the following properties:
| |||||||||||||||||||||||||||||||||
|
...
The request body contains an object with the ids
property that is an array of job identifiers to be used for the run:. You can find this identifier in the response of the operation that created the automation job.
Code Block |
---|
{"ids":[1, 2, 3]} |
...
The following operation creates a new job and command commands the test engine to run it:
...
The request body specifies the name, project, release, cycle, and other properties of the created job. These are the same values described above.
Expand | ||
---|---|---|
| ||
|
Response data
If the operation succeeds, the response status is 200 OK
and the response body contains information on the scheduled run:
Expand | ||
---|---|---|
| ||
|
If the operation fails, it returns of the error codes.
Get job status
Use this operation:
GET http://<zephyr-server-address>/flex/services/rest/v4/upload-file/automation/schedule/get-latest-job-progress?jobid={ID}
Parameters
...
Request data and URL parameters
The request body is not used. The jobid
parameter in the URL specifies the identifier of the job whose status you
...
want to check. You get this identifier in the response to the operation that created the job.
Response data
If the operation succeeds, the response status is 200 OK
and the response body has information on the job and its cycle.
...
In case of an error, the operation returns one of the error codes.
Stop or cancel a job
To stop or canel a job, use Use the following operation:
POST http://{zephyr<zephyr-server-address}address>/flex/services/rest/v4/upload-file/automation/cancel/{ID}
Parameters
...
Request data and URL parameters
The request body is not used. The ID
parameter in the URL is the identifier of the scheduled run. You can find it in the response to the operation that scheduled the job run - it’s the id
property of the object in the response body.
...
The operation doesn’t use request body.
Response data
If the operation succeeds, the response status is 200 OK
and the response body contains true
.
If the operation fails, it returns one of the error codes.
Get job properties
Use the following operation to get properties of an automation job:
GET http://<zephyr-server-address>/flex/services/rest/v3/automation/job/detail?jobid={ID}
Request data and URL parameters
The request body is not used. The ID
jobid
parameter in the URL specifies the identifier of the desired job. You get this identifier in a response to the operation that created the job.
...
If the operation succeeded, the response status is 200 OK
and the response body contains information on the specified job.
...
POST http://<zephyr-server-address>/flex/services/rest/v4/upload-file/automation/update-execute-job
Request data
Response data
Get properties of several jobs
Use the following operation to get all job linked to the specified To specify new values of the job properties, you pass a JSON object in the request body. The id
property of this object specifies the job to be updated. You can get this ID in the response of the operation that created the automation job. Other properties of the object specify new values of the job properties. For information on them see above.
Expand | ||
---|---|---|
| ||
|
Response data
If the operation succeeds, the response status is 200 OK
, and the response body contains a JSON object with updated job properties.
If the operation fails, it returns of the error codes.
Get properties of several jobs
Use the following operation to get all job linked to the specified project and release:
GET http://{zephyr<zephyr-server-address}address>/flex/services/rest/v4/upload-file/automation/file-upload-job/list?projectId={projectID}&releaseId={releaseID}
Parameters
...
projectID
- Integer. The Jira identifier of the desired project (not the project key).
...
Request data and URL parameters
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 was successfulsucceeds, the response status is 200 OK
and the response body has a JSON array with information on all the found job jobs created for the specified project and release.
...
If the operation fails, it returns one of the error codes.
Delete a job
Use this operation:
...
The request body specifies the jobs to be deleted.
Request data
The request body contains identifiers of jobs to be deleted. These are identifiers you get for a job in the response to the request that created that job:
...