Python Jira Connector

In this article you will learn how to integrate Jira data to Python (live / bi-directional connection to 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!.

Using Jira Connector you will be able to connect, read, and write data from within Python. Follow the steps below to see how we would accomplish that.

Download Help File Buy

Driver mentioned in this article is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc.

If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started.

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

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

Install ZappySys ODBC PowerPack.
Open ODBC Data Sources (x64):
Create a User Data Source (User DSN) based on ZappySys API Driver

ZappySys API Driver

You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version.
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

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 to get Jira Credentials
Firstly, login into your Atlassian account and then go to your Jira profile:

Go to Profile > Security.
Click Create and manage API tokens.
Then click Create API token button and give your token a label.
When window appears with new API token, copy and use it in this connection manager.
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	Fill in the parameter...

OAuth based Authentication [OAuth]

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

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

Go to Atlassian Developer area.
Click Create app and select OAuth 2.0 (3LO) integration app to create an OAuth app.
Give your app a name, accept the terms and hit Create.
Then hit App details panel and copy paste Client ID and Secret into the API Connection Manager configuration grid into the proper places.
Then go back and click Permissions panel to enable permissions/scopes for your application. You can enable them all.
Go back again to application settings and click Authorization panel.
Click Configure button and in Callback URL enter your own Callback URL or simply enter https://zappysys.com/oauth if you don't have one.
Use this same Callback URL (Return URL) in a API Connection Manager configuration grid.
In API Connection Manager enter one or more of these scopes (read more about available scopes) into Scopes property:
1. offline_access (a must)
2. read:jira-user
3. read:jira-work
4. write:jira-work
5. manage:jira-project
6. manage:jira-configuration
Also configure your company's Subdomain in the properties grid.
Click Generate Token to generate tokens.
That's it!

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

JiraDSN

Jira

OAuth based Authentication [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])	Fill in the parameter...

Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
Click OK to finish creating the data source.

Read data in Python from the DSN

Python code to get the data:

JiraDSN')
When you run the code it will make the API call and read the data:

Here is Python program's code in text format:


import pyodbc

conn = pyodbc.connect('DSN=JiraDSN')

cursor = conn.cursor() 

#execute query to fetch data from API service
cursor.execute("SELECT * FROM value") 
row = cursor.fetchone() 
while row: 
print (row[1]) 
row = cursor.fetchone()

If you want to avoid to be dependent on a DSN name and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String . Then in your Python code use Connection String when initializing OdbcConnection object, for example:
```
conn = pyodbc.connect('DRIVER={ZappySys API Driver};ServiceUrl=https://services.odata.org/V3/Northwind/Northwind.svc;Provider=OData;AuthName=Http;')
```

Create Custom Store Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Store Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
Enter the desired Procedure name and click on OK:
Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
```
CREATE PROCEDURE [usp_get_orders]
    @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
 AS
    SELECT * FROM Orders where OrderDate >= '<@fromdate>';
```
That's it now go to Preview Tab and Execute your Store Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
```
Exec usp_get_orders '1996-01-01';
```
Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
```
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
```
Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

Go to Custom Objects Tab and Click on Add button and Select Add Table:
Enter the desired Table name and click on OK:
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
```
SELECT
  "ShipCountry",
  "OrderID",
  "CustomerID",
  "EmployeeID",
  "OrderDate",
  "RequiredDate",
  "ShippedDate",
  "ShipVia",
  "Freight",
  "ShipName",
  "ShipAddress",
  "ShipCity",
  "ShipRegion",
  "ShipPostalCode"
FROM "Orders"
Where "ShipCountry"='USA'
```
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
```
SELECT * FROM "vt__usa_orders_only"
```
Let's generate the SQL Server Query Code to make the API call using store procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
```
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
```
Now go to SQL served and execute that query and it will make the API call using store procedure and provide you the response.

Conclusion

In this article we discussed how to connect to Jira in Python and integrate data without any coding. Click here to Download Jira Connector for Python and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download Jira Connector for Python Documentation

Actions supported by Jira Connector

Jira Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.

Read Resources

Read Fields

Parameter	Description

Read Custom Fields

Parameter	Description
CustomColumnsRegex	Enter regular expression for custom columns which you like to output. Use Pipe to type keys (internal names for columns). You can use Regex too (e.g. field_100\d+ )

Read Issue Types

Read Users

Parameter	Description

Create User

Delete User

Parameter	Description
AccountId

Read Projects

Create Project

Upsert Project

Parameter	Description
ProjectIdOrKey

Delete Project

Parameter	Description
ProjectIdOrKey	Project ID or Key, uniquely representing a project
EnableUndo

Read Issues

Create Issues

Update Issue

