sf_delete_report: Delete a report

In salesforcer: An Implementation of 'Salesforce' APIs Using Tidy Principles

Delete a report

Description

Delete a report by sending a DELETE request to the Report resource. Deleted reports are moved to the Recycle Bin.

Usage

sf_delete_report(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

logical indicating whether the report was deleted. This function will return TRUE if successful in deleting the report.

Salesforce Documentation

• Documentation

See Also

Other Report functions: sf_copy_report(), sf_create_report(), sf_describe_report_type(), 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: 
# 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 delete
this_report_id <- all_reports$Id[1]

# third, delete that report using its Id
success <- sf_delete_report(this_report_id)

## End(Not run)

salesforcer documentation built on March 18, 2022, 6:26 p.m.