item_dictionary_updated
- sent when some changes happened to an dictionary item.
{
event = "item_dictionary_updated"
_id = "588b7eb528b12d03be86f36f"
deviceId = "588t7eb528b12d03be86f36f"
deviceName = "Touchscreen Deadbolt"
deviceArmed = false
deviceCategory = "door_lock"
deviceSubcategory = ""
roomName = ""
notifications = { "12314324", "978343" }
name = "user_codes"
operation = "added"
elementNumber = "1"
value = {
code = "Alex"
name = "1234"
}
}
Field | Type | Required | Description |
---|---|---|---|
event | string | + | type of an event |
_id | string | + | an id of the item |
deviceId | string | + | related device._id |
deviceName | string | + | related device.name |
deviceCategory | string | + | a device category |
deviceSubcategory | string | + | a device subcategory |
roomName | string | + | a room name |
notifications | array | + | List of user ids for sending broadcast notification to users( null – all users / – no one ) |
name | string | + | see item.name(type) |
deviceArmed | bool | – | related device.armed state |
elementsMaxNumber | int | + | max allowed elements of a dictionary value |
stringRestriction | string | – | Regexp restriction for a value in item of value type |
userCodeRestriction | string | – | Regexp restriction for a field in any value of value type. E.g. it’s used in item . |
userCodeModes | array of strings | – | List of available pin code modes. It’s used in item. |
operation | string | + | The operation field defines the initiator of this broadcast: hub.item.dictionary.value.add — hub.item.dictionary.value.set — hub.item.dictionary.value.remove — |
elementNumber | string | + | The element number. |
value | any | + | The element value. |