EndpointQueryRequest
HTTP API schema
EndpointQueryRequest fields
- queryQueryRequired
A bounded shared Query expression. By default, an empty object and filters such as type or interfaces select enabled endpoints owned by the caller. An explicit ownerId, groupId, or required exact id selector can include readable endpoints owned by others; endpoint-read permission is still required for every result. This endpoint supports match, and, or, and not. Scalar match keys are id, name, type, ownerId, manufacturer, model, serialNumber, and enablement. interfaces matches membership in the endpoint's declared interface names; groupId matches membership in a readable endpoint group. Comparisons, patterns, freeform search, unknown keys, ambiguous nodes, expressions deeper than eight levels, or more than 64 nodes return 400. Values are exact strings. Collections exclude disabled endpoints unless the expression filters enablement. A query that requires specific exact endpoint IDs can also return disabled endpoint metadata without an enablement filter, subject to endpoint-read permission. A groupId predicate additionally requires group:read for delegated OAuth and read permission on that group.
- matchQueryComparator
Match data between fields
- key
string The key to match on
- value
string The value to match on
- key
- lessThanQueryComparator
Less than comparison
- key
string The key to match on
- value
string The value to match on
- key
- greaterThanQueryComparator
Greater than comparison
- key
string The key to match on
- value
string The value to match on
- key
- patternMatch
string Pattern for REGEX queries (e.g., "*.json")
- freeformMatch
string Freeform query string for natural language searches
- paginationContextPaginationRequestContext
paginationContext: Reference PaginationRequestContext
- expand
array<string> Optional reported state expansion; only interfaces.attributes is supported.
uniqueItems: true
- Item
string Allowed values: interfaces.attributes.
- Item
- includeChildEndpoints
boolean A query returns root endpoints only: an endpoint that is part of another endpoint (for example an oven cavity of its range, which reports `parentEndpointId`) is left out, and the parent lists its parts in `childEndpointIds`. Send true to match those parts too. A query that selects endpoints by exact id or by groupId returns them either way. Repeat the same setting when following nextToken. A part whose parent the caller cannot read is still returned.
Default:
false- forceDeviceQuery
boolean Refresh reported device attributes for the selected page. Requires expand to contain interfaces.attributes. An accepted command is not proof of device state; inspect each attribute's sampledAt and freshness and the partial errors. A provider can answer with its own last known sample, which is returned as STALE. Disabled endpoints cannot be forcibly refreshed.
Default:
false