Index of web services resources
The following table is a summary of the web services resources, listed by their URIs in alphabetical order. Click the URI name in the Device Relative URL column to jump to the detailed description of the URI.
In the URI name, strings in italics are placeholders to be replaced with appropriate values for the specific operation.
Protected URI: For URIs with an x in the Protected URI column, the URI is read-only to applications and read/write to administrators.
Note config/ws_events and config/wireless/wlan0 are the only settings_groups that are not protected.
| Device relative URL (web services path + element URI) |
Action | Protected URI | Request methods | Content types | |||||
|---|---|---|---|---|---|---|---|---|---|
| GET | PUT | POST | DELETE | HTML | XML | JSON | |||
| /ws | Get URI list of web services categories. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/alarms | Get URI list of web service alarm records. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/alarms/short_name | Manipulate a web service alarm record. | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| /ws/config | Get URI list of configuration setting groups. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/config/factory_default | Reset all settings groups to their factory defaults. | ✓ | ✓ | ||||||
| /ws/config/settings_group | Manipulate a single settings record, for settings without an instance specifier. |
✓ |
✓ | ✓ | ✓ | ✓ | |||
| /ws/config/settings_group (with instances) | Get URI list of known instance specifiers, for settings that have them. | ✓ | ✓ | ✓ | ✓ | ||||
| ws/config/settings_group/instance_specifier | Manipulate a single settings record for settings with an instance specifier. |
✓ |
✓ | ✓ | ✓ | ✓ | |||
|
/ws/files/volume/path
|
Manipulate a single settings record for settings with an instance specifier. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/files/volume/path?type=dir | Create a new directory at the named path. | ✓ | |||||||
| /ws/files/volume/path/filename | Manipulate the named file in the named path. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/hw | Get URI list of categories of manageable hardware interfaces. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/hw/buttons | Get URI list of manageable buttons. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/hw/buttons/button_name | Read the state of the named button. | ✓ | ✓ | ✓ | |||||
| /ws/hw/buzzer | Manipulate the buzzer, also known as the audible alarm. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/hw/fw_update | Initiate or test status of a firmware update. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/hw/leds | Get URI list of manageable LEDs. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/hw/led_name | Manipulate the named LED.
|
✓ | ✓ | ✓ | ✓ | ||||
| /ws/hw/reboot | Reboot the system. | ✓ | |||||||
| /ws/hw/time | Manipulate system time. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/password | Set the password for admin username. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/state | Get URI list of state categories. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/state/state_path (containing subgroups or instances) |
Get URI list of subgroups or instances for the named state path. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/state/state_path (containing elements) |
Get URI list of elements for the named state path. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/state/state_path/element_name | Query the system for a specific element of the named state group in the system. | ✓ | ✓ | ✓ | |||||
| /ws/subscriptions | Get URI list of web service subscription records. | ||||||||
| /ws/subscriptions/short_name | Manipulate a web service subscription record. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/vehicle | Get URI list of vehicle object categories. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/vehicle/data | Get URI list of vehicle data elements. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/vehicle/data/element_name | Get a specific vehicle data element. | ✓ | ✓ | ✓ | |||||
| /ws/vehicle/dtc | Get URI list of DTC message types for which the system listens. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/vehicle/dtc/can0_active | Get URI list of ECUs on first J1939/CAN bus for active DTCs. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/vehicle/dtc/can0_active/ecu_reference | Get latest active DTC from an ECU on first J1939/CAN bus. | ✓ | ✓ | ✓ | |||||
| /ws/vehicle/dtc/can0_inactive | Get URI list of ECUs on first J1939/CAN bus for inactive DTCs. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/vehicle/dtc/can0_inactive/ecu_reference | Get latest active DTC from an ECU on first J1939/CAN bus. | ✓ | ✓ | ✓ | |||||
| /ws/vehicle/dtc/can1_active | Get URI list of ECUs on second J1939/CAN bus for active DTCs. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/vehicle/dtc/can1_active/ecu_reference | Get latest active DTC from an ECU on second J1939/CAN bus. | ✓ | ✓ | ✓ | |||||
| /ws/vehicle/dtc/can1_inactive | Get URI list of ECUs on second J1939/CAN bus for inactive DTCs. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/vehicle/dtc/can1_inactive/ecu_reference | Get latest inactive DTC from an ECU on second J1939/CAN bus. | ✓ | ✓ | ✓ | |||||
| /ws/vehicle/ecus | Get URI list of detected vehicle ECUs. | ✓ | |||||||
| /ws/vehicle/ecus/ecu_reference | Get URI list of descriptive items for an ECU. | ✓ | ✓ | ✓ | ✓ | ||||
| /ws/vehicle/ecus/ecu_reference/item | Get a specific ECU information element. | ✓ | ✓ | ✓ | |||||
PDF
