salesforcer: simplify_report_metadata – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

simplify_report_metadata

Simplify the reportMetadata property of a report

Description

This function accepts the Id of a report in Salesforce and returns its reportMetadata property with modifications made so that the report will return a dataset that is closer to a tidy format. More specifically, the data will be detailed data (not any report aggregates) in a tabular format with no filters, grand totals, or subtotals.

Usage

simplify_report_metadata(report_id, verbose = FALSE)

Arguments

`report_id`	`character`; the Salesforce Id assigned to a created analytics report. It will start with `"00O"`.
`verbose`	`logical`; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to `TRUE` the URL, header, and body will be printed for each request, along with additional diagnostic information where available.

Value

list; a list representing the reportMetadata property of the report id provided, but with adjustments made.

Note

This function is meant to be used internally. Only use when debugging.

salesforcer

An Implementation of 'Salesforce' APIs Using Tidy Principles

v0.2.2

MIT + file LICENSE

Authors

Steven M. Mortimer [aut, cre], Takekatsu Hiramura [ctb], Jennifer Bryan [ctb, cph], Joanna Zhao [ctb, cph]

Initial release

2020-09-07