Newer Version Available

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

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

Fields

Field Details
Id
Type
ID
Properties
Filter, Group, Sort
Description
ID of the custom index.
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.
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
  • installed
  • released
  • unmanaged

For more information about states of manageability for components in Force.com AppExchange packages, see “Planning the Release of Managed Packages” in the Salesforce online help.

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
1{
2  "attributes" : {
3    "type" : "Index",
4    "url" : "/services/data/v41.0/tooling/sobjects/Index/0c0D000000000GUIAY"
5  },
6  "Id" : "0c0D000000000GUIAY",
7  "SobjectType" : "01ID0000000AwIcMAK",
8  "DeveloperName" : "BigObject_PK",
9  "MasterLabel" : "BigOBject_PK",
10  ...
11  "Type" : "PRIMARY"
12}