7.4
Configuration via REST API
The SIG200 provides a REST API with JSON data format for accessing the data of the
connected devices.
NOTE
Since firmware version 1.3, the SIG200 has also featured the JSON REST interface
defined by the IO-Link community in addition to the SICK-specific REST API interface.
This is specified in the document “JSON Integration for IO-Link” in version 1.0.0 (Mar
2020 Order No: 10.222).
These operating instructions provide an overview of the available device functions and
the access mechanisms.
7.4.1
General Interface description
The REST API is a client – server interface and enables the client to request data from
the server through a defined set of resources. The REST API is stateless which means
that no information about the state of connection and no information about the server
or client are required.
The operation is based on HTTP methods. Common HTTP methods are GET, POST, PUT
and DELETE. JSON, or JavaScript Object Notation, is a minimal, visually readable format
for structuring data. It is mainly used to transmit data between a server and a web
application as an alternative to XML.
Table 12: Overview
Interface
GET/apiversion
GET/openapi
gateway
GET/gateway/identification
see "GET/gateway/identification", page 73
GET/gateway/capabilities
see "GET/gateway/capabilities", page 73
GET/gateway/configuration
see "GET/gateway/configuration", page 73
POST/gateway/configuration
see "POST/gateway/configuration", page 73
GET/gateway/events
see "GET/gateway/events", page 74
POST/gateway/reboot
see "POST/gateway/reboot", page 75
POST/gateway/reset
see "POST/gateway/reset", page 75
IODDs
GET/iodds
GET/iodds/file
POST/iodds/file
see "POST/iodds/file", page 77
DELETE/iodds
Masters
GET/masters
GET/masters / 1/capabilities
see "GET/masters / 1/capabilities", page 77
GET/masters / 1/identification
see "GET/masters / 1/identification",
page 78
POST/masters / 1/identification
see "POST/masters / 1/identification",
page 78
Ports
GET/masters / 1/ports
see "GET/masters / 1/ports", page 78
7
SIG200 CONFIGURATION
60
O P E R A T I N G I N S T R U C T I O N | Sensor Integration Gateway - SIG200
8017853.1D0S/2021-11-04 | SICK
Subject to change without notice