The {masterNumber} variable is always 1, because the SIG350 gateway has only one
master.
Response
For each request, the SIG350 responds with status information and data or only status
information if no data is available. Depending on the request, this response can contain
several pieces of information. In case of an error, the corresponding error code (see
section XXX) is returned.
The response corresponds to the following format:
{
“name1”: value1
“name2”: value2
“name…”: value…
}
•
The “name” corresponds to the name of the object: e.g. Vendor ID
•
The “value” corresponds to the value of the object: e.g.: 26
Thus, an example response is as follows:
{
“Vendor ID”: 26
“Device ID”: 8389238
“deviceAlias”: Flow_control_1
}
NOTE
No specific response time can be guaranteed for the use of the REST API interface
since the HTTP requests are based on a standard TCP mechanism. The response time
also depends on the system environment and system load. When using the web UI at
the same time, the response time increases.
8.2.1.4 Available variables and methods
The SIG mainly supports the GET and POST methods. For selected variables, the
DELETE function is also supported.
All API calls are executed synchronously. This means that every request is followed by a
response. A minimum response time cannot be defined for the REST API commands, as
this is also dependent in particular on the system environment and load used.
The following gives an overview of the available variables and methods. Detailed infor‐
mation and examples can be downloaded in the Open API documentation via the SICK
website, see www.sick.com.
REST API resources
Table 28: Overview of REST API HTTP resources
Resource Description
/gateway Addressing the gateway
/masters List of all available master variables and identi‐
fication information
/master/{masterNumber} Addressing of a specific master
OPERATION 8
8027834./2022-06-10 | SICK O P E R A T I N G I N S T R U C T I O N S | Sensor Integration Gateway - SIG350
45
Subject to change without notice
To Next Page
Loading...
