sf_read_metadata: Read Object or Field Metadata from Salesforce

View source: R/read-metadata.R

sf_read_metadataR Documentation

Read Object or Field Metadata from Salesforce

Description

[Experimental]

This function takes a request of named elements in Salesforce and returns their metadata

Usage

sf_read_metadata(metadata_type, object_names, verbose = FALSE)

Arguments

metadata_type

character; string on what type of metadata to create.

object_names

a character vector of names that we wish to read metadata for

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 containing a response for each requested object

References

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

Examples

## Not run: 
metadata_info <- sf_read_metadata(metadata_type='CustomObject', 
                                  object_names=c('Account'))

## End(Not run)

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