salesforcer: sf_abort_job_bulk – R documentation

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

sf_abort_job_bulk

Abort Bulk API Job

This function aborts a Job in the Salesforce Bulk API

sf_abort_job_bulk(
  job_id,
  api_type = c("Bulk 1.0", "Bulk 2.0"),
  verbose = FALSE
)

`job_id`	`character`; the Salesforce Id assigned to a submitted job as returned by sf_create_job_bulk. It will start with `"750"`.
`api_type`	`character`; one of `"REST"`, `"SOAP"`, `"Bulk 1.0"`, or `"Bulk 2.0"` indicating which API to use when making the request.
`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.

A list of parameters defining the now aborted job

## Not run: 
job_info <- sf_create_job_bulk('insert', 'Account')
sf_abort_job_bulk(job_info$id)

## End(Not run)

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