sf_get_all_jobs_bulk: Get All Bulk API Jobs

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

Get All Bulk API Jobs

Description

This function retrieves details about all Bulk jobs in the org.

Usage

sf_get_all_jobs_bulk(
  parameterized_search_list = list(isPkChunkingEnabled = NULL, jobType = NULL),
  next_records_url = NULL,
  api_type = c("Bulk 2.0"),
  verbose = FALSE
)

Arguments

parameterized_search_list	list; a list of parameters to be added as part of the URL query string (i.e. after a question mark ("?") so that the result only returns information about jobs that meet that specific criteria. For more information, read the note below and/or the Salesforce documentation here.
next_records_url	character (leave as NULL); a string used internally by the function to paginate through to more records until complete
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.

Value

A tbl_df of parameters defining the details of all bulk jobs

Note

parameterized_search_list elements that can be set to filter the results:

isPkChunkingEnabled

A logical either TRUE or FALSE. TRUE only returns information about jobs where PK Chunking has been enabled.

jobType

A character string to return jobs matching the specified type. Must be one of: "BigObjectIngest", "Classic", "V2QIngest". Classic corresponds to Bulk 1.0 API jobs and V2Ingest corresponds to the Bulk 2.0 API jobs.

References

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

Examples

## Not run: 
job_info <- sf_create_job_bulk('insert', 'Account')
all_jobs_info <- sf_get_all_jobs_bulk()
# just the Bulk API 1.0 jobs
all_jobs_info <- sf_get_all_jobs_bulk(parameterized_search_list=list(jobType='Classic'))

## End(Not run)

salesforcer documentation built on April 12, 2025, 9:12 a.m.