sf_delete {salesforcer} | R Documentation |
Delete Records
Description
Deletes one or more records from your organization’s data.
Usage
sf_delete(
ids,
object_name = NULL,
api_type = c("REST", "SOAP", "Bulk 1.0", "Bulk 2.0"),
guess_types = TRUE,
control = list(...),
...,
all_or_none = deprecated(),
verbose = FALSE
)
Arguments
ids |
vector , matrix , data.frame , or
tbl_df ; if not a vector, there must be a column called Id (case
insensitive) that can be passed in the request.
|
object_name |
character ; the name of the Salesforce object that the
function is operating against (e.g. "Account", "Contact", "CustomObject__c").
|
api_type |
character ; one of "REST" , "SOAP" ,
"Bulk 1.0" , or "Bulk 2.0" indicating which API to use when
making the request.
|
guess_types |
logical ; indicating whether or not to use col_guess()
to try and cast the data returned in the recordset. If TRUE then
col_guess() is used, if FALSE then all fields will be returned
as character. This is helpful when col_guess() will mangle field values
in Salesforce that you'd like to preserve during translation into a tbl_df ,
like numeric looking values that must be preserved as strings ("48.0").
|
control |
list ; a list of parameters for controlling the behavior of
the API call being used. For more information of what parameters are available
look at the documentation for sf_control .
|
... |
arguments passed to sf_control or further downstream
to sf_bulk_operation
|
all_or_none |
logical ; allows a call to roll back all changes unless all
records are processed successfully.
|
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
tbl_df
of records with success indicator
Note
Because the SOAP and REST calls chunk data into batches of 200 records
the AllOrNoneHeader will only apply to the success or failure of every batch
of records and not all records submitted to the function.
Examples
## Not run:
n <- 3
new_contacts <- tibble(FirstName = rep("Test", n),
LastName = paste0("Contact", 1:n))
new_records <- sf_create(new_contacts, object_name="Contact")
deleted_first <- sf_delete(new_records$id[1], object_name = "Contact")
# add the control to do an "All or None" deletion of the remaining records
deleted_rest <- sf_delete(new_records$id[2:3], object_name = "Contact",
AllOrNoneHeader = list(allOrNone = TRUE))
## End(Not run)
[Package
salesforcer version 1.0.1
Index]