Category Resource Mappings

Constraints and Limitations

Before using the TMF620 category resource mappings, refer to the following.

The ids and names sent in the subResource (subCategory / productOffering) must be present in the system to create a new relationship.
Patching of the subresource productOffering is supported for the patchCategory API. Patching of the relationship is possible if both the id and name sent in the request for a productOffering are present in the system.
The names of the catagories are unique when patching. Ensure that name field remains unique in the PATCH request.
Category - Incoming id and name of this node can only be matched with global key and name of the product. This is cannot be customized to change the matching criteria or to add additional matching criteria(s).
Product specification creation is done through product specification API assuming the category is already created and linking of product to a specific category is done through product specification API.
Catalog relationship name is same as child catalog (sub-category name).
Id in the request/response bodies is mapped to GlobalKey__c in the catalog object.
Category replicates the catalog object in Salesforce. Catalog relationship is created with category resource.
Any category or sub-category not available must be created.

TMF Field	Type	Description	Salesforce Mapping	Salesforce Description	Prerequisite	Is mandatory?
description	string	Describes the catalog.	vlocity_cmt__Description__c	Describes the parent category.	NA	No
lastUpdate	datetime	Specifies the date and time of the last update.	LastModifiedDate	Specifies the last updated date of the category.	NA	No
lifecycleStatus	string	Specifies the current lifecycle status.	vlocity_cmt__IsActive__c	Specifies if the parent category is active.	If lifecycleStatus value is ‘Active’ in the payload, vlocity_cmt__IsActive__c is set to True, else False.	No
name	string	Required. Specifies the name of the catalog.	Name	Specifies the lookup field from the catalog object for the parent catalog name.	NA	Yes
id	string	Specifies the catalog ID.	vlocity_cmt__GlobalKey__c	Specifies the unique ID of the category resource.	NA	No
validFor - startDateTime/endDateTime	time period	Specifies the period for which the catalog is valid.	vlocity_cmt__StartDateTime__c/vlocity_cmt__EndDateTime__c	Specifies the validity of the category.	NA	No
@type	string	Defines the subclass extensible name when subclassing.	Resource name (Catalog)	Specifies that the sObject name is Category.	NA	Yes
isRoot	boolean	Indicates whether the category is a root category (true) or a child category (false).	vlocity_cmt__IsCatalogRoot__c	Specifies if the parent catalog is a root catalog or a child catalog.	NA	No
href	string	Specifies the hyperlink reference of the category.	TMF Category URL + vlocity_cmt__Catalog__c.Id	Specifies the GET URL of the TMF Category ending with the ID field.	NA	No
subCategory	object	The category resource is used to group product offerings, service and resource candidates in logical containers.	vlocity_cmt__Catalog__c	Specifies the relation between catalogs.	Link a product catalog to the category.	Yes
productOffering	string	A product offering represents entities that are orderable from the provider of the catalog.	Product2	Specifies the relation between product catalogs.	NA	No

subCategory Subresource Mappings

TMF Field	Type	Description	Salesforce Mapping	Salesforce Description	Prerequisite	Is mandatory?
subCategory.name	string	Specifies the name field in the subcategory.	vlocity_cmt__Catalog__c.Name	Specifies the lookup field from the catalog object for the child catalog name.	NA	Yes
subCategory.id	string	Specifies the ID field in the subcategory.	vlocity_cmt__Catalog__c.vlocity_cmt__GlobalKey__c	Specifies the global key field of the catalog object.	NA	No
subCategory.href	string	Specifies the hyperlink reference field in the subcategory.	TMF Category URL + vlocity_cmt__Catalog__c.Id	Specifies the GET URL of the TMF catalog ending with the ID field.	NA	No
subCategory.@type	string	Defines the resource type.	resource name ‘catalog’	Specifies that the sObject of the subCategory node is Catalog.	NA	No

productOffering Subresource Mappings

TMF Field	Type	Description	Salesforce Mapping	Salesforce Description	Prerequisit	Is mandatory?
productOffering.name	string	Specifies the name of the product offering.	Product2.Name	Specifies the name of products linked to the parent catalog.	NA	No
productOffering.id	string	Specifies the product offering ID.	Product2.vlocity_cmt__GlobalKey__c	Specifies the global key field of the Product2 object.	NA	No
productOffering.href	string	Specifies the hyperlink reference field in the product offering.	TMF Product2 URL + Product2.Id	Specifies the GET URL of the TMF productOffering ending with the ID field.	NA	No
productOffering.@type	string	Defines the resource type.	resource name ‘productOffering’	Specifies that the resource name is productOffering.	NA	No