Natively Connect to Jira Service Desk Data in PHP

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Jira Service Desk ODBC Driver

The Jira Service Desk ODBC Driver is a powerful tool that allows you to connect with live data from Jira Service Desk, directly from any applications that support ODBC connectivity.

Access Jira Service Desk data like you would a database - read, write, and update Jira Service Desk Customers, Organizations, Requests, etc. through a standard ODBC Driver interface.



The CData ODBC driver for Jira Service Desk enables you to create PHP applications with connectivity to Jira Service Desk data. Leverage the native support for ODBC in PHP.

Drop the CData ODBC Driver for Jira Service Desk into your LAMP or WAMP stack to build Jira Service Desk-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Jira Service Desk data, execute queries, and output the results.

Configure a DSN

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

You can establish a connection to any Jira Service Desk Cloud account or Server instance.

Connecting with a Cloud Account

To connect to a Cloud account, you'll first need to retrieve an APIToken. To generate one, log in to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

Supply the following to connect to data:

  • User: Set this to the username of the authenticating user.
  • APIToken: Set this to the API token found previously.

Connecting with a Service Account

To authenticate with a service account, you will need to supply the following connection properties:

  • User: Set this to the username of the authenticating user.
  • Password: Set this to the password of the authenticating user.
  • URL: Set this to the URL associated with your JIRA Service Desk endpoint. For example, https://yoursitename.atlassian.net.

Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.

Accessing Custom Fields

By default, the connector only surfaces system fields. To access the custom fields for Issues, set IncludeCustomFields.

Establish a Connection

Open the connection to Jira Service Desk by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.

$conn = odbc_connect("CData ODBC JiraServiceDesk Source","user","password");

Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC JiraServiceDesk Source","user","password"); ... odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the odbc_prepare function.

$query = odbc_prepare($conn, "SELECT * FROM Requests WHERE CurrentStatus = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC JiraServiceDesk Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Requests WHERE CurrentStatus = ?"); $success = odbc_execute($query, array('Open'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC JiraServiceDesk Source","user","password"); $query = odbc_exec($conn, "SELECT RequestId, ReporterName FROM Requests WHERE CurrentStatus = 'Open'");

Process Results

Access a row in the result set as an array with the odbc_fetch_array function.

$conn = odbc_connect("CData ODBC Jira Service Desk data Source","user","password"); $query = odbc_exec($conn, "SELECT RequestId, ReporterName FROM Requests WHERE CurrentStatus = 'Open'"); while($row = odbc_fetch_array($query)){ echo $row["RequestId"] . "\n"; }

Display the result set in an HTML table with the odbc_result_all function.

$conn = odbc_connect("CData ODBC Jira Service Desk data Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Requests WHERE CurrentStatus = ?"); $success = odbc_execute($query, array('Open')); if($success) odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are Jira Service Desk-specific adaptations of the PHP community documentation for all ODBC functions.