Jira Connector for Python In this article you will learn how to integrate Jira data in 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 Documentation The driver mentioned above 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. ODBC PowerPack - System Requirements and Installation Getting Started - Using ODBC PowerPack ODBC API Driver Help File

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 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 PowerShell 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 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:

1. Install ZappySys ODBC PowerPack.

2. Open ODBC Data Sources (x64):
   

3. 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.

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 to get 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	Fill in the parameter...

   

    Personal Access Token (PAT) Authentication [Http]

   Steps to get Jira Credentials
   Copy below URL and open in browser to see instructions about creating PAT (Personal Access Token) to access JIRA data using API.

   https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html

   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	Fill in the parameter...

   

    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 Help..]

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

   1. Go to Atlassian Developer area.
   2. Click Create app and select OAuth 2.0 (3LO) integration app to create an OAuth app.
   3. Give your app a name, accept the terms and hit Create.
   4. Then hit App details panel and copy paste Client ID and Secret into the API Connection Manager configuration grid into the proper places.
   5. Then go back and click Permissions panel to enable permissions/scopes for your application. You can enable them all.
   6. Go back again to application settings and click Authorization panel.
   7. 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.
   8. Use this same Callback URL (Return URL) in a API Connection Manager configuration grid.
   9. 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
   10. Also configure your company's Subdomain in the properties grid.
   11. Click Generate Token to generate tokens.
   12. That's it!

   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])	Fill in the parameter...

   

6. 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:
   

7. Click OK to finish creating the data source.

Video instructions

Read data in Python

Using ODBC DSN

1. Python code to get the data:
   

   JiraDSN')

   

2. When you run the code it will make the API call and read the data:
   

3. 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 id,title FROM products")
   
       row = cursor.fetchone()
       while row:
           print(row)
           row = cursor.fetchone()
   
       ##For loop example
       #for row in cursor:
       #    print(row)
   

Using a full ODBC connection string

If you want to avoid being dependent on a DSN 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:

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

   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 in your Python code use Connection String when initializing OdbcConnection object, for example:

   conn = pyodbc.connect('DRIVER={ZappySys API Driver};ServiceUrl=https://yourservices.provider.com/api/xxxx....;AuthName=Http;')

How to install `pyodbc` in the Python?

Advanced topics

Create Custom Stored 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 Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
   

2. Enter the desired Procedure name and click on OK:
   

3. Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored 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>';
   

   
   

4. That's it now go to Preview Tab and Execute your Stored 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';

   
   

5. Let's generate the SQL Server Query Code to make the API call using stored 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 @fromdate=''1996-07-30''')

   
   

6. Now go to SQL served and execute that query and it will make the API call using stored 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.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

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.

1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
   

2. Enter the desired Table name and click on OK:
   

3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

4. 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'

   
   

5. 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"

   
   

6. Let's generate the SQL Server Query Code to make the API call using stored 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''')

   
   

7. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
   

Actions supported by Jira Connector

Jira Connector Examples for Python Connection

This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

SELECT * FROM Issues

select * from Issues Where Id=10001

SELECT * FROM Issues WITH(Key='CS-1')

SELECT * FROM Issues WITH(Key='CS-1, CS-2, 10003, 10004')

SELECT * FROM Issues WITH(Project='CS')

SELECT * FROM Issues WITH (Jql='status IN (Done, Closed) AND created > -5d' )
/*
Useful links:
  https://support.atlassian.com/jira-work-management/docs/jql-fields/
  https://www.atlassian.com/software/jira/guides/jql/tutorials#advanced-search
  https://www.atlassian.com/blog/jira/jql-the-most-flexible-way-to-search-jira-14
  
Other Possible JQL expressions:

Ids (IN):       key IN(10001, 10002, 10003);
Keys (IN):       key IN(CS-1, CS-2, CS-3);
Projects (IN):       project IN(PROJ1, PROJ2, PROJ3);
Status (EQUAL):       status='Done';
Date (Expression 1):       created >=-5d;
Date (Expression 2):       created >=startOfMonth() AND created <=now();
Date (Expression 3):       created >=startOfYear() AND created <=startOfDay();
Date (Static):       created >= 2008/12/31;
Date (Static with time):       created >= 2008/12/31 23:59;
Project and Status (AND + IN):       project=CS AND status NOT IN ('Done', 'Open', 'Closed');
Assignee and Created Date:    assignee is NOT EMPTY and created < -1d;
Text (Contains - Fuzzy):       Summary ~ 'some words' OR description ~ 'some words';
Text (Contains - Fuzzy Wildcard):       Summary ~ 'some*' OR description ~ 'some*';
Text (Contains - Exact):       Summary ~ '\"exact words\"' OR description ~ '\"exact words\"';
Text (Does Not Contain - Fuzzy):       Summary !~ 'some words' OR description !~ 'some words';
Empty OR Null:   fixVersion is empty OR fixVersion is null;
Is Not Empty OR Is Not Null:    fixVersion is not empty OR fixVersion is not null;
WAS Operator (previous value):       status WAS "Resolved" BY (jsmith,srogen) BEFORE "2019/02/02";
WAS IN Operator:   status WAS IN ("Resolved", "In Progress");
WAS NOT IN Operator:    status WAS NOT IN ("Resolved", "In Progress");
WAS + BY + DURING (date range):       status WAS "Resolved" BY (jsmith,srogen) DURING("2019/02/02", "2020/02/02");
CHANGED operator:    assignee CHANGED;
CHANGED operator (multiple):       status CHANGED FROM "In Progress" TO "Open"

*/

