Vlocity Facts #51 || Using DataMapper Extract as Rest API

In Previous posts we have seen how to Using Integration Procedure as Rest API.

In this post we will see how to Invoke DataMapper as REST API.

Data Mapper Extract Invocation Using GET
To retrieve data from Salesforce using a REST call, you need to issue a GET request that triggers a Data Mapper Extract. You can specify the data to be retrieved either by providing the object ID or by defining one or more matching parameters. The response will return the data in JSON format, as defined by the Data Mapper Extract's output configuration.

1. Use an ID to Retrieve Data

First we will design a DataMapper which accepts recordId as a Input parameter.
Refer this link for creating new DataMapper Extract

To retrieve Salesforce data by specifying the Id, issue a GET request that invokes a Data Mapper Extract, using a URL formatted as follows:
/services/apexrest/{myOrgNamespace}/v2/DataRaptor/{DataMapperName}/Id
  • myOrgNamespace - Namespace prefix
  • DataMappername - Name of the DataMapper Extract
  • In Id we need to pass the record Id - don't change the Parameter of "Id' to any other parameter
Example: We will create a sample  Data Mapper Extract to get "Account and Account related  Contacts"
While configuring the Data Mapper - filter value should be Id  because the value what you're passing it will be in Id


From Workbench we will call this DataMapper Extract by using below syntax
/services/apexrest/{myOrgNamespace}/v2/DataRaptor/{DataMapperName}/Id
URL:  /services/apexrest/omnistudio/v2/DataRaptor/DRMExtractAccountContactDetails/0015i000004rK1TAAU
In Id pass the accountId.

2. Use Parameters to Retrieve Data

We can pass multiple parameters to retrieve data from Salesforce by using DataMapper Extract by issuing a get request.
GET /services/apexrest/{myOrgNamespace}/v2/DataRaptor/{DataMapperName}/?${Param1}=${Val1}&${Param2}=${Val2}...
  • myOrgNamespace - Namespace prefix
  • DataMappername - Name of the DataMapper Extract
  • In Param1 and Param2 we will mention the key name which is used as a filter in DataMapper and in Val1, Val2 we will pass the details. 
Will use same DataMapper Extract by adding more filters.
If we pass Id or other parameters like account name and industry we will get the details.
From Workbench we will call this DataMapper Extract by using below syntax
/services/apexrest/{myOrgNamespace}/v2/DataRaptor/{DataMapperName}/?${Param1}=${Val1}&${Param2}=${Val2}...

URL:  /services/apexrest/omnistudio/v2/DataRaptor/DRMExtractAccountContactDetails/?AccountName=Acme&AccountIndustry=Other




Comments

Post a Comment

Popular posts from this blog

Vlocity Facts #01 | OmniStudio DataRaptors

DataRaptor is a mapping tool that  you can use to read, transform, and write Salesforce data. For Example. In each interaction with a digital customer  or business process, the system needs to extract the data in order to display it. If the user modifies this data or enters new data, they also need to be saved. This is where we use OmniStudio DataRaptors.  Where to use DataRaptors? Retrieving Data:   OmniScript calls  DataRaptor Extract (via the integration procedure) to read the data from Salesforce. For example, OmniScript editing an account should display data such as account name, phone number, website, and so on. Manipulating data: OmniScript captures modified and new data based on user input. For example, an agent changes the  phone number of an account. Save Data:   OmniScript calls DataRaptor Load (via the integration procedure) to write the data back to Salesforce. For example, the updated account phone number is saved back to the Account rec...
Read more

Vlocity Facts #44 || Communication between Omniscript and Flexcard [Pub/Sub]

Image
Flexcards have the ability to trigger and listen to two kinds of events: Custom and Pubsub events . Custom Events: Facilitate the transmission of information between a child and its parent. This can occur between a child Flexcard and its parent Flexcard, or between an element and the Flexcard to which it belongs. Pubsub Events: Allows communication between two separate components. This could occur between two separate Flexcards on the same Lightning page, known as sibling Flexcards, or between a Flexcard and an Omniscript.  In this post I will discuss about Pub/Sub event. Consider we have omniscript and flexcard individually on home page when an update happens we need to show those details in flexcard. To achieve this we can use pub/sub event. Step 1: Create a omniscript according to your requirement. I'm trying to create Contact record by using Step element and data raptor post action. Now to trigger the flexcard we need to configure the messaging frame work when an update happen...
Read more

Vlocity Facts #45 || Pop-Up Screen and Navigating to the Next Step in Omniscript by using LWC

Image
Consider one scenario where we need to show confirmation screen when user proceeding to next steps after updating details.  To achieve this, you'll need to use a custom button: when a user clicks it, a pop-up screen will appear, which can be implemented using LWC. Create LWC component  1. HTML code 2. JS code import { LightningElement , track } from 'lwc' ; import { OmniscriptBaseMixin } from "omnistudio/omniscriptBaseMixin" ; export default class ConfirmationScreenLWC extends OmniscriptBaseMixin ( LightningElement ) { @ track isOpen = false ;   handleShowPopUp() {         this .isOpen = true ;     }     handleOk() {         this .omniNextStep();     }    handleClose() {         this .isOpen = false ;     } } Enable a custom Lightning web component to interact with OmniScript by extending the OmniScriptBaseMixin component. The OmniScriptBaseMixin include...
Read more