SearchAssetsRequest

Search criteria

search objectrequired

asset object

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

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

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

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

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

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

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

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

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

oneOf

• SearchAssetPropertyFilter
• null

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)

conditionsnull

Nested conditions (for and/or group operators)

]

paginate objectrequired

Size is set to 50 by default

sizeint32

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, effectiveDate, expirationDate, integrationDate.

Example: ["name","type"]

properties object

oneOf

• SearchAssetProperties
• null

simplestring[]required

Example: ["ADDRESS"]

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,
    "updatedAtAfter": "2025-11-10",
    "representations": {
      "isPresent": true
    },
    "properties": {
      "conditions": [
        {
          "op": "eq",
          "property": "ISSUES_NB",
          "value": "2",
          "values": "Unknown Type: array,null",
          "conditions": "null"
        }
      ]
    }
  },
  "paginate": {
    "size": 50,
    "cursor": "0"
  },
  "fields": [
    "name",
    "type"
  ],
  "properties": {
    "simple": [
      "ADDRESS"
    ]
  }
}