Jira Connector for PowerShell Jira Connector can be used to integrate Jira and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete Issues, Users, Worklogs, Comments just in a few clicks! In this article you will learn how to quickly and efficiently integrate Jira data in PowerShell without coding. We will use high-performance Jira Connector to easily connect to Jira and then access the data inside PowerShell. Let's follow the steps below to see how we can accomplish that! Download Documentation Jira Connector for PowerShell is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few.

Connect to Jira in other apps Connect to Jira in SSIS Connect to Jira in SQL Server Connect to Jira in Power BI Connect to Jira in SSRS Connect to Jira in Informatica Connect to Jira in MS Access Connect to Jira in MS Excel Connect to Jira in SSAS Connect to Jira in C# Connect to Jira in Python Connect to Jira in JAVA Connect to Jira in Tableau Connect to Jira in SAP Crystal Reports Connect to Jira in Azure Data Factory (Pipeline) Connect to Jira in Azure Data Factory (SSIS) Connect to Jira in Talend Studio Connect to Jira in UiPath Connect to Jira in ODBC

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from Jira using PowerShell we first need to create a DSN (Data Source) which will access data from Jira. We will later be able to read data using PowerShell. Perform these steps:

1. Download and install ODBC PowerPack.

2. Open ODBC Data Sources (x64):

   

3. Create a User data source (User DSN) based on ZappySys API Driver

   ZappySys API Driver

   
   • Create and use User DSN if the client application is run under a User Account. This is an ideal option in design-time, when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit.
   • Create and use System DSN if the client application is launched under a System Account, e.g. as a Windows Service. Usually, this is an ideal option to use in a production environment. Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.

4. When the Configuration window appears give your data source a name if you haven't done that already, then select "Jira" from the list of Popular Connectors. If "Jira" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

   JiraDSN

   Jira

   

5. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

    API Key based Authentication [Http]

   Steps how to get and use Jira credentials
   Firstly, login into your Atlassian account and then go to your Jira profile:

   1. Go to Profile > Security.
   2. Click Create and manage API tokens.
   3. Then click Create API token button and give your token a label.
   4. When window appears with new API token, copy and use it in this connection manager.
   5. That's it!

   Fill in all required parameters and set optional parameters if needed:

   JiraDSN

   Jira

   API Key based Authentication [Http]

   https://[$Subdomain$].atlassian.net/rest/api/3

   Required Parameters
   Subdomain	Fill-in the parameter...
   Atlassian User Name (email)	Fill-in the parameter...
   API Key	Fill-in the parameter...
   Optional Parameters
   CustomColumnsRegex

   

    Personal Access Token (PAT) Authentication [Http]

   Steps how to get and use Jira credentials
   Follow official Atlassian instructions on how to create a PAT (Personal Access Token) for JIRA

   Fill in all required parameters and set optional parameters if needed:

   JiraDSN

   Jira

   Personal Access Token (PAT) Authentication [Http]

   https://[$Subdomain$].atlassian.net/rest/api/3

   Required Parameters
   Subdomain	Fill-in the parameter...
   Token (PAT Bearer Token)	Fill-in the parameter...
   Optional Parameters
   CustomColumnsRegex

   

    OAuth (**Must change API Base URL to V3 OAuth**) [OAuth]

   OAuth App must be created in Atlassian Developer Console. It is found at https://developer.atlassian.com/console/myapps/ [API reference]

   Steps how to get and use Jira credentials
   Firstly, login into your Atlassian account and then create Jira application:

   1. Go to Atlassian Developer area.

   2. Click Create and select OAuth 2.0 integration item to create an OAuth app:

      

   3. Give your app a name, accept the terms and hit Create:

      

   4. To enable permissions/scopes for your application, click Permissions tab, then hit Add button, and click Configure button, once it appears:

      

   5. Continue by hitting Edit Scopes button to assign scopes for the application:

      

   6. Select these scopes or all of them:

      

   7. Then click Authorization option on the left and click Add button:

      

   8. Enter your own Callback URL (Redirect URL) or simply enter https://zappysys.com/oauth, if you don't have one:

      

   9. Then hit Settings option and copy Client ID and Secret into your favorite text editor (we will need them in the next step):

      

   10. Now go to SSIS package or ODBC data source and in OAuth authentication set these parameters:

       • For ClientId parameter use Client ID value from the previous steps.
       • For ClientSecret parameter use Secret value from the previous steps.
       • For Scope parameter use the Scopes you set previously (specify them all here):
         • offline_access (a must)
         • read:jira-user
         • read:jira-work
         • write:jira-work
         • manage:jira-project
         • manage:jira-configuration
         NOTE: A full list of available scopes is available in Atlassian documentation.
       • For Subdomain parameter use your Atlassian subdomain value (e.g. mycompany, if full host name is mycompany.atlassian.net).
   11. Click Generate Token to generate tokens.
   12. Finally, select Organization Id from the drop down.
   13. That's it! You can now use Jira Connector!

   Fill in all required parameters and set optional parameters if needed:

   JiraDSN

   Jira

   OAuth (**Must change API Base URL to V3 OAuth**) [OAuth]

   https://[$Subdomain$].atlassian.net/rest/api/3

   Required Parameters
   ClientId	Fill-in the parameter...
   ClientSecret	Fill-in the parameter...
   Scope	Fill-in the parameter...
   ReturnUrl	Fill-in the parameter...
   Organization Id (Select after clicking [Generate Token])	Fill-in the parameter...
   Optional Parameters
   Custom Columns for output (Select after clicking [Generate Token])

   

6. Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

   

   ZappySys API Driver - Jira

   Jira Connector can be used to integrate Jira and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete Issues, Users, Worklogs, Comments just in a few clicks!

   JiraDSN

   

7. Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in PowerShell to retrieve data from Jira. Hit OK button to use this query in the next step.

   SELECT * FROM Issues

   
   Some parameters configured in this window will be passed to the Jira API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.

8. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in PowerShell:

   

   ZappySys API Driver - Jira

   Jira Connector can be used to integrate Jira and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete Issues, Users, Worklogs, Comments just in a few clicks!

   JiraDSN

   SELECT * FROM Issues

   
   You can also access data quickly from the tables dropdown by selecting <Select table>.
   A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Jira API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Jira servers).

9. Click OK to finish creating the data source.

Video Tutorial

Read Jira data in PowerShell

Sometimes, you need to quickly access and work with your Jira data in PowerShell. Whether you need a quick data overview or the complete dataset, this article will guide you through the process. Here are some common scenarios:

• Quickly peek at Jira data
• Monitor data constantly in your console

• Export data to a CSV file so that it can be sliced and diced in Excel
• Export data to a JSON file so that it can ingested by other processes
• Export data to an HTML file for user-friendly view and easy sharing
• Create a schedule to make it an automatic process

• Store data internally for analysis or for further ETL processes
• Create a schedule to make it an automatic process

• Integrate data with other systems via external APIs

In this article, we will delve deeper into how to quickly view the data in PowerShell terminal and how to save it to a file. But let's stop talking and get started!

Reading individual fields

1. Open your favorite PowerShell IDE (we are using Visual Studio Code).
2. Then simply follow these instructions:
   "DSN=JiraDSN"

   

   For your convenience, here is the whole PowerShell script:

   # Configure connection string and query
   $connectionString = "DSN=JiraDSN"
   $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 Jira fields
       $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"])
       Write-Host $line
   }
   

   Access specific Jira 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 Jira.
3. 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'

Retrieving all fields

However, there might be case, when you want to retrieve all columns of a query. Here is how you do it:

"DSN=JiraDSN"

Again, for your convenience, here is the whole PowerShell script:

# Configure connection string and query
$connectionString = "DSN=JiraDSN"
$query = "SELECT CustomerId, CompanyName, Country, Phone 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)

# Display data in the console
foreach ($row in $table.Rows) {
    $line = ""
    foreach ($column in $table.Columns) {
        $value = $row[$column.ColumnName]

        # Let's handle NULL values
        if ($value -is [DBNull])
        {
            $value = "(NULL)"
        }
        $line += $value + "`t"
    }
    Write-Host $line
}

SELECT * FROM Customers LIMIT 10

Using a full ODBC connection string

In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:

1. Open ODBC data source configuration and click Copy settings:
   

   ZappySys API Driver - Configuration [Version: 2.0.1.10418]

   ZappySys API Driver - Jira

   Jira Connector can be used to integrate Jira and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete Issues, Users, Worklogs, Comments just in a few clicks!

   JiraDSN

   
2. The window opens, telling us the connection string was successfully copied to the clipboard:
3. Then just paste the connection string into your script:
4. You are good to go! The script will execute the same way as using a DSN.

Limitations of using a full connection string

Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:

"Connection string exceeds maximum allowed length of 1024"

But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:

1. Open your ODBC data source.
2. Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
3. Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
4. Continue by pasting the copied connection string into a newly created file and save it.
5. Finally, the last step! Just construct a shorter ODBC connection string using this format:

   DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt

6. Our troubles are over! Now you should be able to use this connection string in PowerShell with no problems.

Write Jira data to a file in PowerShell

Save data to a CSV file

Export data to a CSV file so that it can be sliced and diced in Excel:

# Configure connection string and query
$connectionString = "DSN=JiraDSN"
$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)

# Export table data to a file
$table | ConvertTo-Csv -NoTypeInformation -Delimiter "`t" | Out-File "C:\Users\john\saved-data.csv" -Force

Save data to a JSON file

Export data to a JSON file so that it can ingested by other processes (use the above script, but change this part):

# Export table data to a file
$table | ConvertTo-Json | Out-File "C:\Users\john\saved-data.json" -Force

Save data to an HTML file

Export data to an HTML file for user-friendly view and easy sharing (use the above script, but change this part):

# Export table data to a file
$table | ConvertTo-Html | Out-File "C:\Users\john\saved-data.html" -Force

Actions supported by Jira Connector

Learn how to perform common Jira actions directly in PowerShell with these how-to guides:

• Create Issue Comment
• Create Issues
• Create Project
• Create User
• Create Worklog
• Delete Issue
• Delete Issue Comment
• Delete Project
• Delete User
• Delete Worklog
• Get custom field context options
• Get custom field contexts
• Read Application Roles
• Read Changelog Details
• Read Changelogs
• Read Changelogs by IDs
• Read Comments
• Read Custom Fields
• Read Fields
• Read Groups
• Read Issue Types
• Read Issues
• Read Projects
• Read Resources
• Read Users
• Read Worklogs
• Update Issue
• Update Issue Comment
• Update Worklog
• Upsert Project
• Generic Request
• Generic Request (Bulk Write)

Conclusion

In this article we showed you how to connect to Jira in PowerShell and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Jira, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).

We encourage you to download Jira Connector for PowerShell and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download Jira Connector for PowerShell Documentation

More integrations

Other connectors for PowerShell

Amazon Ads

Amazon Athena

Amazon Selling Partner (SP-API)

Apache Derby

Apache Hive

Apache Spark

Asana

Azure DevOps

Cosmos DB

DropBox

ElasticSearch

FastSpring

Google Ads

Google BigQuery

Google Calendar

Google Drive

Google Sheets

Hubspot

Infor Data Lake

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

MariaDB

OData

OneDrive

Outlook Mail (Office 365)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Starburst

Stripe

Trino

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

Other application integration scenarios for Jira

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

C#

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

ODBC

Common Searches: