sf_end_job_bulk: End Bulk API Job

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

End Bulk API Job

Description

End Bulk API Job

Usage

sf_end_job_bulk(
  job_id,
  end_type = c("Closed", "UploadComplete", "Aborted"),
  api_type = c("Bulk 1.0", "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".
end_type	character; taking a value of "Closed" or "Aborted" indicating how the bulk job should be ended
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

logical; returns TRUE if the job was able to be ended; otherwise, an error message is printed

Note

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

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