sf_create_job_bulk: Create Bulk API Job

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

Create Bulk API Job

Description

This function initializes a Job in the Salesforce Bulk API

Usage

sf_create_job_bulk(
  operation = c("insert", "delete", "upsert", "update", "hardDelete", "query",
    "queryall"),
  object_name,
  soql = NULL,
  external_id_fieldname = NULL,
  api_type = c("Bulk 1.0", "Bulk 2.0"),
  content_type = c("CSV", "ZIP_CSV", "ZIP_XML", "ZIP_JSON"),
  concurrency_mode = c("Parallel", "Serial"),
  column_delimiter = c("COMMA", "TAB", "PIPE", "SEMICOLON", "CARET", "BACKQUOTE"),
  control = list(...),
  ...,
  line_ending = deprecated(),
  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.
api_type	character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when making the request.
content_type	character; being one of 'CSV', 'ZIP_CSV', 'ZIP_XML', or 'ZIP_JSON' to indicate the type of data being passed to the Bulk APIs. For the Bulk 2.0 API the only valid value (and the default) is 'CSV'.
concurrency_mode	character; either "Parallel" or "Serial" that specifies whether batches should be completed sequentially or in parallel. Use "Serial" only if lock contentions persist with in "Parallel" mode. Note: this argument is only used in the Bulk 1.0 API and will be ignored in calls using the Bulk 2.0 API.
column_delimiter	character; indicating the column delimiter used for CSV job data. The default value is COMMA. Valid values are: "BACKQUOTE", "CARET", "COMMA", "PIPE", "SEMICOLON", and "TAB", but this package only accepts and uses "COMMA". Also, note that this argument is only used in the Bulk 2.0 API and will be ignored in calls using the Bulk 1.0 API.
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
line_ending	character; indicating the The line ending used for CSV job data, marking the end of a data row. The default is NULL and determined by the operating system using "CRLF" for Windows machines and "LF" for Unix machines. NOTE: As of readr v1.3.1 all CSV files end with the line feed character ("\n") regardless of the operating system. So it is usually best to not specify this argument.
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 parameters defining the created job, including id

References

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

Examples

## Not run: 
# insert into Account
job_info <- sf_create_job_bulk(operation='insert', object_name='Account')

# delete from Account
job_info <- sf_create_job_bulk(operation='delete', object_name='Account')

# update into Account
job_info <- sf_create_job_bulk(operation='update', object_name='Account')

# upsert into Account
job_info <- sf_create_job_bulk(operation='upsert',
                               externalIdFieldName='My_External_Id__c',
                               object_name='Account')
# insert attachments
job_info <- sf_create_job_bulk(operation='insert', object_name='Attachment')

# query leads
job_info <- sf_create_job_bulk(operation='query', object_name='Lead')

## End(Not run)

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