Index Object


An index is a map of a collection's data, organized according to specific fields to increase query speed.

Properties
caseInsensitiveboolean

Whether the index ignores case.

Default: false


failureFailureRead-only

Contains details about the reasons for failure when status is FAILED.


fieldsArray <Field>minItems 1maxItems 3

Fields for which the index is defined.

Max: 3 fields (for a unique index: 1 field)


idstringRead-onlyformat GUID

ID of the index.


namestringminLength 1maxLength 128

Name of the index.


sourcestring

Source of the index. See index sources in Index Types.

Default: USER


statusstringRead-only

Current status of the index.


uniqueboolean

Whether the index enforces uniqueness of values in the field for which it's defined. If true, the index can have only 1 field.

Default: false

Did this help?