Filter syntax - HxGN SDx - Update 63 - Administration & Configuration - Hexagon

HxGN SDx API Services Configuration

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

The following examples show the standard OData filter syntax you can use to create your GET.

Operator

Meaning

Example

(

Changes the precedence of operators

Evaluates which operator to run.

)

Changes the precedence of operators

Evaluates which operator to run.

and

The two surrounding terms both must be true for an object for it to show up in the results

$filter=Class eq 'SPFFolder' and Name eq 'myfolder'

or

At least one of the surrounding terms must be true about an object for it to show up in the results

filter=Name eq 'myfolder' or Name eq 'folder3'

eq

Equal to

$filter=Name eq 'TagA'

ne

Not equal to

$filter=Name ne 'TagA'

eq null

Finds values that are null or empty

$filter=Description eq null​

any

Filters on the presence of any related types matching the criteria

$filter=Documents/any(doc: length(doc/Name) gt 0)

nested any

Filters on the presence of related criteria across two levels

$filter=Interfaces eq 'ISPFFunctionalUnit' and SPFFunctionalAreaUnits_12/any(Area: SPFPlantAreas_12/any(Plant: Plant/Name eq 'PlantA'))

all

Filters based on all related types matching the criteria

$filter=Documents/all(doc: length(doc/Name) gt 0)

contains

Filters based on the related types contains the value

$filter=contains(Name,'Utilities')