List Diagnostics collection.
Diagnostics collection with up to TODO items of the following Diagnostic types:
- threadNetworkDiscovery TODO
- threadNetworkDiagnostic
- threadEnergyScanReport
Background Logic
- when a new item is added, old items may be removed (oldest first) to free enough memory
- all Diagnostic items are created through their corresponding Task
Query parameters
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)
Headers
Must be set to application/vnd.api+json or application/json
Response
(JSON:API) document with with up to TODO data objects representing Diagnostic items that must have the following members:
- id: unique diagnostic ID assigned by the server
- type diagnostic type (see Schema)
- attributes: diagnostic-specific attributes (see Schema)