Jira Connector for PowerShell

In this article you will learn how to integrate Jira data in PowerShell without coding in just a few clicks (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 PowerShell. Follow the steps below to see how we would accomplish that.

Download Documentation

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. Install ZappySys ODBC PowerPack.

  2. Open ODBC Data Sources (x64):
    Open ODBC Data Source

  3. Create a User Data Source (User DSN) based on ZappySys API Driver

    ZappySys API Driver
    Create new User DSN for 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
    ODBC DSN Template Selection

  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.

    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...
    ODBC DSN HTTP Connection Configuration
    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...
    ODBC DSN HTTP Connection Configuration

    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...
    ODBC DSN Oauth Connection Configuration

  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:
    ODBC ZappySys Data Source Preview

  7. Click OK to finish creating the data source.

Video instructions

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:

Viewing data in a terminal
  • Quickly peek at Jira data
  • Monitor data constantly in your console
Saving data to a file
  • 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
Saving data to a database
  • Store data internally for analysis or for further ETL processes
  • Create a schedule to make it an automatic process
Sending data to another API
  • 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"
    Read API data with PowerShell using ODBC DSN in Visual Code

    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: Read API data in PowerShell using ODBC DSN
    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"
Read all API columns from ODBC data source in PowerShell

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
}
You can limit the numbers of lines to retrieve by using a LIMIT keyword in the query, e.g.:
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 - 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
    Copy connection string for ODBC application
  2. The window opens, telling us the connection string was successfully copied to the clipboard: Successful connection string copying for ODBC application
  3. Then just paste the connection string into your script: Paste ODBC connection string in PowerShell to read API data
  4. You are good to go! The script will execute the same way as using a DSN.

Have in mind that using a full connection string has length limitations.

Proceed to the next step to find out the details.

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. It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If it happens you use such API, you may get this error:

"Connection string exceeds maximum allowed length of 1024"

But there is a solution to this by storing the Refresh Token in a file instead of directly in ODBC connection string. Follow the steps below to achieve this.

  1. Open your ODBC data source
  2. Hit Advanced tab and enter a file path:
    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
    Configure Refresh Token in ODBC data source
    If you cannot find the Advanced tab, try looking for Click to Configure link in Properties tab, under URL text box. Click it, and then configure the file path in OAuth Grant Options tab.
  3. Then click Copy settings button to copy a full connection string and paste it into your script.
  4. Proceed by pasting the connection string into your C# code as an argument when calling the OdbcConnection object's constructor.
  5. Before using it we still have to shorten it manually like this: Shorten ODBC connection string to read API data in PowerShell
  6. Our troubles are over, now you should be able to execute the script 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
Check useful PowerShell cmdlets other than ConvertTo-Csv, ConvertTo-Json, and ConvertTo-Html for other data manipulation scenarios.

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:
    ZappySys Driver - Add Stored Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Stored Procedure Name

  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>';
    

    ZappySys Driver - Create Custom Stored Procedure

  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';

    ZappySys Driver - Execute Custom Stored Procedure

  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''')

    ZappySys Driver - Generate SQL Server Query

  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.
    ZappySys Driver - Generate SQL Server Query

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:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  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'

    ZappySys Driver - Create Custom Table

  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"

    ZappySys Driver - Execute Custom Virtual Table Query

  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''')

    ZappySys Driver - Generate SQL Server Query

  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.
    ZappySys Driver - Generate SQL Server Query

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 more...]
 Read Fields
   [Read more...]
Parameter Description
 Read Custom Fields
   [Read more...]
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 more...]
 Read Users
   [Read more...]
Parameter Description
 Create User
   [Read more...]
 Delete User
   [Read more...]
Parameter Description
AccountId
 Read Projects
   [Read more...]
 Create Project
   [Read more...]
 Upsert Project
   [Read more...]
Parameter Description
ProjectIdOrKey
 Delete Project
   [Read more...]
Parameter Description
ProjectIdOrKey Project ID or Key, uniquely representing a project
EnableUndo
 Read Issues
   [Read more...]
 Create Issues
   [Read more...]
 Update Issue
   [Read more...]
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
Option Value
true true
false false
OverrideScreenSecurity Whether screen security should be overridden to enable hidden fields to be edited. Possible values: true, false
Option Value
true true
false false
OverrideEditableFlag Whether screen security should be overridden to enable uneditable fields to be edited. Possible values: true, false
Option Value
true true
false false
 Delete Issue
   [Read more...]
Parameter Description
IssueIdOrKey Enter Issue ID or Key
 Read Worklogs
   [Read more...]
Parameter Description
Issue Key(s) or Ids - Comma Separated (PRJA-10,PRJA-13) Use comma separated IDs or Keys for Issues. 1000 ids max or JIRA internal limit for Payload.
 Create Worklog
   [Read more...]
 Update Worklog
   [Read more...]
Parameter Description
IssueIdOrKey
WorklogId
 Delete Worklog
   [Read more...]
Parameter Description
IssueIdOrKey
WorklogId
 Read Comments
   [Read more...]
