SearchAssetsRequest

search objectrequired

asset object

Identifier of the asset to search for

oneOf

• SearchAssetIds
• null

uidstring | nullnullable

Unique identifier for the asset (typically UUID)

Example: 519c00c9-29b1-4e16-8ed2-61bb4a8d6249

externalIds object | null

Must contains only one external system identifier

property name*string

assets object[]

List of asset identifiers to search for. Returns assets matching any of the provided identifiers.

Array [

uidstring | nullnullable

Unique identifier for the asset (typically UUID)

Example: 519c00c9-29b1-4e16-8ed2-61bb4a8d6249

externalIds object | null

Must contains only one external system identifier

property name*string

]

parent object

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

oneOf

• SearchAssetIds
• null

uidstring | nullnullable

Unique identifier for the asset (typically UUID)

Example: 519c00c9-29b1-4e16-8ed2-61bb4a8d6249

externalIds object | null

Must contains only one external system identifier

property name*string

parentRecursive object

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

oneOf

• SearchAssetIds
• null

uidstring | nullnullable

Unique identifier for the asset (typically UUID)

Example: 519c00c9-29b1-4e16-8ed2-61bb4a8d6249

externalIds object | null

Must contains only one external system identifier

property name*string

child object

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

oneOf

• SearchAssetIds
• null

uidstring | nullnullable

Unique identifier for the asset (typically UUID)

Example: 519c00c9-29b1-4e16-8ed2-61bb4a8d6249

externalIds object | null

Must contains only one external system identifier

property name*string

childRecursive object

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

oneOf

• SearchAssetIds
• null

uidstring | nullnullable

Unique identifier for the asset (typically UUID)

Example: 519c00c9-29b1-4e16-8ed2-61bb4a8d6249

externalIds object | null

Must contains only one external system identifier

property name*string

groupingParent object

Identifier of the grouping parent asset used to search for assets grouped under it (GROUPS relation)

oneOf

• SearchAssetIds
• null

uidstring | nullnullable

Unique identifier for the asset (typically UUID)

Example: 519c00c9-29b1-4e16-8ed2-61bb4a8d6249

externalIds object | null

Must contains only one external system identifier

property name*string

name object

oneOf

• SearchAssetFieldFilter
• null

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[]nullable

Exact matching

Example: ["BUILDING_GROUP"]

matchesstring[]nullable

Regex matching

Example: ["EQUIPMENT\\|.*"]

notEqualsstring[]nullable

Exclude using exact matching

notMatchesstring[]nullable

Exclude using regex matching

type object

oneOf

• SearchAssetFieldFilter
• null

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[]nullable

Exact matching

Example: ["BUILDING_GROUP"]

matchesstring[]nullable

Regex matching

Example: ["EQUIPMENT\\|.*"]

notEqualsstring[]nullable

Exclude using exact matching

notMatchesstring[]nullable

Exclude using regex matching

includeDeletedboolean | nullnullable

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

Default value: false

isDeletedboolean | nullnullable

If true, returns only soft-deleted assets. If false or undefined, returns only non-deleted assets. Cannot be combined with includeDeleted: true

includeExpiredboolean | nullnullable

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

Default value: false

updatedAtAfterstring | nullnullable

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

Example: 2025-11-10

representations object

oneOf

• SearchRepresentationsFilter
• null

isPresentbooleanrequired

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

properties object

Filter assets by property data values. Conditions are combined with implicit AND.

oneOf

• SearchAssetPropertyFilter
• null

Filter assets by property data values

conditions object[]required

List of conditions (implicit AND between root conditions)

Array [

opstringrequired

Condition operator

Possible values: [eq, neq, in, notIn, contains, notContains, regex, notRegex, gt, gte, lt, lte, isNull, isNotNull, and, or]

Example: eq

propertystring | nullnullable

Property code to filter on (leaf conditions only)

Example: ISSUES_NB

valuestring | nullnullable

Comparison value (single-value operators)

Example: 2

valuesstring[]nullable

Comparison values (for in/notIn operators)

conditions []

Nested conditions (for and/or group operators)

Array [

circular(SearchAssetDataCondition)

]

]

