mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-10 17:41:49 +08:00
177 lines
8.7 KiB
JSON
177 lines
8.7 KiB
JSON
|
{
|
|||
|
|
"sections": [
|
|||
|
|
"title",
|
|||
|
|
"description",
|
|||
|
|
"fields",
|
|||
|
|
"special_access_rules",
|
|||
|
|
"wsdl_segment",
|
|||
|
|
"field_reference"
|
|||
|
|
],
|
|||
|
|
"title": "OrgMetricScanSummary - Data API",
|
|||
|
|
"description": "Represents the results summary for a specific feature in a Salesforce Optimizer evaluation. This object is available in API version 47.0 and later.",
|
|||
|
|
"fields_columns": [
|
|||
|
|
"type",
|
|||
|
|
"properties",
|
|||
|
|
"description",
|
|||
|
|
"example",
|
|||
|
|
"relationship_name",
|
|||
|
|
"relationship_type",
|
|||
|
|
"refers_to"
|
|||
|
|
],
|
|||
|
|
"fields": {
|
|||
|
|
"ErrorMessage": {
|
|||
|
|
"type": "picklist",
|
|||
|
|
"properties": "Create, Filter, Group, Nillable, Sort",
|
|||
|
|
"description": "The message returned if an error occurred during the most recent Optimizer evaluation."
|
|||
|
|
},
|
|||
|
|
"FeatureLimit": {
|
|||
|
|
"type": "int",
|
|||
|
|
"properties": "Create, Filter, Group, Nillable, Sort",
|
|||
|
|
"description": "The numerical limit of a feature.",
|
|||
|
|
"example": "For the Custom Field Limits feature, FeatureLimit is 500 for Developer Edition orgs."
|
|||
|
|
},
|
|||
|
|
"ImplementationEffort": {
|
|||
|
|
"type": "picklist",
|
|||
|
|
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Sort",
|
|||
|
|
"description": "The estimated time needed to complete the recommended actions for the feature. Possible values are: 1 - 2 hours 30 - 60 minutes < 30 minutes > 2 hours The default value is 30 minutes."
|
|||
|
|
},
|
|||
|
|
"ItemCount": {
|
|||
|
|
"type": "int",
|
|||
|
|
"properties": "Create, Filter, Group, Nillable, Sort",
|
|||
|
|
"description": "The number of issues found for the feature. Corresponds to the number of OrgMetricScanResult objects generated for the feature in an Optimizer evaluation."
|
|||
|
|
},
|
|||
|
|
"Name": {
|
|||
|
|
"type": "string",
|
|||
|
|
"properties": "Filter, Group, idLookup, Sort",
|
|||
|
|
"description": "A number that identifies the feature’s results summary."
|
|||
|
|
},
|
|||
|
|
"OrgMetricId": {
|
|||
|
|
"type": "reference",
|
|||
|
|
"properties": "Create, Filter, Group, Sort",
|
|||
|
|
"description": "The OrgMetric ID that represents the feature analyzed in the Optimizer evaluation. This field is a relationship field.",
|
|||
|
|
"relationship_name": "OrgMetric",
|
|||
|
|
"relationship_type": "Master-detail",
|
|||
|
|
"refers_to": "OrgMetric (the master object)"
|
|||
|
|
},
|
|||
|
|
"PercentUsage": {
|
|||
|
|
"type": "percent",
|
|||
|
|
"properties": "Create, Filter, Nillable, Sort",
|
|||
|
|
"description": "A percentage associated with a feature.",
|
|||
|
|
"example": "For the Incomplete Chatter Profiles feature, the PercentUsage value is 100 if 100% of users have complete Chatter profiles."
|
|||
|
|
},
|
|||
|
|
"ScanDate": {
|
|||
|
|
"type": "dateTime",
|
|||
|
|
"properties": "Create, Filter, Nillable, Sort",
|
|||
|
|
"description": "The time that the report for the Optimizer evaluation was generated."
|
|||
|
|
},
|
|||
|
|
"Status": {
|
|||
|
|
"type": "picklist",
|
|||
|
|
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Sort",
|
|||
|
|
"description": "The recommended action for the feature. Possible values are: Action Required Immediate Action Required No Action Required Not Currently Enabled Review Required Unable to Analyze The default value is No Action Required."
|
|||
|
|
},
|
|||
|
|
"Unit": {
|
|||
|
|
"type": "string",
|
|||
|
|
"properties": "Create, Filter, Group, Nillable, Sort",
|
|||
|
|
"description": "The unit of measurement used in the feature’s results summary.",
|
|||
|
|
"example": "For the Data Storage feature, the Unit is MB."
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"special_access_rules": "This object is only available in orgs where Salesforce Optimizer is enabled. Requires the Modify All Data and Customize Application user permissions.",
|
|||
|
|
"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=\"OrgMetricScanSummary\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\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=\"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=\"ErrorMessage\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"FeatureLimit\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ImplementationEffort\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"ItemCount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\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=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"OrgMetric\" nillable=\"true\" minOccurs=\"0\" type=\"ens:OrgMetric\"/>\n <element name=\"OrgMetricId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"PercentUsage\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\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=\"ScanDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Status\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Unit\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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": {
|
|||
|
|
"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"
|
|||
|
|
},
|
|||
|
|
"ErrorMessage": {
|
|||
|
|
"field_label": "Error Message",
|
|||
|
|
"type": "picklist",
|
|||
|
|
"length": "40"
|
|||
|
|
},
|
|||
|
|
"FeatureLimit": {
|
|||
|
|
"field_label": "Limit",
|
|||
|
|
"type": "int",
|
|||
|
|
"digits": "9"
|
|||
|
|
},
|
|||
|
|
"Id": {
|
|||
|
|
"field_label": "Org Metric Scan Summary ID",
|
|||
|
|
"type": "id",
|
|||
|
|
"length": "18"
|
|||
|
|
},
|
|||
|
|
"ImplementationEffort": {
|
|||
|
|
"field_label": "Implementation Effort",
|
|||
|
|
"type": "picklist",
|
|||
|
|
"length": "40"
|
|||
|
|
},
|
|||
|
|
"IsDeleted": {
|
|||
|
|
"field_label": "Deleted",
|
|||
|
|
"type": "boolean"
|
|||
|
|
},
|
|||
|
|
"ItemCount": {
|
|||
|
|
"field_label": "Count",
|
|||
|
|
"type": "int",
|
|||
|
|
"digits": "9"
|
|||
|
|
},
|
|||
|
|
"LastModifiedById": {
|
|||
|
|
"field_label": "Last Modified By ID",
|
|||
|
|
"type": "reference",
|
|||
|
|
"length": "18"
|
|||
|
|
},
|
|||
|
|
"LastModifiedDate": {
|
|||
|
|
"field_label": "Last Modified Date",
|
|||
|
|
"type": "datetime"
|
|||
|
|
},
|
|||
|
|
"Name": {
|
|||
|
|
"field_label": "Org Metric Scan Summary",
|
|||
|
|
"type": "string",
|
|||
|
|
"length": "255"
|
|||
|
|
},
|
|||
|
|
"OrgMetricId": {
|
|||
|
|
"field_label": "Org Metric ID",
|
|||
|
|
"type": "reference",
|
|||
|
|
"length": "18"
|
|||
|
|
},
|
|||
|
|
"PercentUsage": {
|
|||
|
|
"field_label": "Percent Usage",
|
|||
|
|
"type": "percent",
|
|||
|
|
"precision": "3",
|
|||
|
|
"scale": "0"
|
|||
|
|
},
|
|||
|
|
"ScanDate": {
|
|||
|
|
"field_label": "Scan Date",
|
|||
|
|
"type": "datetime"
|
|||
|
|
},
|
|||
|
|
"Status": {
|
|||
|
|
"field_label": "Status",
|
|||
|
|
"type": "picklist",
|
|||
|
|
"length": "40"
|
|||
|
|
},
|
|||
|
|
"SystemModstamp": {
|
|||
|
|
"field_label": "System Modstamp",
|
|||
|
|
"type": "datetime"
|
|||
|
|
},
|
|||
|
|
"Unit": {
|
|||
|
|
"field_label": "Unit",
|
|||
|
|
"type": "string",
|
|||
|
|
"length": "64"
|
|||
|
|
}
|
|||
|
|
},
|
|||
|
|
"field_reference_columns": [
|
|||
|
|
"field_label",
|
|||
|
|
"type",
|
|||
|
|
"length",
|
|||
|
|
"digits",
|
|||
|
|
"precision",
|
|||
|
|
"scale"
|
|||
|
|
]
|
|||
|
|
}
|