| devices |
– |
If this field is present: a response with the devices will be sent anyway. If it has null value than all devices will be sent. |
| devices.ids |
– |
Array of IDs of requested devices. Only requested devices will be in the answer. If the controller doesn’t have requested device then null will be send instead of device data. |
| devices.fields |
– |
Description of fields filtering. If this field is missed than all fields will be present in answer. |
| devices.fields.include |
– |
Name of fields which should be in answer. Possible values: parentDeviceId, category, subcategory, deviceTypeId, gatewayId, name, type, batteryPowered, reachable, armed, roomId, persistent, info, serviceNotification, security, ready, status |
| items |
– |
If this field is present: a response with the items will be sent anyway. If it has null value than all items will be sent. |
| items.ids |
– |
Array of IDs of requested items. Only requested items will be in the answer. If the controller doesn’t have requested item then null will be send instead of item data. |
| items.fields |
– |
Description of fields filtering. If this field is missed than all fields will be present in answer. |
| items.fields.include |
– |
Name of fields which should be in answer. Possible values: deviceId, enum, hasGetter, hasSetter, name, show, scale, valueType, valueFormatted, value, minValue, maxValue, elementsMaxNumber, userCodeRestriction, elementsMaxNumberPerArray, oneWeekDayCost, oneShiftedWeekDayCost |
| rooms |
– |
If this field is present: a response with the rooms will be sent anyway. If it has null value than all rooms will be sent. |
| rooms.ids |
– |
Array of IDs of requested rooms. Only requested rooms will be in the answer. If the controller doesn’t have requested room then null will be send instead of room data. |
| rooms.fields |
– |
Description of fields filtering. If this field is missed than all fields will be present in answer. |
| rooms.fields.include |
– |
Name of fields which should be in answer. Possible values: enabled, group_id, is_group, name, parent_id, then, when |
| scenes |
– |
If this field is present: a response with the scenes will be sent anyway. If it has null value than all scenes will be sent. |
| scenes.ids |
– |
Array of IDs of requested scenes. Only requested scenes will be in the answer. If the controller doesn’t have requested scene then null will be send instead of scene data. |
| scenes.fields |
– |
Description of fields filtering. If this field is missed than all fields will be present in answer. |
| scenes.fields.include |
– |
Name of fields which should be in answer. Possible values: enabled, group_id, is_group, name, parent_id, then, when |
| features |
– |
If this field is present: a response with the features will be sent anyway. If it has null value than all features will be sent. |
| features.names |
– |
Array of features names. Only requested features will be in the answer. If the controller doesn’t have requested feature then null will be send instead of feature data. |
| features.fields |
– |
Description of fields filtering. If this field is missed than all fields will be present in answer. |
| features.fields.include |
– |
Name of fields which should be in answer. Possible values: status, version |
| settings |
– |
If this field is present: a response with the settings will be sent anyway. If it has null value than all settings will be sent. |
| settings.names |
– |
Array of settings names. Only requested settings will be in the answer. If the controller doesn’t have requested setting then null will be send instead of setting data. |
| settings.fields |
– |
Description of fields filtering. If this field is missed than all fields will be present in answer. |
| settings.fields.include |
– |
Name of fields which should be in answer. Possible values: name, valueType, value, enum |