Filters



QueryFilterBase [Schema]

The filter base type. Used for filtering matched entities.

Name Type Required Description

ActiveOn

Interits from: QueryFilterBase

The active on filter. Allows entity filtering on objects that have start and end date properties. Also supports ongoing, open ended objects.

Name Type Required Description
Value xsd:string no The effective date. Used as the target of the Active on test. Variable names are allowed.

Between

Interits from: QueryFilterBase

The between filter. Allows entity filtering by properties between two values. Values outside the specified range will be excluded from the matched results.

  • Supported property data types:
  • Integer
  • Decimal
  • Date Time

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Value xsd:string no The first filter value. Represents the lower level of the between filter. Variable names are allowed.
Value2 xsd:string no The second filter value. Represents the upper level of the between filter. Variable names are allowed.

Contain

Interits from: QueryFilterBase

The contain filter. Allows entity filtering by properties containing the specified value. Properties that do not contain the specified value will be excluded from the matched results.

  • Supported property data types:
  • String

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Value xsd:string no The filter value. The value to be used in the filter. Variable names are allowed.

EndsWith

Interits from: QueryFilterBase

The ends with filter. Matches entities having the property ending with the specified value.

  • Supported property data types:
  • String

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Value xsd:string no The filter value. The value to be used in the filter. Variable names are allowed.

EqualTo

Interits from: QueryFilterBase

The equal to filter. Matches entities having the property matching specified value.

  • Supported property data types:
  • Boolean
  • Date Time
  • Decimal
  • Integer
  • String

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Value xsd:string no The filter value. The value to be used in the filter. Variable names are allowed.

GreaterThan

Interits from: QueryFilterBase

The greater than filter. Matches entities having the property greater than the specified value.

  • Supported property data types:
  • Date Time
  • Decimal
  • Integer

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Value xsd:string no The filter value. The value to be used in the filter. Variable names are allowed.

GreaterThanEqualTo

Interits from: QueryFilterBase

The greater than or equal to filter. Matches entities having the property greater than or equal to the specified value.

  • Supported property data types:
  • Date Time
  • Decimal
  • Integer

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Value xsd:string no The filter value. The value to be used in the filter. Variable names are allowed.

IsNotNull

Interits from: QueryFilterBase

The is not null filter. Matches entities having a non-null property value.

  • Supported property data types:
  • Object
  • String

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.

IsNull

Interits from: QueryFilterBase

The is null filter. Matches entities having a null property value.

  • Supported property data types:
  • Object
  • String

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.

LessThan

Interits from: QueryFilterBase

The less than filter. Matches entities having the property less than the specified value.

  • Supported property data types:
  • Date Time
  • Decimal
  • Integer

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Value xsd:string no The filter value. The value to be used in the filter. Variable names are allowed.

LessThanEqualTo

Interits from: QueryFilterBase

The less than or equal to filter. Matches entities having the property less than or equal to the specified value.

  • Supported property data types:
  • Date Time
  • Decimal
  • Integer

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Value xsd:string no The filter value. The value to be used in the filter. Variable names are allowed.

NotContain

Interits from: QueryFilterBase

The not contain filter. Allows entity filtering by properties that do not contain the specified value. Properties that do contain the specified value will be excluded from the matched results.

  • Supported property data types:
  • String

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Value xsd:string no The filter value. The value to be used in the filter. Variable names are allowed.

NotEqualTo

Interits from: QueryFilterBase

The not equal to filter. Matches entities with a property not matching specified value.

  • Supported property data types:
  • Boolean
  • Date Time
  • Decimal
  • Integer
  • String

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Value xsd:string no The filter value. The value to be used in the filter. Variable names are allowed.

NotWithinArray

Interits from: QueryFilterBase

The not within array query filter. Matches entities with a property not included in the specified array. Array values should be represented as comma separated list.

  • Supported property data types:
  • String
  • Date Time (yyyy-MM-dd,yyyy-MM-dd)

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Value xsd:string no The filter array value. Represents a comma separated list of values to be used in the filter evaluation. Variable names are allowed.

OfType

Interits from: QueryFilterBase

The of type query filter. Matches entities of the specified type only. Types should be represented as the type name only. E.g: PayLinePension

  • Supported property data types:
  • String

Name Type Required Description
Value xsd:string no The filter value. The value to be used in the filter. Variable names are allowed.

StartsWith

Interits from: QueryFilterBase

The starts with filter. Matches entities having the property starting with the specified value.

  • Supported property data types:
  • String

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Value xsd:string no The filter value. The value to be used in the filter. Variable names are allowed.

TakeFirst

Interits from: QueryFilterBase

The take first filter. Matches the specified number of entities from the matched entity group.

Name Type Required Description
Value xsd:int ( min: 0) no The number of entities to match. The value must be a non-negative integer. Variable names are allowed.

WithinArray

Interits from: QueryFilterBase

The within array query filter. Matches entities with a property value included in the specified array. Array values should be represented as comma separated list.

  • Supported property data types:
  • String
  • Date Time (yyyy-MM-dd,yyyy-MM-dd)

Name Type Required Description
Property xsd:string
Pattern: [A-Za-z0-9_]+
no The property name. Indicates the entity property to be used in the filter expression.
Value xsd:string no The filter array value. Represents a comma separated list of values to be used in the filter evaluation. Variable names are allowed.