INSERT INTO Issues(ProjectKey, IssueTypeName, Summary, Description)
VALUES('SMP', 'Task', 'My ticket inserted through the API', 'A description about an issue')
WITH (Output=1)

UPDATE Issues
SET Summary = 'This is my summary'
   ,Description = 'Lot''s of stuff to describe'
   ,Labels = '[ "bugfix" ]'
   ,DueDate = '2029-10-10'
--WHERE Id=1234   
--WHERE Id='ISSKEY'   
WITH (
	IssueIdOrKey='ISSKEY', --or use Id in where clause 
	Output=1,
	NotifyUsers=0,
	OverrideScreenSecurity=0,
	OverrideEditableFlag=0,
	ContinueOn404Error=0
)'

UPDATE Issues
SET customfield_10050='[{"value":"AAA"},{"value":"BBB"}]'	--CUSTOM Checkboxes (Must use Raw JSON)
,customfield_10051='2020-12-31'	--CUSTOM Date
,customfield_10052='2020-12-31T23:59:59'	--CUSTOM DateTime

--Custom Dropdown / Radio fields
,customfield_10048_value='BBB'	--CUSTOM Dropdown (Using value - i.e. item label)
--OR--
--,customfield_10048_id='10022'	--CUSTOM Dropdown (Using id - i.e. item id)
--OR
--,customfield_10048='{"value":"BBB"}'	--CUSTOM Dropdown (Using Raw value)

,customfield_10053='["bugfix","test"]'	--CUSTOM Labels (Must use Raw JSON)
,customfield_10057='[{"value":"AAA"},{"value":"BBB"}]'	--CUSTOM Listbox Multiselect (Must use Raw JSON)
,customfield_10049=123455555.123	--CUSTOM Number
,customfield_10054_text='Long string...line-1 
	Long string... line-2 
	Long string... line-3'	--CUSTOM Paragraph

,customfield_10055_value='BBB'	--CUSTOM Radio
--OR
--,customfield_10055_id='10023'	--CUSTOM Radio

,customfield_10058='https://zappysys.com'	--CUSTOM Url
,customfield_10059='{"accountId":"5dd64082af96bc0efbe55103","displayName":"System"}'	--CUSTOM User --accountId=5dd64082af96bc0efbe55103
,customfield_10060='Custom text single line'	--CUSTOM text single line 
--WHERE Id=10000
WITH (
	IssueIdOrKey='ISSKEY', --or use Id in where clause 
	Output=1,
	NotifyUsers=0,
	OverrideScreenSecurity=0,
	OverrideEditableFlag=0,
	ContinueOn404Error=0
)

--For INSERT use same values with same fields like below. For Insert you do not have to specify Id or Key
--INSERT INTO Issues(ProjectKey, IssueTypeName, Summary, Description, customfield_10050,....., customfield_10060) 
--VALUES ('SMP', 'Task', 'My ticket inserted through the API', 'A description about an issue', '[{"value":"AAA"},{"value":"BBB"}]' ,... 'Custom text single line')

'

UPDATE Issues
SET Summary = 'This is done on <<fun_now>>'
Where 1=1
WITH (jql='status=done' , ContinueOn404Error=0)
--WITH (jql='key in(10001, 10002, 10003)' , ContinueOn404Error=0)
--WITH (jql='key in(CS-1, CS-2, CS-3)', ContinueOn404Error=0)

