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

{
  "sections": [
    "title",
    "description",
    "supported_soap_calls",
    "supported_rest_api_http_methods",
    "fields",
    "sub_types",
    "special_access_rules",
    "wsdl_segment"
  ],
  "title": "FormulaFunction - Tooling API",
  "description": "Represents a function used when building a formula, including examples and uses. This object is available in Tooling API version 39.0 and later.",
  "supported_soap_calls": "`describeSObjects()`, `query()`",
  "supported_rest_api_http_methods": "`GET`",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "Category": {
      "type": "FormulaFunctionCategory",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "TheFormulaFunctionCategory to which the formula belongs."
    },
    "CategoryId": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the FormulaFunctionCategory."
    },
    "Description": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Description of the formula function."
    },
    "DurableId": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Unique identifier for the field. Always retrieve this value before using it, as the value isn’t guaranteed to stay the same from one release to the next. To simplify queries, use this field."
    },
    "ExampleString": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Describes the function and what arguments you can use with it."
    },
    "IsAllowedInEntityContext": {
      "type": "boolean",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Removed. Indicates whether you can use the formula function on an Entity (true) or not (false). For example, you can’t use the PRIORVALUE function in a custom Account formula field. This field is available in API versions 39.0 to 47.0. Use the FormulaFunctionAllowedType object in API version 48.0 and later."
    },
    "IsAllowedInFlowContext": {
      "type": "boolean",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Removed. Indicates whether the formula function is allowed in a Flow (true) or not (false). This field is available in API versions 39.0 to 47.0. Use the FormulaFunctionAllowedType object instead in API version 48.0 and later."
    },
    "IsAllowedInVisualforceContext": {
      "type": "boolean",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Removed. Indicates whether the formula function is allowed in Visualforce (true) or not (false). This field is available in API versions 39.0 to 47.0. Use the FormulaFunctionAllowedType object instead in API version 48.0 and later."
    },
    "Label": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The formula function label that appears in the user interface."
    },
    "Name": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The name of the formula function."
    },
    "Types": {
      "type": "QueryResult",
      "properties": "Filter, Group, Nillable, RestrictedPicklist, Sort",
      "description": "Allowed formula types for functions."
    }
  },
  "sub_types": {
    "FormulaFunctionCategory": {
      "DurableId": {
        "type": "string",
        "properties": "Filter, Group, Nillable, Sort",
        "description": "Unique identifier for the field. Always retrieve this value before using it, as the value isn’t guaranteed to stay the same from one release to the next. To simplify queries, use this field."
      },
      "Functions": {
        "type": "QueryResult",
        "properties": "Filter, Group, Nillable, Sort",
        "description": "A list of functions that belong to the FormulaFunctionCategory."
      },
      "Label": {
        "type": "string",
        "properties": "Filter, Group, Nillable, Sort",
        "description": "Label of the FormulaFunctionCategory that appears in the user interface."
      },
      "Name": {
        "type": "string",
        "properties": "Filter, Group, Nillable, Sort",
        "description": "Name of the FormulaFunctionCategory."
      }
    }
  },
  "special_access_rules": "In API version 45.0 and later, only users with the ViewSetup and Configuration permission can access FormulaFunction or FormulaFunctionCategory.",
  "wsdl_segment": "```xml\n<xsd:complexType name=\"FormulaFunction\">\n  <xsd:complexContent>\n    <xsd:extension base=\"ens:sObject\">\n      <xsd:sequence>\n        <xsd:element name=\"Category\" minOccurs=\"0\" type=\"ens:FormulaFunctionCategory\" nillable=\"true\"/>\n        <xsd:element name=\"CategoryId\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n        <xsd:element name=\"Description\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n        <xsd:element name=\"DurableId\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n        <xsd:element name=\"ExampleString\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n        <xsd:element name=\"Label\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n        <xsd:element name=\"Name\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n        <xsd:element name=\"Types\" minOccurs=\"0\" type=\"tns:QueryResult\" nillable=\"true\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"QueryLocator\">\n  <xsd:restriction base=\"xsd:string\"/>\n</xsd:simpleType>\n<xsd:complexType name=\"QueryResult\">\n  <xsd:sequence>\n    <xsd:element name=\"done\" type=\"xsd:boolean\"/>\n    <xsd:element name=\"entityTypeName\" type=\"xsd:string\"/>\n    <xsd:element name=\"nextRecordsUrl\" minOccurs=\"0\" type=\"xsd:string\"/>\n    <xsd:element name=\"queryLocator\" type=\"tns:QueryLocator\"/>\n    <xsd:element name=\"records\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"ens:sObject\"/>\n    <xsd:element name=\"size\" type=\"xsd:int\"/>\n    <xsd:element name=\"totalSize\" type=\"xsd:int\"/>\n  </xsd:sequence>\n</xsd:complexType>\n```"
}