Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: First published version

...

To use the REST API your application will make an HTTP request and then parse the response which may include a payload as well as a status indicating if the request was succeedfulsuccessful.

Enterprise Tester's API uses JSON (JavaScript Object Notation) as the default format for its entities, and standard HTTP methods such as GET, POST, PUT and DELETE (Analogous to Read, Create, Update and Delete i.e. CRUD) to perform actions on those entities. Note: Not all resources support all HTTP methods, see the Resources list for a description of each resource, the methods it supports, and whether TQL or OData querying methods are supported.

...

We also have a section where common features of the API are discussed, which can provide useful background information for those trying to develop against the Enterprise Tester API.

We have also posted some tips and guides on how to use the API on the Catch Software Blogs.

Advanced API Users

This section is for advanced users who have a strong knowledge of Enterprise Tester and how REST API's work. For further assistance, we recommend reading through the Resources list, to get started with the API.

The sample script here, is written in node js and can be configured to create and update Automated tests in Enterprise Tester from end-to-end that suit your use case. Please note this has sample data only and requires you to make updates to suit your requirements. 

Feedback

We would love to hear your feedback and feature requests on the API - Catch Software are working hard to make it as easy as possible to extend Enterprise Tester. Get in touch with our Support Team, we would love to hear how you are using the API, what's worked well and what could be improved.