Python Jira Connector
In this article you will learn how to integrate 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. 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. |
See also
|
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 DriverYou 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:
JiraDSNJira -
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.
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:
JiraDSNAPI Key based Authentication [Http]https://[$Subdomain$].atlassian.net/rest/api/3Required 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 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:
- offline_access (a must)
- read:jira-user
- read:jira-work
- write:jira-work
- manage:jira-project
- 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:
JiraDSNOAuth based Authentication [OAuth]https://[$Subdomain$].atlassian.net/rest/api/3Required 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.Parameter | Description |
---|
Parameter | Description |
---|---|
CustomColumnsRegex |
|
Parameter | Description |
---|
Parameter | Description |
---|---|
AccountId |
|
Parameter | Description |
---|---|
ProjectIdOrKey |
|
Parameter | Description |
---|---|
ProjectIdOrKey |
|
EnableUndo |
|
Parameter | Description |
---|---|
IssueIdOrKey |
|
NotifyUsers |
|
OverrideScreenSecurity |
|
OverrideEditableFlag |
|
Parameter | Description |
---|---|
IssueIdOrKey |
|
Parameter | Description |
---|---|
IssueIdOrKey |
|
WorklogId |
|
Parameter | Description |
---|---|
IssueIdOrKey |
|
WorklogId |
|
Parameter | Description |
---|---|
IssueId Or Key |
|
Parameter | Description |
---|---|
IssueId Or Key |
|
Parameter | Description |
---|---|
IssueId Or Key |
|
Comma Separated ChangeLog Ids |
|
Parameter | Description |
---|---|
FieldId |
|
Parameter | Description |
---|---|
FieldId |
|
ContextId |
|
Parameter | Description |
---|---|
Url |
|
Body |
|
IsMultiPart |
|
Filter |
|
Headers |
|
Other App Integration scenarios for Jira
Other Connectors for Python
Download Jira Connector for Python
Documentation
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