afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/FunctionInvocationRequest.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "usage"
  ],
  "title": "FunctionInvocationRequest - Data API",
  "description": "Represents invocation information for a Salesforce Function. This object is available in API version 51.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "CallbackStatus": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "The status of the callback for asynchronous invocations. This field is new in API version 52.0. Possible values are: Completed - Not used for the Salesforce Functions beta. Enqueued - The Function has completed (either successfully or unsuccessfully), and the callback has been enqueued for asynchronous execution in the Salesforce org. Failed - Not used for the Salesforce Functions beta. PendingResponse - The Function has not yet completed, so the callback has not been called yet. The default value is 'PendingResponse'."
    },
    "ExecutionTime": {
      "type": "long",
      "properties": "Filter, Group, Nillable, Sort, Update",
      "description": "The execution time of the Function in milliseconds."
    },
    "ExtendedResponse": {
      "type": "textarea",
      "properties": "Nillable, Update",
      "description": "JSON object with additional information about the result of the Function execution."
    },
    "FunctionName": {
      "type": "string",
      "properties": "Filter, Group, idLookup, Sort",
      "description": "Name of the Function that was invoked. This name is case-sensitive and uses the format “project name-function name”"
    },
    "InvokingNamespacePrefix": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Prefix of the namespace that invokes the function. A namespace can invoke the global function using an installed package via Apex."
    },
    "NamespacePrefix": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The namespace prefix that is associated with this object. This object is available in API version 53.0 and later. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation. The namespace prefix can have one of the following values. In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix."
    },
    "OwnerId": {
      "type": "reference",
      "properties": "Filter, Group, Sort, Update",
      "description": "The owner of the FunctionInvocationRequest. This is a polymorphic relationship field.",
      "relationship_name": "Owner",
      "relationship_type": "Lookup",
      "refers_to": "Group, User"
    },
    "ResponseBody": {
      "type": "base64",
      "properties": "Nillable, Update",
      "description": "Response body of the invoked Function."
    },
    "ResponseContentType": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Content type of the response body of the invoked Function. For example, the content type could be application/json, text/csv, or various other values depending on what the Function returned."
    },
    "ResponseLength": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Length of the response body."
    },
    "ResponseName": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort, Update",
      "description": "Name of response, not currently used."
    },
    "ResponseUncompressedLength": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort, Update",
      "description": "Uncompressed length of the Function response, if the response content was compressed."
    },
    "StackTrace": {
      "type": "textarea",
      "properties": "Nillable, Update",
      "description": "If there was an error invoking the function, this field contains the Function stack trace."
    },
    "Status": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Status of the invoked Function. Functions that are invoked asynchronously can be in a queued InProgress state before they are invoked. Possible values are: Dispatched - Not used for the Salesforce Functions beta. Error - The Function failed to execute due to either an error starting the Function, or an error while the Function was running. FunctionInProgress - The Function invocation has been sent to the Salesforce Functions compute environment, and is running. InProgress - The Function invocation request has been enqueued. New - The Function invocation request has been created, but not enqueued yet. Success - The Function has completed execution. For status on whether the callback has been called, see the CallbackStatus field. The default value is 'New'."
    }
  },
  "usage": "Treat FunctionInvocationRequest records as read-only records used to get information about a specific Function invocation. To invoke Functions, use the Apex functions.Function class invoke methods. FunctionInvocationRequest is not supported in Trialforce templates or org snapshots.\n\nTreat FunctionInvocationRequest records as read-only records used to get information about a specific Function invocation. To invoke Functions, use the Apex functions.Function class invoke methods.\n\nFunctionInvocationRequest is not supported in Trialforce templates or org snapshots."
}