afv-library/skills/platform-data-and-tooling-api-context-get/assets/tooling_api/CustomField.json

{
  "sections": [
    "title",
    "description",
    "supported_soap_calls",
    "supported_rest_api_http_methods",
    "fields",
    "wsdl_segment"
  ],
  "title": "CustomField - Tooling API",
  "description": "Represents a custom field on a custom object that stores data unique to your organization. Includes access to the associated CustomField object and related fields in Salesforce Metadata API. Available from API version 28.0 or later.",
  "supported_soap_calls": "`create()`, `query()`, `retrieve()`, `search()`, `update()`, `upsert()`",
  "supported_rest_api_http_methods": "`Query`, `GET`, `POST`, `PATCH`",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "DeveloperName": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "The developer’s internal name for the custom field. For example, the internal name for the custom field CF__c is CF."
    },
    "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"
    },
    "Metadata": {
      "type": "CustomFieldMetadata",
      "properties": "Create, Nillable, Update",
      "description": "CustomFieldMetadata includes these fields. For more information, see CustomField in the Metadata API Developer Guide. caseSensitive complianceGroup defaultValue deleteConstraint deprecated* description displayFormat displayLocationInDecimal elementType* escapeMarkup externalDeveloperName externalId formula formulaTreatBlanksAs inlineHelpText isAIPredictionField isFilteringDisabled isNameField isSortingDisabled label length maskChar maskType picklist populateExistingRows precision readOnlyProxy referenceTo relationshipLabel relationshipName relationshipOrder reparentableMasterDetai required restrictedAdminField scale startingNumber stripMarkup summarizedField summaryFilterItems summaryForeignKey summaryOperation trackFeedHistory trackHistory type unique visibleLines writeRequiresMasterRead * Reserved for future use. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance."
    },
    "NamespacePrefix": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The namespace of the custom field. A custom field can be in an extension namespace different than the object."
    },
    "TableEnumOrId": {
      "type": "Restricted picklist",
      "properties": "Filter, Group, Sort",
      "description": "The enum (for example, Account) or ID of the object this field is on."
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"CustomField\">\n  <xsd:complexContent>\n    <xsd:extension base=\"ens:sObject\">\n      <xsd:sequence>\n        <xsd:element name=\"FullName\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n        <xsd:element name=\"Metadata\" minOccurs=\"0\" type=\"mns:CustomField\" nillable=\"true\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n\n\n<xsd:complexType name=\"CustomField\">\n  <xsd:complexContent>\n    <xsd:extension base=\"mns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"businessOwnerGroup\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"businessOwnerUser\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"businessStatus\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"caseSensitive\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"complianceGroup\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"customDataType\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"defaultValue\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"deleteConstraint\" minOccurs=\"0\" type=\"tns:DeleteConstraint\"/>\n        <xsd:element name=\"deprecated\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"displayFormat\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"elementType\" minOccurs=\"0\" type=\"tns:ElementType\"/>\n        <xsd:element name=\"encryptionScheme\" minOccurs=\"0\" type=\"tns:EncryptionScheme\"/>\n        <xsd:element name=\"escapeMarkup\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"externalDeveloperName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"externalId\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"formula\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"formulaTreatBlanksAs\" minOccurs=\"0\" type=\"tns:TreatBlanksAs\"/>\n        <xsd:element name=\"inlineHelpText\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"isAIPredictionField\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"isConvertLeadDisabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"isFilteringDisabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"isNameField\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"isSortingDisabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"label\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"length\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <xsd:element name=\"lookupFilter\" minOccurs=\"0\" type=\"mns:LookupFilter\"/>\n        <xsd:element name=\"maskChar\" minOccurs=\"0\" type=\"tns:EncryptedFieldMaskChar\"/>\n        <xsd:element name=\"maskType\" minOccurs=\"0\" type=\"tns:EncryptedFieldMaskType\"/>\n        <xsd:element name=\"metadataRelationshipControllingField\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"populateExistingRows\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"precision\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <xsd:element name=\"referenceTargetField\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"referenceTo\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"relationshipLabel\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"relationshipName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"relationshipOrder\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <xsd:element name=\"reparentableMasterDetail\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"required\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"restrictedAdminField\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"scale\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <xsd:element name=\"securityClassification\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"startingNumber\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <xsd:element name=\"stripMarkup\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"summarizedField\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"summaryFilterItems\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"mns:FilterItem\"/>\n        <xsd:element name=\"summaryForeignKey\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"summaryOperation\" minOccurs=\"0\" type=\"tns:SummaryOperations\"/>\n        <xsd:element name=\"trackFeedHistory\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"trackHistory\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"trackTrending\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"translateData\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"type\" minOccurs=\"0\" type=\"tns:FieldType\"/>\n        <xsd:element name=\"unique\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"valueSet\" minOccurs=\"0\" type=\"mns:ValueSet\"/>\n        <xsd:element name=\"visibleLines\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <xsd:element name=\"writeRequiresMasterRead\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"DeleteConstraint\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Cascade\"/>\n    <xsd:enumeration value=\"Restrict\"/>\n    <xsd:enumeration value=\"SetNull\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"ElementType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Float\"/>\n    <xsd:enumeration value=\"Text\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"EncryptedFieldMaskChar\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"asterisk\"/>\n    <xsd:enumeration value=\"X\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"EncryptedFieldMaskType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"all\"/>\n    <xsd:enumeration value=\"creditCard\"/>\n    <xsd:enumeration value=\"ssn\"/>\n    <xsd:enumeration value=\"lastFour\"/>\n    <xsd:enumeration value=\"sin\"/>\n    <xsd:enumeration value=\"nino\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"EncryptionScheme\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"None\"/>\n    <xsd:enumeration value=\"ProbabilisticEncryption\"/>\n    <xsd:enumeration value=\"CaseSensitiveDeterministicEncryption\"/>\n    <xsd:enumeration value=\"CaseInsensitiveDeterministicEncryption\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"FieldType\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"AutoNumber\"/>\n    <xsd:enumeration value=\"Lookup\"/>\n    <xsd:enumeration value=\"MasterDetail\"/>\n    <xsd:enumeration value=\"Checkbox\"/>\n    <xsd:enumeration value=\"Currency\"/>\n    <xsd:enumeration value=\"Date\"/>\n    <xsd:enumeration value=\"DateTime\"/>\n    <xsd:enumeration value=\"Email\"/>\n    <xsd:enumeration value=\"Number\"/>\n    <xsd:enumeration value=\"Percent\"/>\n    <xsd:enumeration value=\"Phone\"/>\n    <xsd:enumeration value=\"Picklist\"/>\n    <xsd:enumeration value=\"MultiselectPicklist\"/>\n    <xsd:enumeration value=\"Text\"/>\n    <xsd:enumeration value=\"TextArea\"/>\n    <xsd:enumeration value=\"LongTextArea\"/>\n    <xsd:enumeration value=\"Html\"/>\n    <xsd:enumeration value=\"Url\"/>\n    <xsd:enumeration value=\"EncryptedText\"/>\n    <xsd:enumeration value=\"Summary\"/>\n    <xsd:enumeration value=\"Hierarchy\"/>\n    <xsd:enumeration value=\"File\"/>\n    <xsd:enumeration value=\"MetadataRelationship\"/>\n    <xsd:enumeration value=\"Location\"/>\n    <xsd:enumeration value=\"ExternalLookup\"/>\n    <xsd:enumeration value=\"IndirectLookup\"/>\n    <xsd:enumeration value=\"CustomDataType\"/>\n    <xsd:enumeration value=\"Time\"/>\n    <xsd:enumeration value=\"Address\"/>\n    <xsd:enumeration value=\"Array\"/>\n    <xsd:enumeration value=\"Integer\"/>\n    <xsd:enumeration value=\"Long\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"SummaryOperations\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"count\"/>\n    <xsd:enumeration value=\"sum\"/>\n    <xsd:enumeration value=\"min\"/>\n    <xsd:enumeration value=\"max\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"TreatBlanksAs\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"BlankAsBlank\"/>\n    <xsd:enumeration value=\"BlankAsZero\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n```"
}