Options
All
  • Public
  • Public/Protected
  • All
Menu

Module QueryableFieldDescription

An individual field that can be used as part of a query filter.

Enumerations

Properties

Functions

Properties

fieldName

fieldName: string

The name of the field to use when constructing the query. Field names are present for all types except OBJECT.

fieldType

fieldType: FieldType

The type of the field, which dictates what semantics and query constraints you can use when searching or querying.

Optional isArray

isArray: undefined | false | true

Indicates that this field is actually an array of the specified field type.

Optional objectProperties

objectProperties: Array<QueryableFieldDescription>

If the field type is OBJECT, then this property will provide all the individual properties of the object that can be queried.

Functions

getJsonObj