Parameter	Description
IssueIdOrKey	Enter Issue ID or Key
NotifyUsers	Whether a notification email about the issue update is sent to all watchers. Possible values: true, false
OverrideScreenSecurity	Whether screen security should be overridden to enable hidden fields to be edited. Possible values: true, false
OverrideEditableFlag	Whether screen security should be overridden to enable uneditable fields to be edited. Possible values: true, false

Delete Issue

Parameter	Description
IssueIdOrKey	Enter Issue ID or Key

Read Worklogs

Create Worklog

Update Worklog

Parameter	Description
IssueIdOrKey
WorklogId

Delete Worklog

Parameter	Description
IssueIdOrKey
WorklogId

Read Comments

Read Changelogs

Returns a paginated list of all changelogs for an issue sorted by date, starting from the oldest. OAuth scopes required: read:issue-meta:jira, read:avatar:jira, read:issue.changelog:jira

Parameter	Description
IssueId Or Key

Read Changelog Details

Returns a paginated list of all changelogs and fields updated for an issue sorted by date, starting from the oldest. OAuth scopes required: read:issue-meta:jira, read:avatar:jira, read:issue.changelog:jira

Parameter	Description
IssueId Or Key

Read Changelogs by IDs

Returns changelogs for an issue specified by a list of changelog IDs. OAuth scopes required: read:issue-meta:jira, read:avatar:jira, read:issue.changelog:jira

Parameter	Description
IssueId Or Key
Comma Separated ChangeLog Ids

Read Get custom field contexts Details

Returns a paginated list list of contexts for a custom field. OAuth scopes required: read:field:jira, read:custom-field-contextual-configuration:jira

Parameter	Description
FieldId

Read Get custom field contexts Details

Returns a paginated list of all custom field option for a context. Options are returned first then cascading options, in the order they display in Jira. OAuth scopes required: read:field.option:jira

Parameter	Description
FieldId
ContextId

Generic Request

This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.

Parameter	Description
Url	API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body	Request Body content goes here
IsMultiPart	Check this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter	Enter filter to extract array from response. Example: $.rows[] --OR-- $.customers[].orders[*]. Check your response document and find out hierarchy you like to extract
Headers	Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

Other App Integration scenarios for Jira

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (ADF)

ODBC

Other Connectors for Python

Zendesk

Azure DevOps

ManagedEngine ServiceDesk Plus (Zoho)

Zoho CRM

Hubspot

Google Sheets

Stripe

YouTube

Google BigQuery

OneDrive

OData

Amazon Ads

Mailchimp

Jira

Outlook Mail (Office 365)

Zoom

Cosmos DB

Shopify

Nativo

Google Drive

SharePoint Online

Amazon MWS

ServiceNow

ElasticSearch

Google Calendar

DropBox

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

Download Jira Connector for Python Documentation

Common Searches:

How to connect Jira in Python?
How to get Jira data in Python?
How to read Jira data in Python?
How to load Jira data in Python?
How to import Jira data in Python?
How to pull Jira data in Python?
How to push data to Jira in Python?
How to write data to Jira in Python?
How to POST data to Jira in Python?
Call Jira API in Python
Consume Jira API in Python
Jira Python Automate
Jira Python Integration
Integration Jira in Python
Consume real-time Jira data in Python
Consume realtime Jira API data in Python
Jira ODBC Driver | ODBC Driver for Jira | ODBC Jira Driver | SSIS Jira Source | SSIS Jira Destination
Connect Jira in Python
Load Jira in Python
Load Jira data in Python
Read Jira data in Python
Jira API Call in Python

Python Jira Connector

How to Read/Write Jira data in Python

Python Jira Connector

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

API Key based Authentication [Http]

OAuth based Authentication [OAuth]

Read data in Python from the DSN

Create Custom Store Procedure in ZappySys Driver

Create Custom Virtual Table in ZappySys Driver

Conclusion

Actions supported by Jira Connector

Other App Integration scenarios for Jira

Other Connectors for Python

How to connect Jira in Python?

How to get Jira data in Python?

How to read Jira data in Python?

How to load Jira data in Python?

How to import Jira data in Python?

How to pull Jira data in Python?

How to push data to Jira in Python?

How to write data to Jira in Python?

How to POST data to Jira in Python?

Call Jira API in Python

Consume Jira API in Python

Jira Python Automate

Jira Python Integration

Integration Jira in Python

Consume real-time Jira data in Python

Consume realtime Jira API data in Python

Jira ODBC Driver | ODBC Driver for Jira | ODBC Jira Driver | SSIS Jira Source | SSIS Jira Destination

Connect Jira in Python

Load Jira in Python

Load Jira data in Python

Read Jira data in Python

Jira API Call in Python