Skip to main content
Version: 1.28.0

GatewayAttributeFilter

Ordered attribute-event filters; the first matching filter is applied.

deltanumber<double>
durationstring
durationParsedMillisinteger<int64>
matcher object

Composable asset search request. Populated filters are combined to restrict results; limit and offset provide pagination.

accessstring

Requested visibility class relative to the caller.

Possible values: [PRIVATE, PROTECTED, PUBLIC]

attributes object
groups []
  • Array [
  • circular(LogicGroupAttributePredicate)
  • ]
  • items object[]
  • Array [
  • meta object[]
  • Array [
  • name object

    String matcher supporting exact, prefix, suffix, or contains matching, case sensitivity, and negation.

    caseSensitiveboolean
    matchstring

    Possible values: [EXACT, BEGIN, END, CONTAINS]

    negateboolean
    valuestring
    negatedboolean
    pathobject[]
    value object
    predicateType stringrequired

    Possible values: []

  • ]
  • name object

    String matcher supporting exact, prefix, suffix, or contains matching, case sensitivity, and negation.

    caseSensitiveboolean
    matchstring

    Possible values: [EXACT, BEGIN, END, CONTAINS]

    negateboolean
    valuestring
    negatedboolean
    pathobject[]
    previousValue object
    predicateType stringrequired

    Possible values: []

    timestampOlderThanstring
    value object
    predicateType stringrequired

    Possible values: []

  • ]
  • operatorstring

    Possible values: [AND, OR]

    idsstring[]

    Match these exact asset identifiers.

    limitinteger<int32>

    Maximum number of results; zero uses the server default.

    Example: 100
    names object[]
  • Array [
  • caseSensitiveboolean
    matchstring

    Possible values: [EXACT, BEGIN, END, CONTAINS]

    negateboolean
    valuestring
  • ]
  • offsetinteger<int32>

    Number of matching results to skip.

    Example: 0
    orderBy object

    Asset result ordering.

    descendingboolean

    Reverse the default ascending order.

    Example: false
    propertystring

    Asset property used for ordering.

    Possible values: [CREATED_ON, NAME, ASSET_TYPE, PARENT_ID, REALM]

    Example: NAME
    parents object[]
  • Array [
  • idstringnullable

    Direct parent asset identifier; null selects root assets.

  • ]
  • paths object[]
  • Array [
  • pathstring[]

    Ordered asset identifiers in the ancestry path.

  • ]
  • realm object

    Matches an exact realm name.

    namestring

    Realm name.

    Example: building
    recursiveboolean

    When parent or path filters are used, include matching descendants.

    Example: true
    select object

    Response projection for controlling which asset attributes are returned.

    attributesstring[]

    Attribute names to include. An empty array excludes all attributes; null returns all attributes.

    Example: ["temperature","humidity"]
    typesstring[]

    Match registered asset type names; base types include their concrete subtypes.

    Example: ["ThingAsset"]
    userIdsstring[]

    Match assets linked to any of these users.

    skipAlwaysboolean
    valueChangeboolean
    GatewayAttributeFilter
    {
    "delta": 0,
    "duration": "string",
    "durationParsedMillis": 0,
    "matcher": {
    "access": "PRIVATE",
    "attributes": {
    "groups": [
    null
    ],
    "items": [
    {
    "meta": [
    {
    "name": {
    "caseSensitive": true,
    "match": "EXACT",
    "negate": true,
    "value": "string"
    },
    "negated": true,
    "path": [
    {}
    ],
    "value": {
    "predicateType": "string"
    }
    }
    ],
    "name": {
    "caseSensitive": true,
    "match": "EXACT",
    "negate": true,
    "value": "string"
    },
    "negated": true,
    "path": [
    {}
    ],
    "previousValue": {
    "predicateType": "string"
    },
    "timestampOlderThan": "string",
    "value": {
    "predicateType": "string"
    }
    }
    ],
    "operator": "AND"
    },
    "ids": [
    "string"
    ],
    "limit": 100,
    "names": [
    {
    "caseSensitive": true,
    "match": "EXACT",
    "negate": true,
    "value": "string"
    }
    ],
    "offset": 0,
    "orderBy": {
    "descending": false,
    "property": "NAME"
    },
    "parents": [
    {
    "id": "string"
    }
    ],
    "paths": [
    {
    "path": [
    "string"
    ]
    }
    ],
    "realm": {
    "name": "building"
    },
    "recursive": true,
    "select": {
    "attributes": [
    "temperature",
    "humidity"
    ]
    },
    "types": [
    "ThingAsset"
    ],
    "userIds": [
    "string"
    ]
    },
    "skipAlways": true,
    "valueChange": true
    }