mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-08 00:10:29 +08:00
215 lines
10 KiB
JSON
215 lines
10 KiB
JSON
{
|
|
"sections": [
|
|
"title",
|
|
"description",
|
|
"fields",
|
|
"special_access_rules",
|
|
"associated_objects",
|
|
"wsdl_segment",
|
|
"field_reference"
|
|
],
|
|
"title": "MacroUsage - Data API",
|
|
"description": "Represents macro usage on a record, including which macro was used, who used it, and how they used it. This object is available in API version 47.0 and later.",
|
|
"fields_columns": [
|
|
"type",
|
|
"properties",
|
|
"description"
|
|
],
|
|
"fields": {
|
|
"AppContext": {
|
|
"type": "picklist",
|
|
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
|
|
"description": "Context in which the macro was run. Possible values are: Aloha—Salesforce Classic Lightning—Lightning Experience Unknown"
|
|
},
|
|
"ConditionCount": {
|
|
"type": "int",
|
|
"properties": "Filter, Group, Nillable, Sort",
|
|
"description": "Number of conditional instructions contained in the macro at execution."
|
|
},
|
|
"ContextRecord": {
|
|
"type": "string",
|
|
"properties": "Filter, Group, Nillable, Sort",
|
|
"description": "ID of the record on which the macro was run."
|
|
},
|
|
"DurationInMs": {
|
|
"type": "int",
|
|
"properties": "Filter, Group, Nillable, Sort",
|
|
"description": "The execution time, in milliseconds, for the macro."
|
|
},
|
|
"ExecutedInstructionCount": {
|
|
"type": "int",
|
|
"properties": "Filter, Group, Nillable, Sort",
|
|
"description": "The number of macro instructions that ran successfully. If the macro completed successfully, this value is the same as InstructionCount."
|
|
},
|
|
"ExecutionEndTime": {
|
|
"type": "dateTime",
|
|
"properties": "Filter, Nillable, Sort",
|
|
"description": "The time at which macro execution completed."
|
|
},
|
|
"ExecutionState": {
|
|
"type": "picklist",
|
|
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
|
|
"description": "The end state of macro execution. Possible values are SUCCESS FAILURE CANCELED"
|
|
},
|
|
"FailureReason": {
|
|
"type": "picklist",
|
|
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
|
|
"description": "If ExecutionState is failure, this field stores the reason for the failure. Possible values are: ACCESS GENERIC TIMEOUT UNSUPPORTED"
|
|
},
|
|
"FolderId": {
|
|
"type": "reference",
|
|
"properties": "Filter, Group, Nillable, Sort",
|
|
"description": "ID of the folder containing the macro at the time it was used."
|
|
},
|
|
"InstructionCount": {
|
|
"type": "int",
|
|
"properties": "Filter, Group, Nillable, Sort",
|
|
"description": "The number of instructions in the macro at the start of execution."
|
|
},
|
|
"IsFromBulk": {
|
|
"type": "boolean",
|
|
"properties": "Defaulted on create, Filter, Group, Sort",
|
|
"description": "If true, the macro was run as a bulk macro. When a bulk macro is run on multiple records, usage is recorded per record."
|
|
},
|
|
"MacroID": {
|
|
"type": "reference",
|
|
"properties": "Filter, Group, Sort",
|
|
"description": "ID of the macro."
|
|
},
|
|
"Name": {
|
|
"type": "string",
|
|
"properties": "Filter, Group, idLookup, Sort",
|
|
"description": "Name of the macro."
|
|
},
|
|
"OwnerId": {
|
|
"type": "reference",
|
|
"properties": "Filter, Group, Sort",
|
|
"description": "ID of the group or user that owns the macro."
|
|
},
|
|
"UserId": {
|
|
"type": "reference",
|
|
"properties": "Filter, Group, Nillable, Sort",
|
|
"description": "ID of the user that ran the macro."
|
|
}
|
|
},
|
|
"special_access_rules": "This object is always read-only. Only users with “Modify All Data” permission can delete MacroUsage records.",
|
|
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **MacroUsageOwnerSharingRule**: Sharing rules are available for the object.\n- **MacroUsageShare**: Sharing is available for the object.",
|
|
"wsdl_segment": "```xml\n<simpleType name=\"ID\">\n <restriction base=\"xsd:string\">\n <length value=\"18\"/>\n <pattern value=\"[a-zA-Z0-9]{18}\"/>\n </restriction>\n</simpleType>\n<complexType name=\"MacroUsage\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"AppContext\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ConditionCount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"ContextRecord\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"DurationInMs\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"ExecutedInstructionCount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"ExecutionEndTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"ExecutionState\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"FailureReason\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Folder\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Folder\"/>\n <element name=\"FolderId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"InstructionCount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsFromBulk\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Macro\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Macro\"/>\n <element name=\"MacroId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ProcessSteps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"User\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"UserId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n<simpleType name=\"QueryLocator\">\n <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n <sequence>\n <element name=\"done\" type=\"xsd:boolean\"/>\n <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n <element name=\"size\" type=\"xsd:int\"/>\n </sequence>\n</complexType>\n```",
|
|
"field_reference": {
|
|
"AppContext": {
|
|
"field_label": "App Context",
|
|
"type": "picklist",
|
|
"length": "255"
|
|
},
|
|
"ConditionCount": {
|
|
"field_label": "Condition Count",
|
|
"type": "int",
|
|
"digits": "9"
|
|
},
|
|
"ContextRecord": {
|
|
"field_label": "Context Record",
|
|
"type": "string",
|
|
"length": "18"
|
|
},
|
|
"CreatedById": {
|
|
"field_label": "Created By ID",
|
|
"type": "reference",
|
|
"length": "18"
|
|
},
|
|
"CreatedDate": {
|
|
"field_label": "Created Date",
|
|
"type": "datetime"
|
|
},
|
|
"CurrencyIsoCode": {
|
|
"field_label": "Currency ISO Code",
|
|
"type": "picklist",
|
|
"length": "3"
|
|
},
|
|
"DurationInMs": {
|
|
"field_label": "Duration In Milliseconds",
|
|
"type": "int",
|
|
"digits": "9"
|
|
},
|
|
"ExecutedInstructionCount": {
|
|
"field_label": "Executed Instruction Count",
|
|
"type": "int",
|
|
"digits": "9"
|
|
},
|
|
"ExecutionEndTime": {
|
|
"field_label": "Execution End Time",
|
|
"type": "datetime"
|
|
},
|
|
"ExecutionState": {
|
|
"field_label": "Execution State",
|
|
"type": "picklist",
|
|
"length": "255"
|
|
},
|
|
"FailureReason": {
|
|
"field_label": "Failure Reason",
|
|
"type": "picklist",
|
|
"length": "255"
|
|
},
|
|
"FolderId": {
|
|
"field_label": "Folder ID",
|
|
"type": "reference",
|
|
"length": "18"
|
|
},
|
|
"Id": {
|
|
"field_label": "Macro Usage ID",
|
|
"type": "id",
|
|
"length": "18"
|
|
},
|
|
"InstructionCount": {
|
|
"field_label": "Instruction Count",
|
|
"type": "int",
|
|
"digits": "9"
|
|
},
|
|
"IsDeleted": {
|
|
"field_label": "Deleted",
|
|
"type": "boolean"
|
|
},
|
|
"IsFromBulk": {
|
|
"field_label": "From Bulk Execution",
|
|
"type": "boolean"
|
|
},
|
|
"LastModifiedById": {
|
|
"field_label": "Last Modified By ID",
|
|
"type": "reference",
|
|
"length": "18"
|
|
},
|
|
"LastModifiedDate": {
|
|
"field_label": "Last Modified Date",
|
|
"type": "datetime"
|
|
},
|
|
"MacroId": {
|
|
"field_label": "Macro ID",
|
|
"type": "reference",
|
|
"length": "18"
|
|
},
|
|
"Name": {
|
|
"field_label": "Macro Usage Name",
|
|
"type": "string",
|
|
"length": "255"
|
|
},
|
|
"OwnerId": {
|
|
"field_label": "Owner ID",
|
|
"type": "reference",
|
|
"length": "18"
|
|
},
|
|
"SystemModstamp": {
|
|
"field_label": "System Modstamp",
|
|
"type": "datetime"
|
|
},
|
|
"UserId": {
|
|
"field_label": "User ID",
|
|
"type": "reference",
|
|
"length": "18"
|
|
}
|
|
},
|
|
"field_reference_columns": [
|
|
"field_label",
|
|
"type",
|
|
"length",
|
|
"digits"
|
|
]
|
|
} |