Salesforce Connector for UiPath How to Make Generic API Request (Bulk Write)

Introduction

In this article we will delve deeper into Salesforce and UiPath integration, and will learn how to make generic api request (bulk write). We are continuing from where we left off. By this time, you must have installed ODBC PowerPack, created ODBC Data Source, and configured authentication settings in your Salesforce account .

So, let's not waste time and begin.

Use Query Builder to generate SQL query

The first thing you have to do is open Query Builder:

ZappySys API Driver - Salesforce

Amazon Ads Connector can be used to get Amazon advertisements using Amazon Advertisements API, download various advertisement-related reports.

SalesforceDSN
Then simply select the Make Generic API Request (Bulk Write) endpoint (action).
Continue by configuring the Required parameters. You can also set optional parameters too.
Move on by hitting Preview Data button to preview the results.

If you see the results you need, simply copy the generated query:

Make Generic API Request (Bulk Write)

Optional Parameters
Url	/something/123
IsMultiPart
Filter
Headers	Accept: / \|\| Cache-Control: no-cache
Advanced Properties
Request Method	POST
Request Format (Content-Type)	Default
Body	{$rows$}
JsonOutputFormat	Multicontent
DoNotOutputNullProperty
Batch Size (Default=1)	1
Meta Detection Order	StaticDynamicVirtual
Input Columns - For Mapping (e.g. MyCol1:string(10); MyCol2:int32 ...) - Use bool, int32, int64, datetime, decimal, double
Output Columns (e.g. MyCol1:string(10); MyCol2:int32 ...) - Use bool, int32, int64, datetime, decimal, double
Request Format
Response Format	Default
Csv - Column Delimiter	,
Csv - Row Delimiter	{NEWLINE}
Csv - Quote Around Value	True
Csv - Always Quote regardless type
Encoding
CharacterSet
Writer DateTime Format
Csv - Has Header Row	True
Xml - ElementsToTreatAsArray
Layout Map	<?xml version="1.0" encoding="utf-8"?> <!-- Example#1: Output all columns --> <settings> <dataset id="root" main="True" readfrominput="True" /> <map src="*" /> </settings> <!-- Example#2: Records under array <?xml version="1.0" encoding="utf-8"?> <settings singledataset="True"> <dataset id="root" main="True" readfrominput="True" /> <map name="MyArray" dataset="root" maptype="DocArray"> <map src="OrderID" name="OrderID" /> <map src="OrderDate" name="OrderDate" /> </map> </settings> --> <!-- Example#3: Records under nested section <?xml version="1.0" encoding="utf-8"?> <settings> <dataset id="dsRoot" main="True" readfrominput="True" /> <map name="NestedSection"> <map src="OrderID" name="OrderID_MyLabel" /> <map src="OrderDate" name="OrderDate_MyLabel" /> </map> </settings> -->

SELECT * FROM __DynamicRequest__
WITH
(
    "Url" = '/something/123',
    "RequestMethod" = 'POST'
)

That's it! You can use this query in UiPath.

Let's not stop here and explore SQL query examples, including how to use them in Stored Procedures and Views (virtual tables) in the next steps.

SQL query examples

Use these SQL queries in your UiPath data source:

How to Make generic api request

SELECT * FROM __DynamicRequest__
WITH
(
    "Url" = '/something/123',
    "RequestMethod" = 'POST'
)

generic_request_bulk_write endpoint belongs to __DynamicRequest__ table(s), and can therefore be used via those table(s).

Make Generic API Request (Bulk Write) in UiPath

Open UiPath Studio.
Before we really begin the work, make sure UiPath Studio is set as your profile (blue application icon).
In case, it is set to UiPath StudioX, you can change it in UiPath StudioX Settings:

Simply select UiPath Studio option:
Start by creating a new project based on UiPath Process template:
Add Run Query activity in Main Sequence box:
Click Configure Connection... button to create an ODBC connection:
Continue by clicking Connection Wizard:
When the window opens, select ODBC-based driver, provider, and then choose ODBC data source:

SalesforceDSN

SalesforceDSN

You can also select Use connection string option and use whole ODBC connection string instead. Obtain the connection string by pressing Copy Settings button in your data source configuration.
Once you do that, it's time to configure a SQL query:

Make sure, you enclose the query in double quotes!
Proceed by adding a Write CSV activity after Run Query:

In this article we are using Write CSV, but you can freely add any other destination of your choice, e.g. Write DataTable to Excel.
Once you do that, configure the added Write CSV, this will write Salesforce data to a CSV file:
It's time for fun! Which means it's time for debugging! Just run the package locally to debug:
Finally, ensure there are no execution errors!