{
  "sections": [
    "title",
    "description",
    "supported_soap_calls",
    "supported_rest_api_http_methods",
    "fields",
    "wsdl_segment"
  ],
  "title": "IndexField - Tooling API",
  "description": "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_api_http_methods": "`GET`",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "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."
    }
  },
  "wsdl_segment": "```xml\n<xsd:simpleType name=\"ID\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:length value=\"18\"/>\n    <xsd:pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"IndexField\">\n  <xsd:complexContent>\n    <xsd:extension base=\"ens:sObject\">\n      <xsd:sequence>\n        <xsd:element name=\"CreatedBy\" minOccurs=\"0\" type=\"ens:User\" nillable=\"true\"/>\n        <xsd:element name=\"CreatedById\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n        <xsd:element name=\"CreatedDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n        <xsd:element name=\"Field\" minOccurs=\"0\" type=\"ens:CustomField\" nillable=\"true\"/>\n        <xsd:element name=\"FieldId\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n        <xsd:element name=\"Index\" minOccurs=\"0\" type=\"ens:Index\" nillable=\"true\"/>\n        <xsd:element name=\"IndexId\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n        <xsd:element name=\"IsDeleted\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n        <xsd:element name=\"LastModifiedBy\" minOccurs=\"0\" type=\"ens:User\" nillable=\"true\"/>\n        <xsd:element name=\"LastModifiedById\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n        <xsd:element name=\"LastModifiedDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n        <xsd:element name=\"ManageableState\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n        <xsd:element name=\"Ordinal\" minOccurs=\"0\" type=\"xsd:int\" nillable=\"true\"/>\n        <xsd:element name=\"SortDirection\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n        <xsd:element name=\"SystemModstamp\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```"
}