---
schema_version: "1"
id: 2bd1e41741c1fbb183d325eea845aeec94064e85596943a9c623c72cb78ef8fc
title: Index
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_index.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_index.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 19829663678ae822079e1126c7534222d051b89fb9ca6717fde59f071dc34166
description: Represents the index defined within a custom big object. Available in Tooling API version 41.0 and later.
---
# Index

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

## Supported SOAP Calls

query(), retrieve()

## Supported REST HTTP Methods

Query, 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 |
| --- | --- |
| DeveloperName | 
Type

string

Properties

Filter, Group, Sort

Description

The unique name of the record in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated, but you can supply your own value if you create the record using the API.



 |
| Label | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

This name is used to refer to the big object in the user interface. Available API version 41.0 and later.



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





 |
| MasterLabel | 

Type

string

Properties

Filter, Group, Sort

Description

Master label for the Index. This internal label doesn’t get translated.



 |
| NamespacePrefix | 

Type

string

Properties

Filter, Group, Nillable, Sort

Description

A unique string to distinguish this type from any others.



 |
| SobjectType | 

Type

picklist

Properties

Filter, Group, Restricted picklist, Sort

Description

The type of standard object that this record type is derived from. In this case, the parent big object.



 |
| Type | 

Type

picklist

Properties

Filter, Group, Restricted picklist, Sort

Description

The type of index. Valid values are PRIMARY or SECONDARY.



 |

## Usage

REST GET

{
  "attributes" : {
    "type" : "Index",
    "url" : "/services/data/v41.0/tooling/sobjects/Index/0c0D000000000GUIAY"
  },
  "Id" : "0c0D000000000GUIAY",
  "SobjectType" : "01ID0000000AwIcMAK",
  "DeveloperName" : "BigObject\_PK",
  "MasterLabel" : "BigOBject\_PK",
  ...
  "Type" : "PRIMARY"
}