SICK SIG200

GET/devices/{deviceAlias}/parameters/{parameterName}/subindices/{subParame‐
terName}/value
POST/devices/{deviceAlias}/parameters/{parameterName}/subindices/{subParame‐
terName}/value
Reading and writing individual IO-Link device parameters via the parameter name.
Requires correct IODD for the connected device.
Query parame‐
ters
Type Description
format
Enum
[“byteArray”/
“iodd”]
Selection of the parameter data structure. Either as byte
array (default) or according to the data structure and
typing stored in the IODD. Requires prior upload of the
correct IODD.
7.3.7 SICK-specific REST API (deprecated)
7.3.7.1 Error messages
The table below contains all defined status codes, messages and a detailed descrip‐
tion:
Table 19: Status codes/messages of SICK-specific REST API (deprecated)
Code Message Description
0 Ok The request was processed successfully.
1 Parsing
failed (analy‐
sis failed)
Error when analyzing the incoming JSON object.
2 Invalid data Data specified for variable is invalid
3 Internal
Server Error
General error message issued when an unexpected condition has
occurred and no more specific message is suitable. Note: The Message
property may contain more details about the error condition.
4 Access
denied
The request was valid, but the server refuses to respond due to an
access violation. In the event of a variable access, it is possible that
the variable is defined as read-only.
5 Not found Variable or method could not be found.
6 Out of range The value does not fit into the value field or is too large, e.g. a value
that exceeds or falls below the permitted minimum or maximum value
for this variable.
7 Out of
bounds (out
of the per‐
missible
range)
An array was accessed whose maximum length was exceeded.
9 Illegal value A data condition was violated or the enum value passed was out of
range.
10 Invalid chal‐
lenge
The challenge used has expired or is unknown.
11 Port not
available
The desired IO-Link port cannot be accessed:
•
Incorrect parameterization
•
Missing IO-Link device
12 Communica‐
tion error
The desired IO-Link port does not provide a communication channel:
•
Read incoming/outgoing process data if not available
7 SIG200 CONFIGURATION
56
O P E R A T I N G I N S T R U C T I O N | Sensor Integration Gateway - SIG200 8024482.1FJ7 /2022-05-31 | SICK
Subject to change without notice