sf_describe_report_type {salesforcer} | R Documentation |
Describe a report type
Description
Return metadata about a report type.
Usage
sf_describe_report_type(report_type, verbose = FALSE)
Arguments
report_type |
|
verbose |
|
Value
list
containing up to 4 properties that describe the report:
- attributes
Report type along with the URL to retrieve common objects and joined metadata.
- reportMetadata
Unique identifiers for groupings and summaries.
- reportTypeMetadata
Fields in each section of a report type plus filter information for those fields.
- reportExtendedMetadata
Additional information about summaries and groupings.
Salesforce Documentation
See Also
Other Report functions:
sf_copy_report()
,
sf_create_report()
,
sf_delete_report()
,
sf_describe_report()
,
sf_execute_report()
,
sf_list_report_fields()
,
sf_list_report_filter_operators()
,
sf_list_report_types()
,
sf_list_reports()
,
sf_query_report()
,
sf_run_report()
,
sf_update_report()
Examples
## Not run:
reports <- sf_list_report_types()
unique_report_types <- reports %>% distinct(reportTypes.type)
# first unique report type
unique_report_types[[1,1]]
# describe that report type
described_report <- sf_describe_report_type(unique_report_types[[1,1]])
## End(Not run)