Specific properties

In addition to the generic properties, it is also possible to query for specific named properties.

Root taxonomy item

To query all entities that represent a root taxonomy item, use the IsRootTaxonomyItem property:

RequestResponse
GET http://<HOSTNAME>/api/entities/query?query=IsRootTaxonomyItem

To negate the IsRootTaxonomyItem property, use an exclamation mark:

RequestResponse
GET http://<HOSTNAME>/api/entities/query?query=!IsRootTaxonomyItem

Definition ID

To query for all entities that have a certain definition ID, use the Definition.id property:

RequestResponse
GET http://<HOSTNAME>/api/entities/query?query=Definition.Id==22
Note

This property only supports == and != operators.

Definition name

To query for all entities that have a certain definition name, use the Definition.Name property:

RequestResponse
GET http://<HOSTNAME>/api/entities/query?query=Definition.Name=='M.Asset'
Note

This property only supports == and != operators.

Tip

We recommend to limit queries by including one of the definition restrictions. It improves performance and avoids unexpected results (e.g. a request returns files but you only want assets).

Locked by

To query for all assets locked by a certain user ID, use the LockedBy property:

RequestResponse
GET http://<HOSTNAME>/api/entities/query?query=Definition.Name=='M.Asset' AND LockedBy==3
Note

This property only supports == and != operators.

Locked

To query for all locked assets, use the Locked property:

RequestResponse
GET http://<HOSTNAME>/api/entities/query?query=Definition.Name=='M.Asset' AND Locked
Note

This property does not support any operators, but can be negated.

Created by

To query for all assets created by a certain user ID, use the CreatedBy property:

RequestResponse
GET http://<HOSTNAME>/api/entities/query?query=Definition.Name=='M.Asset' AND CreatedBy==3
Note

This property only supports == and != operators.

Modified by

To query for all assets last modified by a certain user ID, use the ModifiedBy property:

RequestResponse
GET http://<HOSTNAME>/api/entities/query?query=Definition.Name=='M.Asset' AND ModifiedBy==3
Note

This property only supports == and != operators.

Do you have some feedback for us?

If you have suggestions for improving this article,