Parameter Description
Issue Key(s) or Ids - Comma Separated (PRJA-10,PRJA-13) Use comma separated IDs or Keys for Issues. 1000 ids max or JIRA internal limit for Payload.
 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    [Read more...]
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    [Read more...]
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    [Read more...]
Parameter Description
IssueId Or Key
Comma Separated ChangeLog Ids
 Get custom field contexts
Returns a paginated list list of contexts for a custom field. OAuth scopes required: read:field:jira, read:custom-field-contextual-configuration:jira    [Read more...]
Parameter Description
FieldId
 Get custom field context options
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    [Read more...]
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.    [Read more...]
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 Set 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

Jira Connector Examples for PowerShell 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.

List issues    [Read more...]

Lists all issues

SELECT * FROM Issues

List a single issue by Id    [Read more...]

select * from Issues Where Id=10001

List a single issue by Key    [Read more...]

List a single issue by Key or Numeric Id.

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

List multiple issues by Id or Key    [Read more...]

List multiple issues by comma separated Key(s) or Numeric Id(s).

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

List all issues for a specific project    [Read more...]

List all issues for a specified project code.

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

Search issues using Advanced JQL query expression    [Read more...]

List issues using JQL query expression

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 Issue    [Read more...]

Inserts a single issue to a particular project

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 Issue    [Read more...]

Updates an issue

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 / Insert Issue with Custom Fields    [Read more...]

Updates or Insert an issue with custom fields of various types (dropdown, radio, textarea .. so on)

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 multiple Issues matching with JQL search query    [Read more...]

Updates multiple issues which match with certain condition (JQL). Adding Where 1=1 or some other WHERE condition invokes Lookup endpoint (refer to other example to learn about JQL - see Search issues using Advanced JQL query expression)

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 Issue    [Read more...]

Deletes a single issue

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

DELETE multiple Issues matching with JQL search query    [Read more...]

Delete multiple issues which match with certain condition (JQL). Adding Where 1=1 or some other WHERE condition invokes Lookup endpoint (refer to other example to learn about JQL - see Search issues using Advanced JQL query expression)

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)

List comments for all issues    [Read more...]

List comments for all issues

SELECT * FROM Comments

List comments for a specific issue Issue Key or Id    [Read more...]

List comments for a specific issue

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

List comments for a specific issue by Key    [Read more...]

List comments for a specific issue by key

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

List comments for issues (search by JQL)    [Read more...]

List all comments for issues returned from a JQL search expression (refer to previous example to learn about JQL - see Search issues using Advanced JQL query expression)

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

List fields    [Read more...]

Lists all fields that are used and available in issue entity

SELECT * FROM Fields

List projects    [Read more...]

Lists all available projects

SELECT * FROM Projects

List worklog entries for a specific issue by Id or Key    [Read more...]

List all worklog entries for a specific issue

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

List worklogs for issues (search by JQL)    [Read more...]

List all worklogs (time entries) for issues returned from a JQL search expression (refer to previous example to learn about JQL - see Search issues using Advanced JQL query expression)

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

INSERT Project    [Read more...]

Inserts a single project

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 Project    [Read more...]

Updates a single project

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

DELETE Project    [Read more...]

Deletes a single project

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

List users    [Read more...]

Lists all available users

SELECT * FROM Users

INSERT User    [Read more...]

Inserts a single user

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

DELETE User    [Read more...]

Deletes a single user

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

List worklogs    [Read more...]

Lists all worklogs from all issues

SELECT * FROM Worklogs

INSERT Worklog    [Read more...]

Inserts a single worklog to a particular issue

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

UPDATE Worklog    [Read more...]

Updates a worklog

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 Worklog    [Read more...]

Deletes a single worklog of an issue

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

Update Custom Option Field (Dropdown/Radio)    [Read more...]

This example shows how to update a custom field of an issue by Option Value or Id (Of option entry item)

--(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 Custom Multi Select / User / Team fields (RAW Json Update)    [Read more...]

This example shows how to update a custom field of type array or other complex fiels like user

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 PowerShell and integrate data without any coding. Click here to Download Jira Connector for PowerShell 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 PowerShell Documentation 

More integrations

Other application integration scenarios for Jira

Other connectors for PowerShell


Download Jira Connector for PowerShell Documentation

  • How to connect Jira in PowerShell?

  • How to get Jira data in PowerShell?

  • How to read Jira data in PowerShell?

  • How to load Jira data in PowerShell?

  • How to import Jira data in PowerShell?

  • How to pull Jira data in PowerShell?

  • How to push data to Jira in PowerShell?

  • How to write data to Jira in PowerShell?

  • How to POST data to Jira in PowerShell?

  • Call Jira API in PowerShell

  • Consume Jira API in PowerShell

  • Jira PowerShell Automate

  • Jira PowerShell Integration

  • Integration Jira in PowerShell

  • Consume real-time Jira data in PowerShell

  • Consume real-time Jira API data in PowerShell

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

  • Connect Jira in PowerShell

  • Load Jira in PowerShell

  • Load Jira data in PowerShell

  • Read Jira data in PowerShell

  • Jira API Call in PowerShell