Consumable Rest Api

Creating a new Consumable REST API

To create a new web service, do as follows:

• Open the folder for the application to which you want to add the web service.
  This is done from the Repository window.
• Select the folder "Consumable Rest Api" which is a subfolder of "Web Services" and insert a new web service.
  This can be done by right-clicking on the selected (sub)folder and choosing "Insert Consumable REST API" from the popup-menu. A dialog box will be displayed:
  
  
  
  
• Specify the parameters for the Consumable REST API in the displayed dialog box.
  Click "OK" to add the web service, and to define its settings.
• Select the nodes to set the applicable web service options and to adjust the web service code. More details about the screens that are linked to these nodes can be found in the applicable help pages in this manual, which are listed under "Steps to Create a Consumable REST API".
• Save the web service. The save buttons can be found in the top toolbar of the Developer. 

Adjusting a Consumable REST API

By double clicking on a Consumable REST API object, the following options for that Consumable REST API will appear:

• Options
• Definitions
• OpenAPI JSON
• Documentation
• Relations
• Implementation

Deleting a Web Service object

Consumable REST API objects can be removed from the repository through the screen "Revision Control".