The Generic REST Server export module provides a REST service via HTTP and HTTPS using the 

This is a "single service" module, so only one export instance can be created.

The module can be activated via the "IoT Export" area in the web configuration or the BSC Remote and the "x-api-key" can be stored.

The service is provided at the following URL:

When activating the module, an "x-api-key" can be configured. This is filled with a random string by default.

If an empty string is stored, access is not protected.

Otherwise the key stored there must be sent with every request in the header field "x-api-key".

 end point. There all devices are listed with detailed information.

The other endpoints are used to read out specific information from a device or to make a value change.

Get a list of all available devices Objects

Retrieve all devices

Parameter name

Retrieve a single device object by its ID.

Retrieve a single device

thingId

Retrieving the current connection status by means of a device ID

Query device status

Retrieve the meta information of a device by its ID

Query meta information

Retrieving the channel object by means of the device and channel ID

Query data object of a channel

channelId

Retrieve the current channel value based on the device and channel ID

Query current value of a channel

Sets the value of the channel specified via the devices and channel ID 

Set current value of a channel

newValue

The new value is written as (raw) string directly (without JSON formatting) into the body of the request!

Retrieving the meta information of a channel by means of the device and channel ID

Query the meta information of a channel

Retrieving the values Description of a channel by means of the devices and channel ID

Query the values description of a channel

Retrieving the channel description by means of the devices and channel ID

Query a channel description

Query whether the value of a channel can be changed

Query whether a channel is writable

Learn how to create a REST service using the Generic REST Server export module with this informative document. Explore endpoints like "/things" to retrieve device information and make value changes. Get code examples in various programming languages for r

Generic REST Server

Introduction

Configuration

Access

Api protection

Endpoints