sf_upload_complete_bulk: Signal Upload Complete to Bulk API Job

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

Signal Upload Complete to Bulk API Job

Description

This function signals that uploads are complete to a Job in the Salesforce Bulk API

Usage

sf_upload_complete_bulk(job_id, api_type = c("Bulk 2.0"), 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.
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 list of parameters defining the job after signaling a completed upload

Note

This function is typically not used directly. It is used in sf_create_batches_bulk() right after submitting the batches to signal to Salesforce that the batches should no longer be queued.

References

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

Examples

## Not run: 
upload_info <- sf_upload_complete_bulk(job_id=job_info$id)

## End(Not run)

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