Lightware UCX-2x1-HC30, Руководство пользователя

Страница: 75 / 167

7. Lightware REST API Reference UCX series – User's Manual 75
Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1
7.5. System Commands
7.5.1. Set the Device Label
INFO: The device label can be changed to a custom text in the Status tab of the LDC software.
Request and Response #devicelabel #label
ɯ
header: POST·http:// <ip> /api/V1/MANAGEMENT/LABEL/DeviceLabel·HTTP/1.1
ɯ
body: <custom_name>
ɮ
header: 200·OK
ɮ
body: <custom_name>
The Device Label can be 49 character length and ASCII characters are allowed. Longer names are truncated.
Example
ɯ
header: POST http://192.168.0.50/api/V1/MANAGEMENT/LABEL/DeviceLabel HTTP/1.1
ɯ
body: UCXroom
ɮ
header: 200 OK
ɮ
body: UCXroom
7.5.2. Reset the Device
The switcher can be restarted – the current connections will be terminated.
Request and Response #reboot #restart
ɯ
POST·http:// <ip> /api/V1/SYS/restart·HTTP/1.1
INFO: The body has to be empty, and the content type should be text/plain.
ɮ
header: 200 OK
Example
ɯ
header: POST http://192.168.0.50/api/V1/SYS/restart HTTP/1.1
ɮ
header: 200 OK
7.5.3. Restore the Factory Default Settings
Request and Response
ɯ
header: POST·http:// <ip> /api/V1/SYS/factoryDefaults·HTTP/1.1
INFO: The body has to be empty, and the content type should be text/plain.
ɮ
header: 200 OK
Example
ɯ
header: POST http://192.168.0.50/api/V1/SYS/factoryDefaults HTTP/1.1
ɮ
header: 200 OK
The device is restarted, current connections are terminated, and the default settings are restored. See the
complete list in the Factory Default Settings section. #factory
7.5.4. Querying the Firmware Package Version
Request and Response #firmwareversion
ɯ
header: GET·http:// <ip> /api/V1/MANAGEMENT/UID/PACKAGE/Version·HTTP/1.1
ɮ
header: 200·OK
ɮ
body: <firmware_version>
Example
ɯ
header: GET http://192.168.0.50/api/V1/MANAGEMENT/UID/PACKAGE/Version HTTP/1.1
ɮ
header: 200 OK
ɮ
body: 1.0.0b2
7.5.5. Control Lock
Enable/disable the operation of the front panel buttons.
Request and Response #lockbutton #buttonlock
ɯ
header: POST·http:// <ip> /api/V1/MANAGEMENT/UI/ControlLock·HTTP/1.1
ɯ
body: <lock_status>
ɮ
header: 200·OK
ɮ
body: <lock_status>
Parameters
Parameter Parameter description Values Value description
<lock_status> Front panel button
locking status
None
None:
all functions of the front panel button are enabled.
locked
The front panel buttons are locked and can be unlocked
by button combination ( Control Lock ).
force
locked
The front panel buttons are locked and cannot be unlocked
by button combination, only in LDC (on the Status tab) or
using the LW3 command (or REST API).
Example
ɯ
header: POST http://192.168.0.50/api/V1/MANAGEMENT/UI/ControlLock HTTP/1.1
ɯ
body: force locked
ɮ
header: 200 OK
ɮ
body: Force locked
   