rforcecom.getBatchDetails: Returning the Details of a Batch in a Bulk API Job

Description Usage Arguments Value References Examples

View source: R/rforcecom.getBatchDetails.R

Description

This function returns detailed (row-by-row) information on an existing batch which has already been submitted to Bulk API Job

Usage

1
rforcecom.getBatchDetails(session, jobId, batchId)

Arguments

session

a named character vector defining parameters of the api connection as returned by rforcecom.login

jobId

a character string defining the salesforce id assigned to a submitted job as returned by rforcecom.createBulkJob

batchId

a character string defining the salesforce id assigned to a submitted batch as returned by rforcecom.createBulkBatch

Value

A data.frame, formatted by salesforce, with information containing the success or failure or certain rows in a submitted batch, unless the operation was query, then it is a data.frame containing the resultId for retrieving the recordset.

References

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

Examples

1
2
3
4
## Not run: 
batch_details <- rforcecom.getBatchDetails(session, jobId=job_info$id, batchId=batches_info[[1]]$id)

## End(Not run)

RForcecom documentation built on May 1, 2019, 6:31 p.m.