Filter: KeyValuePairFilter

Filter type for KeyValuePair.

All fields in this type are and-combined; see the or field for or-combination.


Input Fields

NameTypeDescription
ANDKeyValuePairFilter

A field that checks if all filters in the list apply

If the list is empty, this filter applies to all objects.

ORKeyValuePairFilter

A field that checks if any of the filters in the list apply.

If the list is empty, this filter applies to no objects.

Note that only the items in the list or-combined; this complete OR field is and-combined with outer fields in the parent filter type.

createdAtDateTime

Checks if createdAt equals a specified value.

If an index exists on createdAt, it can be used.

The instant this object has been created

createdAt_gtDateTime

Checks if createdAt is greater than a specified value.

The instant this object has been created

createdAt_gteDateTime

Checks if createdAt is greater or equal a specified value.

The instant this object has been created

createdAt_inDateTime

Checks if createdAt is equal to one of the specified values.

The instant this object has been created

createdAt_ltDateTime

Checks if createdAt is less than a specified value.

The instant this object has been created

createdAt_lteDateTime

Checks if createdAt is less or equal a specified value.

The instant this object has been created

createdAt_notDateTime

Checks if createdAt does not equal a specified value

The instant this object has been created

createdAt_not_inDateTime

Checks if createdAt is not equal to one of the specified values.

The instant this object has been created

idID

Checks if id equals a specified value.

If an index exists on id, it can be used.

An auto-generated string that identifies this child entity uniquely within this collection of child entities

id_gtID

Checks if id is greater than a specified value.

An auto-generated string that identifies this child entity uniquely within this collection of child entities

id_gteID

Checks if id is greater or equal a specified value.

An auto-generated string that identifies this child entity uniquely within this collection of child entities

id_inID

Checks if id is equal to one of the specified values.

An auto-generated string that identifies this child entity uniquely within this collection of child entities

id_ltID

Checks if id is less than a specified value.

An auto-generated string that identifies this child entity uniquely within this collection of child entities

id_lteID

Checks if id is less or equal a specified value.

An auto-generated string that identifies this child entity uniquely within this collection of child entities

id_notID

Checks if id does not equal a specified value

An auto-generated string that identifies this child entity uniquely within this collection of child entities

id_not_inID

Checks if id is not equal to one of the specified values.

An auto-generated string that identifies this child entity uniquely within this collection of child entities

keyString

Checks if key equals a specified string, case-sensitively.

If an index exists on key, it can be used.

See also like for a case-insensitive filter.

The key value

key_containsString

Checks if key contains a specified string, case-sensitively.

The key value

key_ends_withString

Checks if key ends with a specified string, case-sensitively.

The key value

key_gtString

Checks if key is greater than a specified value.

The key value

key_gteString

Checks if key is greater or equal a specified value.

The key value

key_inString

Checks if key is equal to one of the specified values.

The key value

key_likeString

Matches key against a pattern case-insensitively with the following placeholders:

% matches any sequence of characters, including the empty string; _ matches exactly one character; \ can be used to escape the placeholders (use \\ for a literal backslash);

If an index exists on key, it can be used for the literal prefix (the part until the first placeholder).

The key value

key_ltString

Checks if key is less than a specified value.

The key value

key_lteString

Checks if key is less or equal a specified value.

The key value

key_notString

Checks if key does not equal a specified string, case-sensitively.

The key value

key_not_containsString

Checks if key does not contain a specified string, case-sensitively.

The key value

key_not_ends_withString

Checks if key does not end with a specified string, case-sensitively.

The key value

key_not_inString

Checks if key is not equal to one of the specified values.

The key value

key_not_likeString

Checks if key does not match a pattern case-insensitively with the following placeholders:

% matches any sequence of characters, including the empty string; _ matches exactly one character; \ can be used to escape the placeholders (use \\ for a literal backslash);

The key value

key_not_starts_withString

Checks if key does not start with a specified string, case-sensitively.

Never uses an index. Consider using not_like (with the % placeholder) for a case-insensitive filter that can use an index.

The key value

key_starts_withString

Checks if key starts with a specified string, case-sensitively.

Never uses an index. Consider using like (with the % placeholder) for a case-insensitive filter that can use an index.

The key value

updatedAtDateTime

Checks if updatedAt equals a specified value.

If an index exists on updatedAt, it can be used.

The instant this object has been updated the last time

updatedAt_gtDateTime

Checks if updatedAt is greater than a specified value.

The instant this object has been updated the last time

updatedAt_gteDateTime

Checks if updatedAt is greater or equal a specified value.

The instant this object has been updated the last time

updatedAt_inDateTime

Checks if updatedAt is equal to one of the specified values.

The instant this object has been updated the last time

updatedAt_ltDateTime

Checks if updatedAt is less than a specified value.

The instant this object has been updated the last time

updatedAt_lteDateTime

Checks if updatedAt is less or equal a specified value.

The instant this object has been updated the last time

updatedAt_notDateTime

Checks if updatedAt does not equal a specified value

The instant this object has been updated the last time

updatedAt_not_inDateTime

Checks if updatedAt is not equal to one of the specified values.

The instant this object has been updated the last time

valueString

Checks if value equals a specified string, case-sensitively.

If an index exists on value, it can be used.

See also like for a case-insensitive filter.

The value associated to the key

value_containsString

Checks if value contains a specified string, case-sensitively.

The value associated to the key

value_ends_withString

Checks if value ends with a specified string, case-sensitively.

The value associated to the key

value_gtString

Checks if value is greater than a specified value.

The value associated to the key

value_gteString

Checks if value is greater or equal a specified value.

The value associated to the key

value_inString

Checks if value is equal to one of the specified values.

The value associated to the key

value_likeString

Matches value against a pattern case-insensitively with the following placeholders:

% matches any sequence of characters, including the empty string; _ matches exactly one character; \ can be used to escape the placeholders (use \\ for a literal backslash);

If an index exists on value, it can be used for the literal prefix (the part until the first placeholder).

The value associated to the key

value_ltString

Checks if value is less than a specified value.

The value associated to the key

value_lteString

Checks if value is less or equal a specified value.

The value associated to the key

value_notString

Checks if value does not equal a specified string, case-sensitively.

The value associated to the key

value_not_containsString

Checks if value does not contain a specified string, case-sensitively.

The value associated to the key

value_not_ends_withString

Checks if value does not end with a specified string, case-sensitively.

The value associated to the key

value_not_inString

Checks if value is not equal to one of the specified values.

The value associated to the key

value_not_likeString

Checks if value does not match a pattern case-insensitively with the following placeholders:

% matches any sequence of characters, including the empty string; _ matches exactly one character; \ can be used to escape the placeholders (use \\ for a literal backslash);

The value associated to the key

value_not_starts_withString

Checks if value does not start with a specified string, case-sensitively.

Never uses an index. Consider using not_like (with the % placeholder) for a case-insensitive filter that can use an index.

The value associated to the key

value_starts_withString

Checks if value starts with a specified string, case-sensitively.

Never uses an index. Consider using like (with the % placeholder) for a case-insensitive filter that can use an index.

The value associated to the key


This page was generated: 2024-05-17