Index

Represents the index defined within a custom big object.

Introduced in API version 41.0.

describeLayout(), describeSObjects(), query(), retrieve()

GET, HEAD, Query

SOQL Limitations

SOSL Limitations

• Type: string

• Required: No

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

• Type: string

• Required: No

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

• 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

• Type: string

• Required: No

• Properties: Filter, Group, Sort

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

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: A unique string to distinguish this type from any others.

• Type: picklist

• Required: No

• 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: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: The type of index. Valid values are PRIMARY or SECONDARY.

• Possible values:

  • PRIMARY — Primary

  • SECONDARY — Secondary

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}