Skip to content

Get Profile Object Type Template

customerprofiles_get_profile_object_type_template R Documentation

Returns the template information for a specific object type

Description

Returns the template information for a specific object type.

A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.

Usage

customerprofiles_get_profile_object_type_template(TemplateId)

Arguments

TemplateId

[required] A unique identifier for the object template.

Value

A list with the following syntax:

list(
  TemplateId = "string",
  SourceName = "string",
  SourceObject = "string",
  AllowProfileCreation = TRUE|FALSE,
  SourceLastUpdatedTimestampFormat = "string",
  Fields = list(
    list(
      Source = "string",
      Target = "string",
      ContentType = "STRING"|"NUMBER"|"PHONE_NUMBER"|"EMAIL_ADDRESS"|"NAME"
    )
  ),
  Keys = list(
    list(
      list(
        StandardIdentifiers = list(
          "PROFILE"|"ASSET"|"CASE"|"UNIQUE"|"SECONDARY"|"LOOKUP_ONLY"|"NEW_ONLY"|"ORDER"
        ),
        FieldNames = list(
          "string"
        )
      )
    )
  )
)

Request syntax

svc$get_profile_object_type_template(
  TemplateId = "string"
)