HTTP Request Parameters for Method GET

images/download/attachments/21304520/HTTP_Client_Server_EN-version-1-modificationdate-1501039915000-api-v2.png

In its role as HTTP(S) server, Lobster_data can access the values of all HTTP(S) request parameters via variables with the following syntax.

MSG_CALL_<name of the parameter in capital letters>

For example, the parameters param1 and param2 of the following HTTP(S) request can be accessed via the variables MSG_CALL_PARAM1 and MSG_CALL_PARAM2.

http://192.168.213.64:8080/dw/trigger/example?param1=value1&param2=value2

Note: These variables are therefore available in the same profile and not in a subsequent profile, as is usual for variables with the prefix MSG_CALL_. See also section Variables with Prefix MSG_CALL_.

Defining the Mandatory Request Parameters

For both the transfer of data via the HTTP(S) Input Agent and the triggering via HTTP(S) request, you can determine which parameters at least have to be contained in the respective HTTP(S) request. The following screenshot shows an example of how to set the HTTP(S) request parameters.

images/download/attachments/55940068/HTTP_4_EN-version-1-modificationdate-1595579807339-api-v2.png

(1) Name of the HTTP(S) request parameter that must be contained.

(2) If a value is entered in this field, then the affected parameter must have exactly this value in the HTTP(S) request. If the symbol * is entered in this field instead of a value, the parameter can have any value. This way, you can specify that the relevant parameter only has to be in the request but does not have to have a specific value.

The following HTTP(S) requests are accepted in the example.

...?param1=value1&param2=value2&param3=value3&param4=value4
...?param1=value1&param2=value2&param3=value3&param4=valueX
...?param1=value1&param2=value2&param3=value3&param4=valueX&param5=value5

The following HTTP(S) requests are not accepted.

...?param1=value1&param2=value2&param3=value3
...?param1=value1&param2=value2&param3=valueX&param4=valueY

If there are several profiles with the same URL suffix for an incoming HTTP(S) request and an appropriate HTTP(S) request parameter definition, these profiles are equally prepared to accept the request. In this case, the first profile that fits will be used.

HTTP Headers

images/download/attachments/55940068/HTTP_Client_Server-version-1-modificationdate-1595579807341-api-v2.png

HTTP headers are accessed via system variables. These also apply to web services and AS2 because they are transported via HTTP.

Lobster_data as HTTP Server

All available HTTP request headers from the client can be found in the system variables. It is also possible to fill certain system variables whose values are then used to set HTTP response headers.

Lobster_data as HTTP Client

All available HTTP response headers from the server can be found in the system variables.