Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

projectID

Integer. The Jira identifier of the desired project (not the project key).

Expand
titleHow to get the project id

Log in to Zephyr, and select your project from the drop-down list on the top. You will see the project id in the URL:

Image Modified

releaseID

Integer. The Jira identifier of the desired release in that project.

Expand
titleHow to get the release id

Log in to Zephyr and select your project and release from the drop-down lists on the top. You will see the release id in the URL:

Image Modified

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