sf_describe_objects: SObject Basic Information

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

SObject Basic Information

Description

Describes the individual metadata for the specified object.

Usage

sf_describe_objects(
  object_names,
  api_type = c("SOAP", "REST"),
  control = list(...),
  ...,
  verbose = FALSE
)

Arguments

object_names	character; the name of one or more Salesforce objects that the function is operating against (e.g. "Account", "Contact", "CustomObject__c").
api_type	character; one of "REST", "SOAP", "Bulk 1.0", or "Bulk 2.0" indicating which API to use when making the request.
control	list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available look at the documentation for sf_control.
...	arguments passed to sf_control
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

list

See Also

REST API Documentation, REST API Example

Examples

## Not run: 
account_metadata <- sf_describe_objects("Account")
account_metadata_SOAP <- sf_describe_objects("Account", api_type="SOAP")
multiple_objs_metadata <- sf_describe_objects(c("Contact", "Lead"))

account_metadata_REST <- sf_describe_objects("Account", api_type="REST")

## End(Not run)

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