Date: Thu, 28 Mar 2024 20:46:55 +0000 (UTC) Message-ID: <1896295500.9717.1711658815209@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_9716_1044863969.1711658815209" ------=_Part_9716_1044863969.1711658815209 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Enterprise Tester provides a REST= API (Application Programm= ing Interface) that can be used for retrieving and manipulating Enterprise = Tester data without having to interact with the user interface.
There are many use cases for the API, but some common examples include:<= /p>
The REST API is based on open standards, and you can use any web develop= ment language to access the API, or a tool such as CURL to make simple requ= ests.
Enterprise Tester's REST API provides a way for applications to access r= esources (Entities) via a URI (Uniform Resource Identifier) e.g. a path.
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 indicati= ng if the request was succeedful.
Enterprise Tester's API uses JSON (JavaScript Object Notation) as the= default format for its entities, and standard HTTP methods such as GET, PO= ST, 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 lis= t for a description of each resource, the methods it supports, and whether = TQL or OData querying methods are supported.
Enterprise Testers URIs have the following structure:
http://host:port/applicationpath/api/resource-name
In the resource help topics the URI templates are displayed like so:
/api/project/{id}
Values surrounded by braces (such as {id} above) are pa= rameter substitutions, where this part of the URI would be replaced with an= appropriate value. All URI's already include the required /api fragment as= well, and the examples included with each method supported by a resource s= how these parameters with example values.
So for a local instance of Enterprise Tester, to GET the details of a si= ngle project you would take the template above, replace the ID parameter, a= nd prepend the site's base path (also called the application path, or site.= root.url in the Enterprise Tester documentation) - after which you may end = up with a URI that looks like this:
http://localhost/EnterpriseTester/api/project/a1d44feb-01b5-4f85-a18d-= a03f00be87f6
There is no specific permission required to use the API - Any Enterprise= Tester user can access the API, but the features they can use will be limi= ted by the permissions they have been granted. Each Resource topic lists th= e necessary permissions (if any) required to access the resource, and a sum= mary of all resources with associated permissions required for each HTTP me= thod are available in the Permissions topic.
To get started with the API, please refer to the Resources list, this provides the list of Resources (Entit= ies) currently exposed, along with the methods they support and examples of= requests and responses, including parameters, headers and status codes.
We also have a section where common f= eatures of the API are discussed, which can provide useful background i= nformation for those trying to develop against the Enterprise Tester API.= p>
We have also posted some tips and guides on how to use = the API on the Catch Software Blogs.
We would love to hear your feedback and feature requests on the API - Catch Softwa= re are working hard to make it as easy as possible to extend Enterprise Tes= ter. Get in touch with our Support Team, we would love to he= ar how you are using the API, what's worked well and what could be improved= .