Automate ServiceDesk Plus Integration Tasks from PowerShell

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Are you in search of a quick and easy way to access ServiceDesk Plus data from PowerShell? This article demonstrates how to utilize the ServiceDesk Plus Cmdlets for tasks like connecting to ServiceDesk Plus 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 ServiceDesk Plus.

ADO.NET Provider

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

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

Using OAuth Authentication

ServiceDeskPlus uses Zoho OAuth 2.0 for secure authentication. To set up OAuth access:

  1. Register your application in the Zoho Developer Console at https://api-console.zoho.com
  2. Configure your redirect URI to match your application setup
  3. Note your Client ID and Client Secret from the application settings

After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to OAuth.
  • OAuthClientId: Set this to your Zoho application Client ID.
  • OAuthClientSecret: Set this to your Zoho application Client Secret.
  • Scope: Set this to the required ServiceDeskPlus permissions (default includes read access to requests, problems, assets, and projects).
  • Domain: Set this to your ServiceDeskPlus domain
  • Portal: Set this to your ServiceDeskPlus portal

Example Connection String

Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;
  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 ServiceDesk Plus:

     
    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;")
    $conn.Open()
    
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

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

Ready to get started?

Connect to live data from ServiceDesk Plus with the API Driver

Connect to ServiceDesk Plus