Filter: ExternalReferenceFilter

Filter type for ExternalReference.

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


Input Fields

NameTypeDescription
ANDExternalReferenceFilter

A field that checks if all filters in the list apply

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

ORExternalReferenceFilter

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.

categoryExternalReferenceCategory

Checks if category equals a specified value.

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

Specifies the category of the external reference.

category_inExternalReferenceCategory

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

Specifies the category of the external reference.

category_notExternalReferenceCategory

Checks if category does not equal a specified value

Specifies the category of the external reference.

category_not_inExternalReferenceCategory

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

Specifies the category of the external reference.

commentString

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

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

See also like for a case-insensitive filter.

An optional comment describing the external reference

comment_containsString

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

An optional comment describing the external reference

comment_ends_withString

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

An optional comment describing the external reference

comment_gtString

Checks if comment is greater than a specified value.

An optional comment describing the external reference

comment_gteString

Checks if comment is greater or equal a specified value.

An optional comment describing the external reference

comment_inString

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

An optional comment describing the external reference

comment_likeString

Matches comment 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 comment, it can be used for the literal prefix (the part until the first placeholder).

An optional comment describing the external reference

comment_ltString

Checks if comment is less than a specified value.

An optional comment describing the external reference

comment_lteString

Checks if comment is less or equal a specified value.

An optional comment describing the external reference

comment_notString

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

An optional comment describing the external reference

comment_not_containsString

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

An optional comment describing the external reference

comment_not_ends_withString

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

An optional comment describing the external reference

comment_not_inString

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

An optional comment describing the external reference

comment_not_likeString

Checks if comment 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);

An optional comment describing the external reference

comment_not_starts_withString

Checks if comment 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.

An optional comment describing the external reference

comment_starts_withString

Checks if comment 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.

An optional comment describing the external reference

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

extRefTypeExternalReferenceType

Checks if extRefType equals a specified value.

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

Specifies the type of the external reference.

extRefType_inExternalReferenceType

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

Specifies the type of the external reference.

extRefType_notExternalReferenceType

Checks if extRefType does not equal a specified value

Specifies the type of the external reference.

extRefType_not_inExternalReferenceType

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

Specifies the type of the external reference.

hashes_emptyBoolean

Checks if hashes is an empty list (true) or a non-empty list or null (false).

hashes_everyHashFilter

Makes sure all items in hashes match a certain filter.

hashes_noneHashFilter

Makes sure none of the items in hashes match a certain filter.

Note that you can specify the empty object for this filter to make sure hashes has no items.

hashes_someHashFilter

Makes sure at least one of the items in "hashes" matches a certain filter.

Note that you can specify the empty object for this filter to make sure hashes has at least one item.

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

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 URL to the external reference

value_containsString

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

The URL to the external reference

value_ends_withString

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

The URL to the external reference

value_gtString

Checks if value is greater than a specified value.

The URL to the external reference

value_gteString

Checks if value is greater or equal a specified value.

The URL to the external reference

value_inString

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

The URL to the external reference

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 URL to the external reference

value_ltString

Checks if value is less than a specified value.

The URL to the external reference

value_lteString

Checks if value is less or equal a specified value.

The URL to the external reference

value_notString

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

The URL to the external reference

value_not_containsString

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

The URL to the external reference

value_not_ends_withString

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

The URL to the external reference

value_not_inString

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

The URL to the external reference

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 URL to the external reference

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 URL to the external reference

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 URL to the external reference


This page was generated: 2024-11-06