OPopenthread
Devices

Read Devices item

Changed on

threadDevice item in the Devices collection selected by its id.

Condition

Requires a threadDevice item with the given id to exist; otherwise returns 404 Not Found.

get/api/devices/{deviceId}

Request

  • Base URL
    http://localhost:8081
  • URL
    http://localhost:8081/api/devices/{deviceId}
  • Auth
    none required

Path parameters

deviceIdstring required

Alphanumeric hex string of length 16

ID of the requested Device item.

Query parameters

fieldsobject

A selector that allows clients to request a subset of items of the given type only:

  • with all attributes, for example, fields[addThreadDeviceTask] or fields[{type}] in general
  • with selected attributes only ("Sparse Fieldset"), fields[nodeDevice]=vendorModel,operationalDataset.active.channel or fields[{type}]={attributeKey}(,{attributeKey})* in general

Condition

The {type} must be given (in other words, not empty). The value of the parameter must be fully omitted (in other words, no = in query) or contain one or more type-specific {attributeKey}s in a comma-separated list. An {attributeKey} may use the dot notation to select a subordinate field of the attribute.

Allowed characters for {type} and {attributeKey} are alphanumeric characters, underscores (_), hyphens (-), and dots (.) for nested fields. Commas (,) are used as separators. Allowed character set (regex): ^[A-Za-z0-9_.\-\,]+$

Examples

  • ?fields[threadDevice]=hostname,role
  • ?fields[addThreadDeviceTask]=eui,pskd&fields[threadDevice]=hostname
  • ?fields[threadDevice] (all attributes for threadDevice)

Response

(JSON:API) document with a single data object representing the selected threadDevice item.

object[] required
OR
object required

Changes