qstring | nullnullable

Free-text search over asset name and external id values (substring, case- and accent-insensitive). Between 3 and 500 characters. Combined with the other filters using AND, except includeDeleted and isDeleted: free-text search only covers non-deleted assets.

Example: 01S

paginate objectrequired

Size is set to 50 by default

sizeinteger<int32>

Number of results

Possible values: <= 2000

Default value: 50

cursorstring | nullnullable

A marker indicating the position in a dataset, used to determine where to continue fetching results in paginated data

Default value: 0

fieldsstring[]required

Fields to include in the response, in addition to uid which is always included. Allowed values are: uid, name, updatedAt, deletedAt, type, externalIds, representations, parent, groupedBy, effectiveDate, expirationDate, integrationDate, childCount, containsChildCount, groupsChildCount. childCount counts all children, containsChildCount only hierarchy (contains) children, groupsChildCount only grouped (GROUPS) children.

Example: ["name","type"]

properties object

oneOf

• SearchAssetProperties
• null

simplestring[]required

Property codes whose current reference value is returned as a flat {code: value} map.

Example: ["ADDRESS"]

precise object

Property codes returned with their source and reference metadata, as a list of timeline entries per code.

oneOf

• SearchAssetPreciseProperties
• null

codesstring[]required

Explicit property codes to return. The wildcard '*' is NOT supported for precise.

Example: ["TENANT_NAME"]

onlyReferenceboolean

If true (default) only the reference value is returned; if false all sources are returned.

Default value: true

startDatestring | nullnullable

Lower bound of the validity window (ISO 8601 date). Defaults to now.

Example: 2020-01-01

endDatestring | nullnullable

Upper bound of the validity window (ISO 8601 date). Defaults to now.

Example: 2035-01-01

SearchAssetsRequest

{
  "search": {
    "asset": {
      "uid": "519c00c9-29b1-4e16-8ed2-61bb4a8d6249",
      "externalIds": {
        "CODE": "001"
      }
    },
    "assets": "Unknown Type: array,null",
    "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"
      }
    },
    "childRecursive": {
      "uid": "519c00c9-29b1-4e16-8ed2-61bb4a8d6249",
      "externalIds": {
        "CODE": "001"
      }
    },
    "groupingParent": {
      "uid": "519c00c9-29b1-4e16-8ed2-61bb4a8d6249",
      "externalIds": {
        "CODE": "001"
      }
    },
    "name": {
      "equals": [
        "BUILDING_GROUP"
      ],
      "matches": [
        "EQUIPMENT|.*"
      ],
      "notEquals": "Unknown Type: array,null",
      "notMatches": "Unknown Type: array,null"
    },
    "type": {
      "equals": [
        "BUILDING_GROUP"
      ],
      "matches": [
        "EQUIPMENT|.*"
      ],
      "notEquals": "Unknown Type: array,null",
      "notMatches": "Unknown Type: array,null"
    },
    "includeDeleted": false,
    "isDeleted": true,
    "includeExpired": false,
    "updatedAtAfter": "2025-11-10",
    "representations": {
      "isPresent": true
    },
    "properties": {
      "conditions": [
        {
          "op": "eq",
          "property": "ISSUES_NB",
          "value": "2",
          "values": "Unknown Type: array,null",
          "conditions": "Unknown Type: array,null"
        }
      ]
    },
    "q": "01S"
  },
  "paginate": {
    "size": 50,
    "cursor": "0"
  },
  "fields": [
    "name",
    "type"
  ],
  "properties": {
    "simple": [
      "ADDRESS"
    ],
    "precise": {
      "codes": [
        "TENANT_NAME"
      ],
      "onlyReference": true,
      "startDate": "2020-01-01",
      "endDate": "2035-01-01"
    }
  }
}