SICK SIG200

7.3.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 8: Overview
Interface see "Interface", page 39
GET/apiversion see "GET/apiversion", page 39
GET/openapi see "GET/openapi", page 39
gateway see "gateway", page 40
GET/gateway/identification see "GET/gateway/identification", page 40
GET/gateway/capabilities see "GET/gateway/capabilities", page 40
GET/gateway/configuration see "GET/gateway/configuration", page 40
POST/gateway/configuration see "POST/gateway/configuration", page 40
GET/gateway/events see "GET/gateway/events", page 41
POST/gateway/reboot see "POST/gateway/reboot", page 42
POST/gateway/reset see "POST/gateway/reset", page 42
IODDs see "IODDs", page 43
GET/iodds see "GET/iodds", page 43
GET/iodds/file see "GET/iodds/file", page 43
POST/iodds/file see "POST/iodds/file", page 44
DELETE/iodds see "DELETE/iodds", page 44
Masters see "Masters", page 44
GET/masters see "GET/masters", page 44
GET/masters/1/capabilities see "GET/masters/1/capabilities", page 44
GET/masters/1/identification see "GET/masters/1/identification",
page 45
POST/masters/1/identification see "POST/masters/1/identification",
page 45
Ports see "Ports", page 45
GET/masters/1/ports see "GET/masters/1/ports", page 45
GET/masters/1/ports/{portNumber}/capabil‐
ities
see "GET/masters/1/ports/{portNum‐
ber}/capabilities", page 46
GET/masters/1/ports/{portNumber}/status see "GET/masters/1/ports/{portNum‐
ber}/status", page 46
GET/masters/1/ports/{portNumber}/configu‐
ration
see "GET/masters/1/ports/{portNum‐
ber}/configuration", page 47
POST/masters/1/ports/{portNumber}/config‐
uration
see "POST/masters/1/ports/{portNum‐
ber}/configuration", page 47
GET/masters/1/ports/{portNumber}/data‐
storage
see "GET/masters/1/ports/{portNum‐
ber}/datastorage", page 48
POST/masters/1/ports/{portNumber}/data‐
storage
see "POST/masters/1/ports/{portNum‐
ber}/datastorage", page 48
Devices see "Devices", page 48
SIG200 CONFIGURATION 7
8024482.1FJ7 /2022-05-31 | SICK O P E R A T I N G I N S T R U C T I O N | Sensor Integration Gateway - SIG200
27
Subject to change without notice