Pipe Smartsheet Data to CSV in PowerShell

The CData Cmdlets Module for Smartsheet is a standard PowerShell module offering straightforward integration with Smartsheet. Below, you will find examples of using our Smartsheet Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your Smartsheet Data

Smartsheet uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

However, for testing purposes you can instead use the Personal Access Token you get when you create an application; set this to the OAuthAccessToken connection property.

$conn = Connect-Smartsheet  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackURL "$CallbackURL"

Selecting Data

Follow the steps below to retrieve data from the Sheet_Event_Plan_Budget table and pipe the result into to a CSV file:

Select-Smartsheet -Connection $conn -Table Sheet_Event_Plan_Budget | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\mySheet_Event_Plan_BudgetData.csv -NoTypeInformation

You will notice that we piped the results from Select-Smartsheet into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

Deleting Data

The following line deletes any records that match the criteria:

Select-Smartsheet -Connection $conn -Table Sheet_Event_Plan_Budget -Where "Assigned = Ana Trujilo" | Remove-Smartsheet

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Smartsheet, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MySheet_Event_Plan_BudgetUpdates.csv | %{
  $record = Select-Smartsheet -Connection $Smartsheet -Table Sheet_Event_Plan_Budget -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Smartsheet -Connection $smartsheet -Table Sheet_Event_Plan_Budget -Columns ("TaskName","Progress") -Values ($_.TaskName, $_.Progress) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Smartsheet -Connection $smartsheet -Table Sheet_Event_Plan_Budget -Columns ("TaskName","Progress") -Values ($_.TaskName, $_.Progress)
  }
}

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!