Properties Query

objectid
Or
externalId

Returns only the objects with their objectid or externalId attribute exactly matching one of the values specified in the array.

The first element of the array contains the name of the attribute to match (objectid or externalId). Subsequent elements contain the values to match.

For example, if you specify an array as: "$in":["objectid",1,2], the request will only return the properties of the objects with objectid 1 and 2. If you specify an array as "$in":["externalId","doc_982afc8a","doc_afd75233" ] the request will only return the properties of the objects with extermnalId doc_982afc8a and doc_afd75233.

prefix

Returns only the objects with their name attribute beginning with the specified string.

The first element of the array contains the name of the attribute to match (name). The second element contains the string to match. The array can have only two elements. Only the objects whose name begin with the specified string are returned.

equals to

Returns only the objects where the value of the specified attribute (name attribute or any numerical property) is exactly equal to the specified value.

The first element of the array contains the name of the attribute. This can be the name attribute or the name of a numerical property. The second element of the array must be the value to match. If the first element is name, must be a string value. If the first element is a numerical property, must be a numeric. The array can only be two elements long.

For example, if you specify an array as: "$eq":["name","Rectangular"], the request will only return the properties of the object named Rectangular. if you specify an array as: "$eq":["properties.Dimensions.Width1",0.6], the request will return the properties of all objects whose properties.Dimensions.Width1 property is exactly equal to 0.6.

Note: The value to compare must be specified in the system unit of that property. For example, if the system unit of the property is m, the value must be specified in m, and not in cm.

between

Returns only the objects where the value of the specified numerical property lies between the specified values.

The first element of the array contains the name of the property. The next two elements specify the values that the property must lie between. The array can only be three elements long.

For example, if you specify an array as: "$between":["properties.Dimensions.Width1",1,10], the request returns the properties of all objects whose properties.Dimensions.Width1 property is between 1 and 10.

Note: The value to compare must be specified in the system unit of that property. For example, if the system unit of the property is m, the value must be specified in m, and not in cm.

less than or
equal to

Returns only the objects where the value of the specified numerical property is less than or equal to the specified value.

The first element of the array contains the name of the property. The next element specifies the values that the property must be less than or equal to. The array can only be two elements long.

For example, if you specify an array as: "$le":["properties.Dimensions.Width1",10], the request returns the properties of all objects whose properties.Dimensions.Width1 property is less than or equal to 10.

Note: The value to compare must be specified in the system unit of that property. For example, if the system unit of the property is m, the value must be specified in m, and not in cm.

greater than or
equal to

Returns only the objects where the value of the specified numerical property is greater than or equal to the specified value.

The first element of the array contains the name of the property. The next element specifies the values that the property must be greater than or equal to. The array can only be two elements long.

For example, if you specify an array as: "$ge":["properties.Dimensions.Width1",0.1], the request returns the properties of all objects whose properties.Dimensions.Width1 property is greater than or equal to  0.1.

Note: The value to compare must be specified in the system unit of that property. For example, if the system unit of the property is m, the value must be specified in m, and not in cm.

contains

Returns only the objects where the value of the specified property contains the words specified in a string.

The first element of the array contains the name of the property. The second element contains a string containing the words to match. The array can only be two elements long.

For example, if you specify an array as: "$contains":["properties.Materials and Finishes.Structural Material","Concrete Situ"], the request returns the properties of all objects whose properties.Materials and Finishes.Structural Material property contains the words  Concrete and Situ. You can specify up to 50 words.

fields

object

Specifies what properties of the objects to return. If you do not specify this attribute, the response returns all properties.

Possible values:

Value
Meaning

properties Return all properties.

properties.something Return the property named something and all its children.

properties.some* Return all properties with names that begin with some and all their children.

properties.category.* Return the property named category and all its children.

properties.*.property Return any property named property regardless of its parent.

payload

enum

Specifies the format for numeric values in the response body. Possible values:

- text - (Default) Returns all properties requested in fields without applying any special formatting.
- unit - Applies a filter and returns only the properties that contain numerical values. Additionally, it formats property values as ##<VALUE_OF_PROPERTY><UNIT_OF_VALUE><PRECISION><SYSTEM_UNIT>. For example ##94.172{mm}[3]{m}, where 94.172 is the value of the property, {mm} is the unit of the value, [3] is the precision, and {m} is the system unit.

* Required