System Interaction via HTTP (REST API)
Lobster_data offers a number of possibilities to change system settings via HTTP, to start processes or to read out information from the system.
System Monitoring (unsuccessful IDoc send attempts from SAP) (REST API)
System Monitoring (quick check of directory sizes) (REST API)
Reading in rule files for semantic check at runtime (REST API)
HTTP Input Agents (REST API) (see also section below)
Swagger/OpenAPI
The following page provides a Swagger/OpenAPI interface description in JSON and YAML format (see documentation there).
|
https://<URL or IP of Integration Server>/dw/spi/oas/v1/api |
|
Entry |
Reference |
|
System Monitoring |
Refers to sections |
|
MQTT |
Refers to MQTT connections . |
|
Remote Control |
Refers to sections |
|
Partner Management |
Refers to section Using Partner Management via HTTP (REST API). |
|
Statemachine (Workflow) |
Refers to section Using Workflows via HTTP (REST API). |
|
(HTTP Input Agents) |
In addition, corresponding interface descriptions can also be provided for individual HTTP Input Agents. Note: The URL here is different from the other entries, see description in the Input Agent. |
View
(1) It is necessary to log in via Basic Authentication with a Lobster_data user with admin rights.
(2) Click here.
(3) Select the values for the parameters.
(4) Click here. After that you will see the request and the response below.
Tools
OpenAPI
Integrated in Lobster_data. See above.
Building Your Own REST Interface/API
As mentioned above, a profile with an HTTP Input Agent can also act as a REST interface. The request suffix is stored in the system variable MSG_CALL_HTTP_PATH_DATA . If you evaluate this variable, you can perform different actions. In a simple case, for example, you could add two values passed by request parameter if the request suffix is add or subtract them if the request suffix is subtract. Of course, you can also trigger any other (and more complex) action. For example, trigger different workflows or subsequent profiles or call sub-profiles. This allows you to build an HTTP profile as a dispatcher for your own REST API, but you can optionally build any number of such HTTP profiles.