Query: flexSearchTags

Queries for Tags using FlexSearch.

Return Type




Args

NameTypeDescription
afterString

If this is set to the value of the _cursor field of an item, only items after that one will be included in the result. The value of the after of this query must match the one where the _cursor value has been retrieved from.

filterTagFilter

Renamed to postFilter. Use postFilter instead.

firstInt

The number of items to include in the result. If omitted, all remaining items will be included (which can cause performance problems on large collections).

flexSearchFilterTagFlexSearchFilter
orderByTagOrderBy

Specifies the how this collection should be sorted. If omitted, the result order is not specified. If cursor-based pagination is used (i.e., the after is specified or the _cursor is requested), id_ASC will be implicitly added as last sort criterion so that the sort order is deterministic.

postFilterTagFilter

Filters that will be applied in memory after the flexSearchFilter.

This will not use any indices and will only work if applied on less than 10 000 objects.

skipInt

The number of items in the list or collection to skip. Is applied after the after argument if both are specified.


Properties

NameTypeDescription
_cursorString

Provides a value that can be supplied to the after argument for pagination. Depends on the value of the orderBy argument.

_revisionID

An identifier that is updated automatically on each update of this root entity (but not on relation changes)

colorString

A color associated with the tag, if any. This is used to visually color the instances of the tag in the UI.

createdAtDateTime

The instant this object has been created

createdByUser

The user who created the tag

descriptionString

A longer description of the tag

idID

An auto-generated string that identifies this root entity uniquely among others of the same type

nameString

The text of the tag. This appears in the UI and is what is searched for when filtering.

organizationOrganization

The Organization that this tag belongs to

updatedAtDateTime

The instant this object has been updated the last time (not including relation updates)

updatedByUser

The user who updated the tag, if it has been updated


This page was generated: 2024-05-17