REST Resources

/api/space/device-management/devices/{id}/connection-status

The following operation is supported on this resource:

  • GET - Get connection status of device
GET /devices/{id}/connection-statusVersion 1

This API is used to retrieve the connection status for a device.

Data Notification Support

Whenever the connection status of device gets modified (for example, the device goes up and down) the data notification corresponding to this API gets generated.

.

Sample Usage

GET /devices/{id}/connection-status


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    idIntegerPathThe ID of the device from which to retrieve the connection status. Y
  • Sample Output XML:

    <connection-status uri="/api/space/device-management/devices/229377/connection-status">
       <status>up</status>
    </connection-status>

  • Sample Output JSON:

    {
      "connection-status": {
        "@uri": "/api/space/device-management/devices/229377/connection-status",
        "status":"up"
      }
    }

  • Access Control

    The following capabilities are required to access this API: ReadDevices