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

Introduction

In this article we will delve deeper into Salesforce and PowerShell 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 PowerShell.

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 PowerShell 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 PowerShell

Open your favorite PowerShell IDE (we are using Visual Studio Code).

Use this code snippet to read the data using SalesforceDSN data source:

"DSN=SalesforceDSN"

Read API data with PowerShell using ODBC DSN in Visual Code

For your convenience, here is the whole PowerShell script:

# Configure connection string and query
$connectionString = "DSN=SalesforceDSN"
$query = "SELECT * FROM Customers"

# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable

# Fill the table with data
$adapter.Fill($table)

# Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab
$format = "{0}`t{1}`t{2}`t{3}"

# Display data in the console
foreach ($row in $table.Rows)
{
    # Construct line based on the format and individual Salesforce fields
    $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"])
    Write-Host $line
}

Access specific Salesforce table field using this code snippet:

$field = $row["ColumnName"]

You will find more info on how to manipulate DataTable.Rows property in Microsoft .NET reference.

For demonstration purposes we are using sample tables which may not be available in Salesforce.

To read values in a console, save the script to a file and then execute this command inside PowerShell terminal:
You can also use even a simpler command inside the terminal, e.g.:
```
. 'C:\Users\john\Documents\dsn.ps1'
```