TMF674 v4 Resource Mappings
Before using the TMF674 v4 resource mappings, refer these.
- The initiation of a request from Salesforce to the Mule Application is implemented by the user.
- GET, POST, and PATCH are synchronous interfaces, and the response from the external system is returned to the calling system.
- Processing the response for GET, POST, and PATCH is implemented by the user.
- The
externalId
is mapped with vlocity_cmt__PremisesIdentifier__c
- The response includes only the optional parameters that are supported to prevent a 4xx error response.
- The authentication mechanism used to connect to the Salesforce org is OAuth.
- In the event of failures when invoking the external system endpoint, the request is retried up to three times, with a two-second interval between each retry attempt.
- The
href
element is not passed as part of the payload for POST and PATCH.
- The
vlocity_cmt
is taken as the default namespace prefix for the Salesforce object.
These resource and sub-resources are supported for the salesforce package entity: Premise (vlocity_cmt__Premises__c
)
Salesforce Package Entity: Premise (vlocity_cmt__Premises__c
)
TMF Field | Field Type | Is Mandatory as per TMForum? | Description | Salesforce Mapping |
---|
href | string | - | Hyperlink reference. | lightning/r/vlocity_cmt__Premises__c/{id}/view |
name | string | - | A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]. | Name |
status | string | - | The condition of the GeographicSite, such as planned, underConstruction, cancelled, active, inactive, former. | vlocity_cmt__Status__c |
@type | string | - | The class type of the actual resource (for type extension). | "GeographicSite" |
relatedParty | array | - | A RelatedPartyRefOrPartyRoleRef. RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity. | Sub-Resource - Related Party(entity = Account) |
siteRelationship | array | - | A GeographicSiteRelationship. Details of geographic site relationship. | Sub-Resource - GeographicSiteRelationship |
place | array | - | A PlaceRefOrValue. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Place entity and not the PlaceRefOrValue class itself. | Sub-Resource - PlaceRefOrValue |
TMF Field | Field Type | Is Mandatory as per TMForum? | Description | Salesforce Mapping |
---|
relatedParty.id | string | Yes | Id of the related party. | vlocity_cmt__PropertyOwnerAccountId__r.Id |
relatedParty.href | string | - | Hypertext Reference of the related party. | /lightning/r/Account/{vlocity_cmt__PropertyOwnerAccountId__r.Id}/view |
relatedParty.name | string | - | Name of the related party. | vlocity_cmt__PropertyOwnerAccountId__r.Name |
relatedParty.role | string | - | Role played by the related party. | "Owner" |
relatedParty.@referredType | string | Yes | The actual type of the target instance when needed for disambiguation. | "Organization" |
TMF Field | Field Type | Is Mandatory as per TMForum? | Description | Salesforce Mapping |
---|
siteRelationship.href | string | - | Reference of the related geographic site. | lightning/r/vlocity_cmt__Premises__c/{vlocity_cmt__ParentPremisesId__c}/view |
siteRelationship.id | string | Yes | Unique identifier of the related site entity within the server. | vlocity_cmt__ParentPremisesId__r.vlocity_cmt__PremisesIdentifier__c |
siteRelationship.relationshipType | string | Yes | Type of relationship. | "parent_location" |
siteRelationship.@type | string | - | When sub-classing, this defines the sub-class Extensible name. | "SiteRelationship" |
TMF Field | Field Type | Is Mandatory as per TMForum? | Description | Salesforce Mapping |
---|
validFor.startDateTime | DateTime | - | Starting date and time of the validity | vlocity_cmt__ParentPremisesId__r.CreatedDate |
TMF Field | Field Type | Is Mandatory as per TMForum? | Description | Salesforce Mapping |
---|
place.href | string | - | Unique reference of the place | lightning/r/vlocity_cmt__Premises__c/{Id}/view |
place.id | string | Yes | Unique Id of the place | vlocity_cmt__PremisesNumber__c |
place.@type | string | - | When sub-classing, this defines the sub-class Extensible name | "PlaceRef" |
place.@referredType | string | Yes | The actual type of the target instance when needed for disambiguation | "GeographicLocation" |