Catalog Resource Mappings

FieldTypeDescriptionSalesforce MappingSalesforce DescriptionIs mandatory?Prerequisite
hrefstringSpecifies a unique reference of the catalog.TMF Catalog URL + vlocity_cmt__Catalog__c.IdSpecifies the GET URL of the TMF catalog that ends with the ID field.NoNA
idstringSpecifies a unique identifier of the catalog.vlocity_cmt__GlobalKey__cSpecifies the ID that the customer wants to add.NoNA
descriptionstringDescribes the catalog.vlocity_cmt__Description__cDescribes the catalog.NoNA
lifecycleStatusstringSpecifies the current lifecycle status.vlocity_cmt__IsActive__cSpecifies if the catalog is active. Values for lifecycleStatus are Active and Inactive.NoNA
namestringRequired. Specifies the name of the catalog.NameSpecifies the name of the catalog.YesThe catalog name must be unique in the Salesforce org.
validFor - startDateTime/endDateTimeobjectSpecifies the period for which the catalog is valid.vlocity_cmt__StartDateTime__c/vlocity_cmt__EndDateTime__cSpecifies the validity of the catalog.NoNA
relatedPartyarrayDefines a party or party role that's linked to a specific entity.vlocity_cmt__VendorAccount__cSpecifies the field that's derived from the vendor column of the catalog object.NoUse an existing account.
@typestringDefines the subclass extensible name when subclassing.Resource name (Catalog)The @type attribute differentiates between the catalog and category request and doesn't have a direct mapping in Salesforce.YesNA
FieldTypeDescriptionSalesforce MappingSalesforce DescriptionIs mandatory?Prerequisite
namestringSpecifies the name of the related party.NameSpecifies the name of the account.NoNA
hrefstringSpecifies the hyperlink reference of the related party.TMF Account URL + Account.IdSpecifies the GET URL of the TMF catalog that ends with the ID field.NoNA
idstringSpecifies the unique identifier of the related party.Account.AccountNumberSpecifies the external ID for the specified account.YesUse an existing account.
rolestringSpecifies the role played by the related party.Account.RecordType.NameSpecifies the record type of the account.NoUse an existing account.
@referredTypestringSpecifies the actual type of the target instance when needed for disambiguation.Schema object name (Account)Specifies that the sObject type is Account.NoNA
@typestringDefines the subclass extensible name when subclassing.JSON representation type (RelatedParty)Specifies the vendor account.NoNA
FieldTypeDescriptionSalesforce MappingSalesforce DescriptionIs mandatory?Prerequisite
namestringSpecifies the name of the Category.NameSpecifies the name of the account.NoNA
hrefstringSpecifies the hyperlink reference of the category.TMF Category URL + vlocity_cmt__Catalog__c.IDSpecifies the GET URL of the TMF catalog that ends with the ID field.NoNA
idstringSpecifies the unique identifier of the category.vlocity_cmt__Catalog__c.vlocity_cmt__GlobalKey__cSpecifies the external ID for the specified account.YesNA
@referredTypestringSpecifies the actual type of the target instance when needed for disambiguation.vlocity_cmt__Catalog__cSpecifies that the sObject type is Account.NoNA
@typestringDefines the subclass extensible name when subclassing.JSON representation type (CategoryRef)Specifies the category reference.NoNA