DELETE FROM Issues
WITH (IssueIdOrKey='10020', OUTPUT=1, ContinueOn404Error=0)

DELETE FROM Issues
Where 1=1
WITH (jql='status=done' , ContinueOn404Error=0)
--WITH (jql='key in(10001, 10002, 10003)' , ContinueOn404Error=0)
--WITH (jql='key in(CS-1, CS-2, CS-3)', ContinueOn404Error=0)

SELECT * FROM Comments

SELECT * FROM Comments Where IssueId=10003 --OR WITH(Key='10003')

SELECT * FROM Comments WITH(Key='CS-1')

SELECT * FROM Comments WITH (Jql='status IN (Done, Closed) AND created > -5d' )

SELECT * FROM Fields

SELECT * FROM Projects

SELECT * FROM Worklogs Where IssueId=10003 --WITH(Key='10003')

SELECT * FROM Worklogs WITH (Jql='status IN (Done, Closed) AND created > -5d' )

INSERT INTO Projects(ProjectKey, Name, ProjectTypeKey, LeadAccountId, AssigneeType)
VALUES ('TEST', 'Test Project', 'software', '70122:XXXXXXXX-XXXX-XXXX-XXXX-c5da8c98b9e2', 'PROJECT_LEAD)
WITH (Output=1)')

UPDATE Projects
SET Name = 'My Test Kanban Project'
   ,ProjectCategoryId = 1
WITH (ProjectIdOrKey = 'MYPRJCT', Output=1, ContinueOn404Error=0)

DELETE FROM Projects
WITH (ProjectIdOrKey = '10020', Output=1, ContinueOn404Error=0)

SELECT * FROM Users

INSERT INTO Users(EmailAddress, DisplayName, Name, Password)
VALUES ('my@user.com', 'John Doe', 'John', 'xhedkspstdadaothoua')
WITH (OUTPUT=1)

DELETE FROM Users
WITH (OUTPUT=1, accountId = '547059:136095a0-XXXX-XXXX-XXXX-3e4c66f26551', ContinueOn404Error=0)

SELECT * FROM Worklogs

INSERT INTO Worklogs(TimeSpentInSeconds, Comment, StartedAt)
      VALUES(7200,'My Comment!','2020-02-23T16:20:30.123+0000')
      WITH (IssueIdOrKey='ISSKEY-1', OUTPUT=1)

UPDATE Worklogs
SET TimeSpentInSeconds = 28800
   ,Comment='My Comment!'
   ,StartedAt='2020-01-23T16:20:30.123+0000'
WITH (IssueIdOrKey='MTK-1', WorklogId='123465', OUTPUT=1, ContinueOn404Error=0)

DELETE FROM Worklogs
WITH (IssueIdOrKey='10020', WorklogId='123465', OUTPUT=1, ContinueOn404Error=0)

--(By value)        
UPDATE Issues 
SET customfield_10048_value ='BBB' --supply value (label) of dropdown/radio
WITH (IssueIdOrKey='10020')

--OR-- (By item ID)

UPDATE Issues 
SET customfield_10048_id =10023 --supply id of dropdown/radio item
WITH (IssueIdOrKey='10020')

--OR-- (Raw id)

UPDATE Issues 
SET customfield_10048='{"id":"10023"}' --supply raw json
WITH (IssueIdOrKey='10020')

--OR--  (Raw value)
UPDATE Issues 
SET customfield_10048='{"value":"BBB"}' --supply raw json
WITH (IssueIdOrKey='10020')

--OR--  (set null)

UPDATE Issues 
SET customfield_10048 =null 
WITH (IssueIdOrKey='10020')

UPDATE Issues 
SET customfield_10048='[{"value":"AAA"}, {"value":"CCC"}]' --supply raw json
WITH (IssueIdOrKey='10020')

--OR-- 

UPDATE Issues 
SET customfield_10048 =null --set to null
WITH (IssueIdOrKey='10020')

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 

More integrations

Other application integration scenarios for Jira

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

C#

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC

Other connectors for Python

Amazon Ads

Amazon MWS

Amazon Selling Partner (SP-API)

Asana

Azure DevOps

Cosmos DB

DropBox

ElasticSearch

FastSpring

Google BigQuery

Google Calendar

Google Drive

Google Sheets

Hubspot

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

Nativo

OData

OneDrive

Outlook Mail (Office 365)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Stripe

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

Download Jira Connector for Python Documentation

Common Searches: