RESTful APIs - part of Live API - provide the "crud" services for your resources:
- GET (read), including filters and sort
- POST (insert, one or multiple rows)
- PUT (update, one or multiple rows)
The diagram at right shows that you can use the REST Lab to test your API, without having to write a one-off test program.
The page below described some of the key services provided by the REST APIs that result from your Resource definitions.
This table introduces some of the main APIs. You can test these - without writing a program - in the REST Lab
(shown at right). You can find details about REST parameters here
, under the package
|| REST is usually an HTTP based protocol. This page describes how your projects' URLs are constructed
|| Retrieving Resources defined in the Logic Designer
|| Creating new resources
|| Updating existing resources
|| Delete existing resources
| Summary Information
|| Important summary information returned from Post, Put and Delete, including information to refresh page data and verify rule processing
| Error Handling
In addition to the REST Lab, you can review programs:
Several general principles are noted below.
Parameters vs. Headers
Request elements typically associated with headers can be supplied as parameters, to facilitate testing via browsers. For example, you can specify the api key as the auth parameter
Sub Resource Reference and Operation
Resources can consist of Sub Resources, typically for related data (the Lineitems contained in an Order, or the Product information for a LineItem). The API is designed so you can operate on Sub Resources
(e.g, update them), which you reference with a dot notation in your URL such as
A key goal of REST is to make your API discoverable by software. GET requests on base table resources return
"notes": "This is a small order",
"customer_name": "Alpha and Sons",
|https://eval.espressologic.com/rest/abl/admin/v2/@tables?projectId=1078&auth=vSrmIZxaAJA9StW2XTcy:1|| Returns a list of all the tables in a project (here, the eval LogicDemo project)
|| Returns a list of all the Resources in a project|
Note: the auth id above is not your usual projects' authorization. It is the admin apiKey, provided in your signup email.
Please see this page
for important URL parameters.