Query Jira Service Management Data Using the OData SDK for PHP

The CData API Server, when paired with the ADO.NET Provider for Jira Service Management, exposes Jira Service Management data (or data from any of 200+ other ADO.NET Providers) as Web services. You can follow the procedure below to work with Jira Service Management data as PHP objects.

Set Up the API Server

Follow the steps below to begin producing secure Jira Service Management OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Jira Service Management

After you deploy the API Server and the ADO.NET Provider for Jira Service Management, provide authentication values and other connection properties needed to connect to Jira Service Management by clicking Settings -> Connections and adding a new connection in the API Server administration console.

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

You can then choose the Jira Service Management entities you want to allow the API Server access to by clicking Settings -> Resources.

Additionally, configure the API Server for compatibility with the OData SDK for PHP: Click Server -> Settings and in the OData section set Default Version to 2.0.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. You can authenticate as well as encrypt connections with SSL. Access can also be restricted based on IP address; by default, only connections from the local machine are allowed.

For simplicity, we will authenticate to the API Server by setting the authtoken in the URL. This is not enabled by default; you will need to add the following lines to the API Server configuration file, settings.cfg.

The settings.cfg file is located in the data directory. In the .NET edition, the data directory is the app_data folder under the www folder. In the Java edition, the data directory's location depends on the operation system:

• Windows: C:\ProgramData\CData\JiraServiceDesk\
• Unix or Mac OS X: ~/cdata/JiraServiceDesk/

Work with Jira Service Management Entities as PHP Objects

Follow the steps below to use the ODataPHP SDK to create a proxy class that will connect to the Web services exposed by the API Server.

1. Pass the URL to a command like the one below:

   php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-authtoken/ /out=C:\PHPLib\ODataphp\JiraServiceDeskEntities.php

   The preceding command defines classes from the metadata returned in the response from the OData endpoint, then outputs the class definitions to the specified folder.

   Both the API Server and the OData SDK for PHP support forms and Windows authentication. The API Server uses authtokens to authenticate users authorized to access the OData endpoint. You can supply authtokens in HTTP Basic authentication or append them to the OData URL.

   You can configure authorized users in the Settings -> Users section of the API Server administration console.

2. You can now start accessing Jira Service Management data using an object-oriented interface in PHP. The code below creates a record of the Requests table and then retrieves the live data, showing the newly created record.

   require_once 'JiraServiceDeskEntities.php'; try{ $svc = new CData(); $requests = new Requests(); $requests->CurrentStatus = 'Open'; $svc->AddToRequests($requests); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->requests()->Execute(); foreach($response->Result as $requests) echo $requests->RequestId."
"; } catch (Exception $e) { //catch errors from the API Server echo $e->getError(), "\n"; }