Back

Configuring a REST Web Service Endpoint


The endpoints node contains all the endpoints of a REST Web Service.

You can manage the endpoints:

  • Create a new endpoint.
  • Delete an endpoint.
  • Rename an endpoint.
  • Sort the endpoint names into alphabetical order.

Clicking the endpoint node displays the properties of the endpoint.

Each endpoint is defined by a unique URI, which can also contain path parameters.

The published REST Service will be made available at URI that combines the Base URI and the Endpoint URI.

e.g. https://localhost:3031/ebasetest/api/processMonitor/newEndpoint/{PARAMETER}

You can choose which HTTP Methods an endpoint will support by selecting one or more Supported HTTP Methods.

The MIME type defines the format of the data that is accepted by the Endpoint. If you define the Supported MIME Types, then HTTP Requests to this endpoint will need to include a Content-Type Header (e.g. Content-Type: application/json).

The MIME types can be configured using the  button of the Consumes field.

When the endpoint is called, the scripts contained within the Endpoint Tab will be executed. Scripts executed from an Endpoint have access to the data contained within the HTTP Request.

You can create a new script using the  or attach an existing script using the . You can also attach scripts on the On Error event to manage any unhandled errors.