Automate PivotalTracker Integration Tasks from PowerShell

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Are you in search of a quick and easy way to access PivotalTracker data from PowerShell? This article demonstrates how to utilize the PivotalTracker Cmdlets for tasks like connecting to PivotalTracker data, automating operations, downloading data, and more.

The CData API Driver for ADO.NET is a standard ADO.NET Provider that make it easy to accomplish data cleansing, normalization, backup, and other integration tasks by enabling real-time access to PivotalTracker.

ADO.NET Provider

The ADO.NET Provider provides a SQL interface for PivotalTracker; this tutorial shows how to use the Provider to retrieve PivotalTracker data.

Once you have acquired the necessary connection properties, accessing PivotalTracker data in PowerShell can be enabled in three steps.

Start by setting the Profile connection property to the location of the PivotalTracker Profile on disk (e.g. C:\profiles\PivotalTracker.apip). Next, set the ProfileSettings connection property to the connection string for PivotalTracker (see below).

PivotalTracker API Profile Settings

Navigate to your Pivotal Tracker Profile settings and locate the API token section to copy your unique API token.

  1. Load the provider's assembly:

    [Reflection.Assembly]::LoadFile("C:\Program Files\CData\CData API Driver for ADO.NET\lib\System.Data.CData.API.dll")
        
  2. Connect to PivotalTracker:

     
    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\PivotalTracker.apip;ProfileSettings='APIKey=your_api_token';")
    $conn.Open()
    
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

    $sql="SELECT AccountId, Id from AccountMemberships"
    
    $da= New-Object System.Data.CData.API.APIDataAdapter($sql, $conn)
    $dt= New-Object System.Data.DataTable
    $da.Fill($dt)
    
    $dt.Rows | foreach {
    	Write-Host $_.accountid $_.id
    }
      

Ready to get started?

Connect to live data from PivotalTracker with the API Driver

Connect to PivotalTracker