sf_retrieve_metadata_check_status {salesforcer} | R Documentation |
Check on Retrieve Calls and Get Contents If Available
Description
This function returns details about an initiated retrieveMetadata request and saves the results into a zip file
Usage
sf_retrieve_metadata_check_status(
id,
include_zip = TRUE,
filename = "package.zip",
verbose = FALSE
)
Arguments
id |
|
include_zip |
|
filename |
a file path to save the zip file in the event that it is downloaded. The name must have a .zip extension. The default behavior will be to save in the current working directory as package.zip |
verbose |
|
Value
A list
of the response
Note
This function is meant to be used internally. Only use when debugging.
References
Examples
## Not run:
retrieve_request <- list(unpackaged=list(types=list(members='*', name='CustomObject')))
retrieve_info <- sf_retrieve_metadata(retrieve_request)
# check on status, this will automatically download the contents to package.zip when ready
retrieve_status <- sf_retrieve_metadata_check_status(retrieve_info$id)
## End(Not run)