sf_create_job_bulk_v2: Create Job using Bulk 2.0 API

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

Create Job using Bulk 2.0 API

Description

Create Job using Bulk 2.0 API

Usage

sf_create_job_bulk_v2(
  operation = c("insert", "delete", "upsert", "update", "query", "queryall"),
  object_name,
  soql = NULL,
  external_id_fieldname = NULL,
  content_type = "CSV",
  column_delimiter = c("COMMA", "TAB", "PIPE", "SEMICOLON", "CARET", "BACKQUOTE"),
  control,
  ...,
  verbose = FALSE
)

Arguments

operation	character; a string defining the type of operation being performed (e.g. "insert", "update", "upsert", "delete", "hardDelete", "query", "queryall").
object_name	character; the name of the Salesforce object that the function is operating against (e.g. "Account", "Contact", "CustomObject__c").
soql	character; a string defining a SOQL query (e.g. "SELECT Id, Name FROM Account").
external_id_fieldname	character; string identifying a custom field on the object that has been set as an "External ID" field. This field is used to reference objects during upserts to determine if the record already exists in Salesforce or not.
content_type	character; a string indicating the format for the API request and response. Must be 'CSV' because it is the only supported format for the Bulk 2.0 API.
column_delimiter	character; a string indicating which character should be treated as the delimiter in the CSV file. Must be one of 'COMMA', 'TAB', 'PIPE', 'SEMICOLON', 'CARET', or 'BACKQUOTE'.
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 to be used to form the default control argument if it is not supplied directly.
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; a data frame containing information about the job created.

Note

This function is meant to be used internally. Only use when debugging.

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