sf_list_metadata: List All Objects of a Certain Metadata Type in Salesforce

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

List All Objects of a Certain Metadata Type in Salesforce

Description

This function takes a query of metadata types and returns a summary of all objects in salesforce of the requested types

Usage

sf_list_metadata(queries, verbose = FALSE)

Arguments

queries	a list of lists with each element consisting of 2 components: 1) the metadata type being requested and 2) the folder associated with the type that required for types that use folders, such as Dashboard, Document, EmailTemplate, or Report.
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 tbl_dfs containing the queried metadata types

Note

Only 3 queries can be specified at one time, so the list length must not exceed 3.

References

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

Examples

## Not run: 
# pull back a list of all Custom Objects and Email Templates
my_queries <- list(list(type='CustomObject'),
                   list(folder='unfiled$public',
                        type='EmailTemplate'))
metadata_info <- sf_list_metadata(queries=my_queries)

## End(Not run)

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