IndexField

Represents the fields in the index of a custom big object.

Version 

Introduced in API version 41.0.

Supported SOAP API Calls 

describeSObjects(), query(), retrieve()

Supported REST API Methods 

GET, HEAD, Query

Limitations 

SOQL Limitations

SOSL Limitations

Fields 

FieldId 

• Type: reference

• Required: No

• Properties: Filter, Group, Sort

• Description: ID of the custom field definition.

• Relationship name: Field

• Relationship type: relationship

IndexId 

• Type: reference

• Required: No

• Properties: Filter, Group, Sort

• Description: ID of the custom index.

• Relationship name: Index

• Relationship type: relationship

• Refers to: Index

ManageableState 

• Type: picklist

• Required: No

• 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

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

Ordinal 

• Type: int

• Required: No

• 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

• Required: No

• 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.

• Possible values:

  • ASC — Ascending

  • DESC — Descending