Get Formats - Safran WR-ZEN Series User Manual

4.2 The REST-API
4.2.2.2

GET Formats

The GET method can retrieve different levels of information, called 'formats'.
There are five formats:
38
GET: Reads the value of the parameter.
PUT: Changes the parameter applying a given value, and saves it to make it
persistent to reboots.
POST: Saves the value of a parameter without applying it. The parameter
will have the new value after the next reboot.
PATCH: Applies a value to a parameter without saving it.
value_string: Retrieves the value as a string.
value_number: Retrieves the value as a number.
basic: Retrieves the value as a string and as a number, among its current
status (Warning, critical,...)
config: The same as the basic, plus the configured (saved) value.
complete: All the retrievable information of a parameter. Is the same as the
'config' format, plus:
oid: Parameter's primary key in owner_id.modir_id.prm_id format.
access_str: The access permissions to the parameter in string format.
vtype_str: The type of the parameter in string format
unit: Unit of the parameter
desc: Description of the parameter
enum_ dict: All the possible settable values of the parameter, both
with its corresponding numbers numbers and strings.
metrics_dic: The computed metrics for the parameter.
Note: To know the supported values of a parameter, the user shall
make a complete query where the enum object will show the valid
range.
CHAPTER •
4 WR-ZEN Series User Manual Rev. v5.1