post https://cmqtt-web-dev.aylanetworks.com/mqtteventprocessor/api/v1/filters.json
This API creates a new filter and adds this new filter to the Ayla mDSSV2 filter list.
The follow table provides the body parameter list:
Parameter name | Datatype | Mandatory/Optional | Description |
---|---|---|---|
name | String | Optional | User-assigned subscription name. |
oem_id | String | Optional | Unique customer identifier for Ayla cloud services. If this parameter is not passed, it will be fetched using your auth_token. |
user_uuid | String | Optional | End-user’s unique user ID. |
description | String | Optional | User friendly description of the Filter. |
is_active | Boolean | Optional | Indicate whether the current filter is active or not. Default = True |
client_type | String | Mandatory | Possible values: Mobile, Cloud, or Voice |
filter_conditions | Object | ||
filter_conditions.event_type | Optional | Possible event type values: - connectivity - registration - datapoint - datapointack - location To subscribe to all event_types, use empty array "[]". | |
filter_conditions.model | String Array | Optional | Model associated with device. To represent all models, use empty array "[]". |
filter_conditions.dsn | String Array | Conditional If oem_model is not passed, then it is Mandatory. | (Device Serial Number) Unique device identifier in Ayla cloud services. To represent all DSNs, use empty array "[]". If you choose to add specific devices, you can add upto maximum of 20 devices. |
filter_conditions.property_names | String Array | Conditional - If event_type = (“datapoint”,”datapointack”), then it is mandatory. | Name of the property associated with the device. NOTE: → NULL or "[]" will not be considered and it will throw an error. |
filter_conditions.oem_model | String Array | Conditional - If DSN is not passed, then it is mandatory. | Unique product model name. To represent all OEM models, use empty array "[]". |