Skip to main content

SearchAssetFilters

asset object

Identifier of the asset to search for

uidstring

Unique identifier for the asset (typically UUID)

Default value: ##default
Example: 519c00c9-29b1-4e16-8ed2-61bb4a8d6249
externalIdsstring

Must contains only one external system identifier

Default value: ##default
Example: {"CODE":"001"}
parent object

Identifier of the parent asset used to search for its child assets

uidstring

Unique identifier for the asset (typically UUID)

Default value: ##default
Example: 519c00c9-29b1-4e16-8ed2-61bb4a8d6249
externalIdsstring

Must contains only one external system identifier

Default value: ##default
Example: {"CODE":"001"}
parentRecursive object

Identifier of an ancestor asset used to search recursively for all its descendant assets

uidstring

Unique identifier for the asset (typically UUID)

Default value: ##default
Example: 519c00c9-29b1-4e16-8ed2-61bb4a8d6249
externalIdsstring

Must contains only one external system identifier

Default value: ##default
Example: {"CODE":"001"}
child object

Identifier of the child asset used to search for its containing or grouping parent assets

uidstring

Unique identifier for the asset (typically UUID)

Default value: ##default
Example: 519c00c9-29b1-4e16-8ed2-61bb4a8d6249
externalIdsstring

Must contains only one external system identifier

Default value: ##default
Example: {"CODE":"001"}
name object
Filter on an asset field. - Only one of 'equals' or 'matches' can be provided at the same time. - Only one of 'notEquals' or 'notMatches' can be provided at the same time. If both are set in either pair, the request is considered invalid.
equalsstring[]

Exact matching

Default value: ##default
Example: ["BUILDING_GROUP"]
matchesstring[]

Regex matching

Default value: ##default
Example: ["EQUIPMENT\\|.*"]
notEqualsstring[]

Exclude using exact matching

Default value: ##default
notMatchesstring[]

Exclude using regex matching

Default value: ##default
type object
Filter on an asset field. - Only one of 'equals' or 'matches' can be provided at the same time. - Only one of 'notEquals' or 'notMatches' can be provided at the same time. If both are set in either pair, the request is considered invalid.
equalsstring[]

Exact matching

Default value: ##default
Example: ["BUILDING_GROUP"]
matchesstring[]

Regex matching

Default value: ##default
Example: ["EQUIPMENT\\|.*"]
notEqualsstring[]

Exclude using exact matching

Default value: ##default
notMatchesstring[]

Exclude using regex matching

Default value: ##default
includeDeletedboolean

If false or undefined only returns non deleted assets. If true also includes deleted assets

Default value: false
updatedAtAfterstring

Filter on assets updated after this date. Use ISO 8601 format

Default value: ##default
Example: 2025-11-10
representations object
isPresentboolean

Filter on assets having or not a representation. true: Only assets with representation. false: Only assets without representation. If not specified, return both assets having or not a representation

Default value: false
SearchAssetFilters
{
  "asset": {
    "uid": "519c00c9-29b1-4e16-8ed2-61bb4a8d6249",
    "externalIds": {
      "CODE": "001"
    }
  },
  "parent": {
    "uid": "519c00c9-29b1-4e16-8ed2-61bb4a8d6249",
    "externalIds": {
      "CODE": "001"
    }
  },
  "parentRecursive": {
    "uid": "519c00c9-29b1-4e16-8ed2-61bb4a8d6249",
    "externalIds": {
      "CODE": "001"
    }
  },
  "child": {
    "uid": "519c00c9-29b1-4e16-8ed2-61bb4a8d6249",
    "externalIds": {
      "CODE": "001"
    }
  },
  "name": {
    "equals": [
      "BUILDING_GROUP"
    ],
    "matches": [
      "EQUIPMENT|.*"
    ],
    "notEquals": [
      "string"
    ],
    "notMatches": [
      "string"
    ]
  },
  "type": {
    "equals": [
      "BUILDING_GROUP"
    ],
    "matches": [
      "EQUIPMENT|.*"
    ],
    "notEquals": [
      "string"
    ],
    "notMatches": [
      "string"
    ]
  },
  "includeDeleted": false,
  "updatedAtAfter": "2025-11-10",
  "representations": {
    "isPresent": false
  }
}