{
"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\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n\n\n \n \n \n \n \n \n\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"
]
}