Endpoint
HTTP API schema
Endpoint fields
- enablementEnablementRequired
enablement: Reference Enablement
- id
stringRequired The unique identifier for the endpoint
pattern: "^port1/[^/]+/[^/]+/endpoints/[^/]+$"
- nameTypeValueRequired
The name of the endpoint
- type
stringRequired The type identifier of the name value, defined as plain when not defined.
- value
stringRequired the raw value of a plain name.
- type
- type
stringRequired The type of endpoint
- interfaces
array<ApplicationInterface>Required List of interfaces supported by the endpoint
- ItemApplicationInterface
interfaces[]: Reference ApplicationInterface
- ownerId
stringRequired The ID of the owner of the endpoint
- descriptionTypeValue
The description of the route as a human readable string or a localizable asset.
- type
stringRequired The type identifier of the name value, defined as plain when not defined.
- value
stringRequired the raw value of a plain name.
- type
- manufacturerTypeValue
The manufacturer of the route as a human readable string or a localizable asset.
- type
stringRequired The type identifier of the name value, defined as plain when not defined.
- value
stringRequired the raw value of a plain name.
- type
- modelTypeValue
The model of the route as a human readable string or a localizable asset.
- type
stringRequired The type identifier of the name value, defined as plain when not defined.
- value
stringRequired the raw value of a plain name.
- type
- serialNumberTypeValue
The serial number of the route as a human readable string or a localizable asset.
- type
stringRequired The type identifier of the name value, defined as plain when not defined.
- value
stringRequired the raw value of a plain name.
- type
- parentEndpointId
string The endpoint this endpoint is part of, when a provider reports it as a component of another endpoint (for example a SmartThings oven cavity of its range). Derived from `IS_PART_OF` relationships between routes; when routes disagree the lowest parent endpoint ID is returned. Absent when the endpoint has no parent. Endpoint lists leave such endpoints out unless `includeChildEndpoints` is true; read one by its ID.
pattern: "^port1/[^/]+/[^/]+/endpoints/[^/]+$"
- childEndpointIds
array<string> The IDs of the endpoints that are part of this endpoint, sorted. Absent when the endpoint has no children.
- Item
string pattern: "^port1/[^/]+/[^/]+/endpoints/[^/]+$"
- Item
- resourceGroups
array<ResourceGroup> List of associated resource groups
- ItemResourceGroup
resourceGroups[]: Reference ResourceGroup
- attributes
array<AttributeState> Device state attributes for this endpoint. Query responses populate this array when `GET /endpoints` is called with `expand=interfaces.attributes`; otherwise it remains the default shallow shape.
- ItemAttributeState
attributes[]: Reference AttributeState