---
schema_version: "1"
id: 7cc3fb7b9ab9451f20b5243028368614cd9c6c3734ed5f6164a01229ad78e33d
title: IndexField
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_indexfield.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_indexfield.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 913d01409776392b2a0ec8ae1ba0a7ce76865d6b084b2db806b4c025cdecba2c
description: Represents the fields in the index of a custom big object. Available in Tooling API version 41.0 and later.
---
# 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](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/reference_objects_soql_limits.htm "Some Tooling API objects have SOQL limitations. These limitations apply to any Metadata Catalog query, which applies to all Custom Metadata Types and Metadata Catalog entities, not only the ones explicitly listed.")

[SOSL Limitations](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/reference_objects_sosl_limits.htm "Two Tooling API objects, EntityDefinition and FieldDefinition, have some SOSL limitations. ExternalString and MetadataComponentDependency (Beta) don’t support SOSL searches.")

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



 |