Skip to main content

SearchAssetsResponse

assets object[]required
  • Array [
  • uidstring | nullnullable
    namestring | nullnullable
    updatedAtstring | nullnullable
    typestring | nullnullable
    parent object
    oneOf
    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
    groupedBy object[]
  • 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
  • ]
  • deletedAtstring | nullnullable
    externalIds object | null
    property name*string
    properties object
    oneOf
    simple object | null

    Current reference value of each requested property, as a flat {code: value} map

    property name*string
    precise object | null

    Each requested property mapped to its list of value entries, each carrying its source, validity window and reference flag

    property name* object[]
  • Array [
  • rawValuestringrequired
    sourcestring | nullnullable

    Raw source name of the value (e.g. REVIT, IKOS, DATALAKE), or the userUid for a manual (USER) source

    startDatestring | nullnullable

    Start of the value validity window; null when open (min system date)

    endDatestring | nullnullable

    End of the value validity window; null when open (max system date)

    isReferencebooleanrequired

    Whether this value is the reference (elected) value among its sources

  • ]
  • representations object
    oneOf
    box
    outlinesobject[][]nullable
    face
    backgroundstring | nullnullable
    effectiveDatestring | nullnullable
    expirationDatestring | nullnullable
    integrationDatestring | nullnullable
    childCount(integer | null)<int64>nullable
    containsChildCount(integer | null)<int64>nullable
    groupsChildCount(integer | null)<int64>nullable
  • ]
  • paginate objectrequired
    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
    SearchAssetsResponse
    {
    "assets": [
    {
    "uid": "string",
    "name": "string",
    "updatedAt": "string",
    "type": "string",
    "parent": {
    "uid": "519c00c9-29b1-4e16-8ed2-61bb4a8d6249",
    "externalIds": {
    "CODE": "001"
    }
    },
    "groupedBy": "Unknown Type: array,null",
    "deletedAt": "string",
    "externalIds": "Unknown Type: object,null",
    "properties": {
    "simple": "Unknown Type: object,null",
    "precise": "Unknown Type: object,null"
    },
    "representations": {
    "box": {},
    "outlines": "Unknown Type: array,null",
    "face": {},
    "background": "string"
    },
    "effectiveDate": "string",
    "expirationDate": "string",
    "integrationDate": "string",
    "childCount": 0,
    "containsChildCount": 0,
    "groupsChildCount": 0
    }
    ],
    "paginate": {
    "size": 50,
    "cursor": "0"
    }
    }