Update filter

Updates the specified filter.

Parameter name

Datatype

Mandatory/Optional

Description

name

String

Optional

User-assigned subscription name.

description

String

Optional

User friendly description of the Filter.

is_active

Boolean

Optional

Indicate whether the current filter is active or not.
Default = True

filter_conditions

Object

filter_conditions.uuid

String

Mandatory

UUID of the filter_conditions.

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

Optional

(Device Serial Number) Unique device identifier in Ayla cloud services.
To represent all DSNs, use empty array "[]".

filter_conditions.property_names

String Array

Conditional

  • If event_type is getting updated to “datapoint”, “datapointack” and existing property_names for the filter is empty, then it is Mandatory.

Name of the property associated with the device.

  • *NOTE**: → NULL or "[]" will be considered as empty.

filter_conditions.oem_model

String Array

Optional

Unique product model name.
To represent all OEM models, use empty array "[]".

Language
Credentials
Header
Click Try It! to start a request and see the response here!