User Interface: REST Endpoints

On the REST Endpoints page in System System Management , a table of dynamic REST endpoints and their properties is displayed. You can add, modify, and delete REST endpoints in this table to allow a client application to communicate with Loftware Enterprise SP to request or send data.

Note: See Controlling Access to System Settings for information about the access needed to view, create, modify, delete, or communicate with REST endpoints.

When you create or modify a REST endpoint, you can configure the following properties.

Property	Description
Name	Required. The name of the REST endpoint, which will be part of the REST URL used by the requesting client application.
Business Rule	Required. A business rule that should be run when the REST endpoint is requested. This business rule performs actions, processes data passed into the data map by the requesting client application, and posts return values to the data map to be passed back to the client application.
Business Rule Event	Required. The XML name of the trigger event for the component set in the business rule that should be run when the REST endpoint is requested by a client application. When the REST endpoint is requested, the business rule is run as if this event has occurred.
Response Key	The key of the data map entry (path or endpoint) that will be returned for the REST request. The value of this data map entry will be populated by the business rule associated with the REST endpoint.
Response Content Type	Required. The type of content to be returned by the REST response. The following values are supported. application/json application/pdf application/xml application/zip image/png text/csv text/html text/plain For JSON and CSV response content, you must use the associated business rule to configure the format because the return values are arrays. Important: REST client calls made to REST Endpoints configured for application/json or application/xml should configure a Content-Type of: application/json;charset=UTF-8 application/xml;charset=UTF-8
Request Method	Required. What request method the client application uses to retrieve data from or send data to Loftware Enterprise SP. Only the following values are supported. GET: Primarily for requesting data from Loftware Enterprise SP. This type of request can be cached and therefore is not recommended for use with sensitive data. POST: Primarily for sending data to Loftware Enterprise SP. This type of request is not cached. Note: Regardless of the request method used, you can also allow the client application to send data to Loftware Enterprise SP as a header value or URL parameter.
Request Key	The key of the data map entry to which the client application will pass string values by using the request body. The business rule associated with the REST endpoint may also use this key.
Auto-Detect Request Processor	This option is only available in REST endpoints that have been upgraded to Loftware Enterprise SP 4.6 or later versions. Prior to 4.6, Loftware Enterprise SP processed the incoming REST body data based on the passed in Content-Type. In Loftware Enterprise SP 4.6 and later versions, you specify one Request Processor Type per endpoint. Select Auto-Detect Request Processor type to retain the pre-4.6 behavior.
Request Processor Type	The types of body data that are auto-detected Text JSON XML Multipart Binary
Accept MIME Types	Auto populated based on the selected Request Processor Type. These are the MIME type that will be processed by this endpoint. This list can be manually modified.
Character Encoding	The character encoding scheme for the returned REST response. The following value is supported. UTF-8
Description	A brief explanation of the purpose of the REST endpoint.

Tip: For information about how the requesting client application must use to communicate with a REST endpoint, see Communicate with a REST Endpoint.