Actions60
- Alarm Actions
- Asset Actions
- Customer Actions
- Dashboard Actions
- Device Actions
- Entity Group Actions
- Relation Actions
- Telemetry Actions
Telemetry → Attribute Keys (by Scope)
AI-generatedSummary
Retrieves a list of unique attribute key names for a specific ThingsBoard entity and scope.
Inputs
- entityId (required) — The unique ID of the entity (e.g., device, customer) whose attribute keys are being queried.
- entityType — The type of the entity (e.g., DEVICE, CUSTOMER, ASSET). Defaults to 'DEVICE'.
- scope — The scope of attributes to retrieve keys from. Options are CLIENT_SCOPE, SERVER_SCOPE, and SHARED_SCOPE. Defaults to 'SERVER_SCOPE'. Note: CLIENT_SCOPE is only supported for devices.
Output shape
A list of items, each containing a 'attributeKeys' array with the unique attribute key names.
Returns the keys themselves as strings; values are not included.
Examples
Example 1: List all server-scoped attribute keys for a specific device.
Set resource to 'Telemetry', operation to 'Attribute Keys (by Scope)', entityId to the device's UUID, and scope to 'SERVER_SCOPE'.
Example 2: List all shared-scoped attribute keys for a customer entity.
Set resource to 'Telemetry', operation to 'Attribute Keys (by Scope)', entityType to 'CUSTOMER', entityId to the customer's UUID, and scope to 'SHARED_SCOPE'.