sf_list_report_fields {salesforcer} | R Documentation |
Get a list of report fields
Description
The Report Fields resource returns report fields available for specified reports. Use the resource to determine the best fields for use in dashboard filters by seeing which fields different source reports have in common. Available in API version 40.0 and later.
Usage
sf_list_report_fields(
report_id,
intersect_with = c(character(0)),
verbose = FALSE
)
Arguments
report_id |
|
intersect_with |
|
verbose |
|
Value
list
representing the 4 different field report properties:
- displayGroups
Fields available when adding a filter.
- equivalentFields
Fields available for each specified report. Each object in this array is a list of common fields categorized by report type.
- equivalentFieldIndices
Map of each field’s API name to the index of the field in the
equivalentFields
array.- mergedGroups
Merged fields.
Salesforce Documentation
See Also
Other Report functions:
sf_copy_report()
,
sf_create_report()
,
sf_delete_report()
,
sf_describe_report_type()
,
sf_describe_report()
,
sf_execute_report()
,
sf_list_report_filter_operators()
,
sf_list_report_types()
,
sf_list_reports()
,
sf_query_report()
,
sf_run_report()
,
sf_update_report()
Examples
## Not run:
# first, grab all possible reports in your Org
all_reports <- sf_query("SELECT Id, Name FROM Report")
# second, get the id of the report to check fields on
this_report_id <- all_reports$Id[1]
# third, pull that report and intersect its fields with up to three other reports
fields <- sf_list_report_fields(this_report_id, intersect_with=head(all_reports[["Id"]],3))
## End(Not run)