Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

IndexField

Represents the fields in the index of a custom big object. Available in Tooling API version 41.0 and later.

Supported SOAP Calls

query(), retrieve().

Supported REST HTTP Methods

GET

Limitations

SOQL Limitations

SOSL Limitations

Fields

Field	Details
FieldId	Type reference Properties Filter, Group, Sort Description ID of the custom field definition.
Id	Type ID Properties Filter, Group, Sort Description ID of the custom index field.
IndexId	Type reference Properties Filter, Group, Sort Description ID of the custom index.
ManageableState	Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: `beta` `deleted` `deprecated` `deprecatedEditable` `installed` `installedEditable` `released` `unmanaged`
Ordinal	Type int Properties Filter, Group, Sort Description The field’s position in the index. Used to determine the order of the fields in the index.
SortDirection	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The sort direction of the field in the index. Valid values are `ASC` for ascending order and `DESC` for descending order.