Skip Navigation

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

Limitations

SOQL Limitations

SOSL Limitations

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