sf_get_job_bulk: Get Bulk API Job

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

Get Bulk API Job

Description

This function retrieves details about a Job in the Salesforce Bulk API

Usage

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

Arguments

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.
query_operation	logical; an indicator of whether the job is a query job, which is needed when using the Bulk 2.0 API because the URI endpoints are different for the "ingest" vs. the "query" jobs.
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

A tbl_df of parameters defining the details of the specified job id

References

https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch

Examples

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

## End(Not run)

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