This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a query to retrieve a list of extended fields.
The queryExtendedFields()
function builds a query to retrieve a list of extended fields and returns an FieldsQueryBuilder
object.
The returned object contains the query definition, which is used to run the query using the find()
function.
You can refine the query by chaining FieldsQueryBuilder
functions onto the query. FieldsQueryBuilder
functions enable you to filter, sort, and control the results that queryExtendedFields()
returns.
queryExtendedFields()
runs with these FieldsQueryBuilder
defaults, which you can override:
skip()
limit(50)
descending('_createdDate')
The following FieldsQueryBuilder
functions are supported for queryExtendedFields()
. For a full description of the Extended Field
object, see the object returned for the items
property in FieldsQueryResult
.
PROPERTY | SUPPORTED FILTERS & SORTING |
---|---|
namespace | eq() ,ne() |
key | eq() ,ne() ,in() |
displayName | eq() ,ne() ,in() ,startsWith() ,ascending() ,descending() |
dataType | eq() ,ne() |
fieldType | eq() |
_createdDate | eq() ,ne() ,gt() ,lt() ,ge() ,le() ,ascending() ,descending() |
_updatedDate | eq() ,ne() ,gt() ,lt() ,ge() ,le() ,ascending() ,descending() |
This function requires elevated permissions and runs only on the backend and on dashboard pages.