HTTP method
Description
DELETE
Deletes the specified resources on the server (= data is deleted)
8.2.1.2
API documentation
The current documentation (also called Open API) of the API interface can be down‐
loaded at
. This document defines all available variables and
methods of the API interface of the SIG350.
The OPEN API documentation is in JSON/YAML format and can be used with appropri‐
ate software tools such as Swagger, Postman or Insomnia.
8.2.1.3
API structure
Request
To request data, a command must be sent to the server, in this case the SIG350. This
command is structured in HTTP format:
URL schema: http://[IP-Adresse]/[BasePath]/[Resource]
•
The IP address corresponds to the valid IP address of the module. The default
IP address of the SIG350 is
192.168.0.1
. If necessary, the default address has
already been changed via the PLC or the web interface.
•
The
BasePath
is defined in the standard of the IO-Link community:
/iolink/v1
•
The resource is used to address the corresponding parameter which is to be read
or written:
E.g.: /masters/{masterNumber}/ports/{portNumber}/configuration
An overview of the available variables and methods can be found in section XXX and in
the standard of the IO-Link community.
Thus, an example URL for reading the port configuration of port S3 is as follows:
http://192.168.0.1/iolink/v1/masters/1/ports/3/configuration
NOTE
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:
OPERATION
8
8027836./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
39
Subject to change without notice
