Jira Service Management Connection Details

Introduction

Connector Version

This documentation is based on version 21.0.8662 of the connector.

Get Started

Jira Service Desk Version Support

The connector leverages the Jira Service Desk API to enable bidirectional access to Jira Service Desk.

The connector works with both Jira Service Desk Cloud accounts and Jira Service Desk Server instances.

Atlassian Jira Service Management was formerly known as Jira Service Desk and received its new name as of its version 4.14. However, there are many references to Service Desk in this documentation, the Atlassian documentation, and the Atlassian REST APIs. See the Atlassian Service Management 4.14.x release notes for details.

Establish a Connection

Connect to Jira Service Desk

You can establish a connection to any Jira Service Desk Cloud account or Jira Service Desk Server instance. To connect set the following property:

• URL (for example: https://yoursitename.atlassian.net).

Authenticate to Jira Service Desk

Basic Authentication

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

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

Authenticating with a local Server Account

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

• AuthScheme: Set this Basic.
• 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.

Authenticate with a Custom OAuth App (3LO)

You can leverage Jira Service Desk's "three-legged" OAuth 2.0 support (3LO) to connect to data without providing your login credentials. See Using OAuth Authentication for an authentication guide.

Authenticate Using OAuth1.0

To connect to Jira Service Desk you will need to follow the steps below:

• Firstly, generate an RSA public/private key pair. In your terminal, run the following commands:
  -openssl genrsa -out jira_privatekey.pem 1024
  -openssl req -newkey rsa:1024 -x509 -key jira_privatekey.pem -out jira_publickey.cer -days 365
  -openssl pkcs8 -topk8 -nocrypt -in jira_privatekey.pem -out jira_privatekey.pcks8
  -openssl x509 -pubkey -noout -in jira_publickey.cer -out jira_publickey.pem
  
• Create application links in your account. Go to Settings -> Applications -> Application links.
• Enter a test URL for the URL field, click 'Create new link'.
• Ignore the error and click continue. We only want to configure incoming calls (from app to Jira Service Desk).
• In the 'Link applications' window, fill in the fields as you like as they are not relevant. But make sure to check 'Create incoming link'. Click Continue to go to the next page.
• Fill in the required fields:
  -Consumer Key: Fill this as you like. You will use this as OAuthClientId later on.
  -Consumer Name: Fill this as you like.
  -Public key: Enter the key in the 'jira_publickey.pem' file you generated earlier. And click continue.

To connect set the following properties:

• URL (for example: https://yoursitename.atlassian.net).
• OAuthClientId to the Consumer Key of your application.
• OAuthClientSecret to any value (such as 'testClientSecret').
• OAuthJWTCert to the location of your private key file.
• OAuthJWTCertType to the appropriate option based on the private key file being used. If using the generated PEM key file, set OAuthJWTCertType to PEMKEY_FILE.
• InitiateOAuth to GETANDREFRESH.

Authenticate with Crowd

Set the AuthScheme to Crowd. The following connection properties are used to connect to Crowd:

• User: The CROWD user account.
• Password: The password associated with the Crowd account.
• SSOLoginURL: The login URL associated with the Crowd account. You can find the IDP URL by navigating to your application -> SSO -> SSO information -> Identity provider single sign-on URL.
• SSOAppName: The name of the application in which SSO is enabled.
• SSOAppPassword: The password of the application in which SSO is enabled.
• SSOExchangeUrl: The URL used used to exchange the SAML token for JiraServiceDesk cookies. This URL may have the following formats:
  • https://<authority of JiraServiceDesk instance>/plugins/servlet/samlconsumer
  • https://<authority of JiraServiceDesk instance>/plugins/servlet/samlsso

The following is an example connection string:

AuthScheme=Crowd;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://<authority>/crowd/console/secure/saml/sso.action';User=crowdUserName;Password=crowdPassword;SSOExchangeUrl=https://<authority of JiraServiceDesk instance>/plugins/servlet/samlconsumer;SSOAppName=CrowdAppName;SSOAppPassword=CrowdAppPassword;

Authenticate with Okta

Set the AuthScheme to Okta. The following connection properties are used to connect to Okta:

• User: Set this to the Okta user.
• Password: Set this to Okta password for the user.
• SSOLoginURL: Set this to the login URL used by the SSO provider.
• SSOExchangeUrl: The URL used used to exchange the SAML token for JiraServiceDesk cookies. This URL may have the following formats:
  • https://<authority of JiraServiceDesk instance>/plugins/servlet/samlconsumer
  • https://<authority of JiraServiceDesk instance>/plugins/servlet/samlsso

The following SSOProperties are needed to authenticate to Okta:

• APIToken (optional): Set this to the API Token that the customer created from the Okta org. It should be used when authenticating a user via a trusted application or proxy that overrides OKTA client request context.
• MFAType (optional): Set this only in case you have configured MFA flow. Currently we support only the follwoing types: OktaVerify,Email and SMS.
• MFAPassCode (optional): Set this only in case you have configured MFA flow. If this is set to empty/invalid the driver will initially issue a MFA challenge which will trigger the platform to send you an one-time password on your device or email, based on the configured MFA type. You need to re-issue another connection where the retrieved one-time password value is passed to MFAPassCode connection property.

The following is an example connection string:

AuthScheme=Okta;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';User=oktaUserName;Password=oktaPassword;SSOExchangeUrl=https://<authority of JiraServiceDesk instance>/plugins/servlet/samlconsumer;

Access Custom Fields

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

Use OAuth Authentication

OAuth requires the authenticating user to interact with Jira Service Desk using the browser. The connector facilitates this in various ways as described below.

Custom Credentials

Once you've created your app, you can connect with Custom Credentials.

Create a Custom OAuth App

See Creating a Custom OAuth App for the procedure. Your new app will contain the OAuthClientId and OAuthClientSecret needed to establish a connection.

Custom Credentials

This section describes desktop authentication using the credentials for your custom OAuth app. See Creating a Custom OAuth App for more information.

Get an OAuth Access Token

After setting the following, you are ready to connect:

• OAuthClientId: Set to the Client ID in your app settings.
• OAuthClientSecret: Set to the Client Secret in your app settings.
• CallbackURL: Set to the Redirect URL in your app settings.
• OAuthVersion: Set to 2.0.
• URL: The URL to your JIRA Service Desk endpoint; for example, https://yoursitename.atlassian.net.
• InitiateOAuth: Set to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.

When you connect, the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the following OAuth process:

1. Extracts the access token from the callback URL and authenticates requests.
2. Obtains a new access token when the old one expires.
3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Headless Machines

To create Jira Service Desk data sources on headless servers or other machines on which the connector cannot open a browser, you need to authenticate from another machine. Authentication is a two-step process.

1. Instead of installing the connector on another machine, you can follow the steps below to obtain the OAuthVerifier value. Or, you can install the connector on another machine and transfer the OAuth authentication values, after you authenticate through the usual browser-based flow.
2. You can then configure the connector to automatically refresh the access token from the headless machine.

You can follow the headless OAuth authentication flow using the connector's embedded OAuth credentials or using the OAuth credentials for your custom OAuth app.

Use the Credentials for a Custom OAuth App

Create a Custom OAuth App

See Creating a Custom OAuth App for a procedure. This section describes the procedure to authenticate and connect to data.

OAuth 2.0

Obtain a Verifier Code

First, set the following properties on the headless machine:

• InitiateOAuth: Set to OFF.
• OAuthClientId: Set to the App ID in your app details.
• OAuthClientSecret: Set to the App Secret in your app details.
• OAuthVersion: Set to 2.0.

Next, authenticate from another machine and obtain the OAuthVerifier connection property:

1. Call the GetOAuthAuthorizationURL stored procedure with the CallbackURL input parameter set to the exact Redirect URI you specified in your app details under APIS AND FEATURES -> OAuth 2.0 (3LO).
2. Open the returned URL in a browser. Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code.
3. Save the value of the verifier code. You need to set this in the OAuthVerifier connection property.

Finally, on the headless machine, set the following connection properties to obtain the OAuth authentication values:

• OAuthClientId: Set to the consumer key in your app details.
• OAuthClientSecret: Set to the consumer secret in your app details.
• OAuthVerifier: Set to the verifier code.
• OAuthSettingsLocation: Set to persist the encrypted OAuth authentication values to the specified file.
• InitiateOAuth: Set to REFRESH.

OAuth 1.0

Obtain a Verifier Code

First, set the following properties on the headless machine:

• InitiateOAuth: Set to OFF.
• OAuthClientId: Set to the App ID in your app details.
• OAuthClientSecret: Set to the App Secret in your app details.
• OAuthVersion: Set to 1.0.
• Save the value of the returned AuthToken and AuthKey. They will be used in the next step.
• Open the returned URL in a browser. Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code.

Next, authenticate from another machine and obtain the OAuthVerifier connection property:

1. Call the GetOAuthAuthorizationURL stored procedure with the CallbackURL input parameter set to the exact Redirect URI you specified in your app details under APIS AND FEATURES -> OAuth 2.0 (3LO).
2. Open the returned URL in a browser. Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code.
3. Save the value of the verifier code. You need to set this in the OAuthVerifier connection property.

Finally, on the headless machine, set the following connection properties to obtain the OAuth authentication values:

• OAuthClientId: Set to the consumer key in your app details.
• OAuthClientSecret: Set to the consumer secret in your app details.
• OAuthVerifier: Set to the verifier code.
• AuthToken: Set this to the AuthToken.
• AuthKey: Set this to the AuthKey.
• OAuthSettingsLocation: Set to persist the encrypted OAuth authentication values to the specified file.
• InitiateOAuth: Set to REFRESH.

Connect to Data

After the OAuth settings file is generated, set the following properties to connect to data:

• OAuthSettingsLocation: Set to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.
• InitiateOAuth: Set to REFRESH.
• OAuthVersion: Set to 2.0.
• URL: The URL to your JIRA Service Desk endpoint; for example, https://yoursitename.atlassian.net.

Transfer OAuth Settings

To install the connector on another machine, authenticate, and then transfer the resulting OAuth values:

1. On a second machine, install the connector and connect with the following properties set:
   • OAuthSettingsLocation: Set to a writable text file.
   • InitiateOAuth: Set to GETANDREFRESH.
   • OAuthClientId: Set to the Client ID in your app details.
   • OAuthClientSecret: Set to the Client Secret in your app details.
   • CallbackURL: Set to the Callback URL in your app details under APIS AND FEATURES -> OAuth 2.0 (3LO).
2. Test the connection to authenticate. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation. Once you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:
   • InitiateOAuth: Set to REFRESH.
   • OAuthSettingsLocation: Set to the path to your OAuth settings file. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.
   • OAuthVersion: Set to 2.0.
   • URL: The URL to your JIRA Service Desk endpoint; for example, https://yoursitename.atlassian.net.

Create a Custom OAuth App

If you do not have access to the user name and API token or do not wish to require them, you can use OAuth authentication. Jira Service Desk uses the OAuth authentication standard, which requires the authenticating user to interact with Jira Service Desk via the browser. The connector facilitates the OAuth exchange in various ways, as described in this section. Please note OAuth 2.0 is only supported for Jira Service Desk Cloud.

Create an OAuth App

To obtain the OAuth client credentials, consumer key, and consumer secret:

1. Log in to your JIRA Service Desk Cloud site.
2. Navigate to your app management (https://developer.atlassian.com/apps/).
3. Select Create new app, then name the app. The app will now be created.
4. If missing, add OAuth 2.0 functionality to your app by navigating to APIS AND FEATURES -> + Add -> Add OAuth 2.0 (3LO).
5. From APIS AND FEATURES -> + Add, add the JIRA Service Desk platform REST API to your app. Please note that you also need to add the JIRA app to get all of the functionalities of the driver.
6. From APIS AND FEATURES -> + JIRA Service Desk platform REST API, add the desired scopes to your app.
7. You'll additionally need to set up your Callback URL. Navigate to APIS AND FEATURES -> OAuth 2.0 (3LO). Enter a URL that is accessible to your app and save the changes.

Authenticate to Jira Service Desk from a Desktop Application

After setting the following connection properties, you are ready to connect:

• OAuthClientId: Set to the consumer key in your app details.
• OAuthClientSecret: Set to the consumer secret in your app details.
• CallbackURL: Set to the callback URL found in your app details under APIS AND FEATURES -> OAuth 2.0 (3LO).
• InitiateOAuth: Set to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
• OAuthVersion: Set to 2.0.
• URL: The URL to your JIRA Service Desk endpoint; for example, https://yoursitename.atlassian.net.

When you connect, the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the following OAuth process:

1. Gets the callback URL and sets the access token and oauthserverurl to authenticate requests.
2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
3. Exchanges the returned refresh token for a new, valid access token.

Authenticate to Jira Service Desk from a Web Application

To obtain the access token, set the following connection properties:

• OAuthClientId: Set to the consumer key in your app details.
• OAuthClientSecret: Set to the consumer secret in your app details.
• CallbackURL: Set to the callback URL in your app details under APIS AND FEATURES -> OAuth 2.0 (3LO).
• URL: The URL to your JIRA Service Desk endpoint; for example, https://yoursitename.atlassian.net.
• OAuthVersion: Set to 2.0.

When connecting via a web application, or if the connector is not authorized to open a browser window, you need to exchange temporary verification values for the access token:

1. Call GetOAuthAuthorizationURL. The stored procedure returns the URL to the OAuth endpoint.
2. Log in and authorize the application. You are redirected back to the callback URL. If you set the GrantType parameter to Implicit, the callbackURL contains the OAuthAccessToken and oauthserverurl in a query string parameter. If you set the GrantType parameter to code, the callback URL contains the verifier code in the query string parameter named "code". Extract the verifier code and call GetOAuthAccessToken.

To connect to data, set the following connection properties:

• OAuthAccessToken
• OAuthVersion
• OAuthClientId
• OAuthClientSecret
• OAuthAccessToken
• URL

Fine-Tuning Data Access

Fine Tuning Data Access

You can use the following properties to gain more control over the data returned from Jira Service Desk:

• ServiceDeskID: The ID of the specific service desk you would like to connect to.
  By default we get the first ID returned from an extra call to get all service desks. You can get the ServiceDeskId by executing a Select query to the ServiceDesks view.
• IncludeCustomFields: Whether or not to include custom fields in queries to the Requests table.
• RequestLanguage: Set this to any language installed in Jira to translate display column names in the specified language.
  Specify an IETF BCP 47 language tag as described here: https://tools.ietf.org/html/bcp47.

Important Notes

Configuration Files and Their Paths

• All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the Jira Service Desk connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

User Defined Views

The Jitterbit Connector for Jira Service Desk allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Requests WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Client SSL Certificates

The Jira Service Desk connector also supports setting client certificates. Set the following to connect using a client certificate.

• SSLClientCert: The name of the certificate store for the client certificate.
• SSLClientCertType: The type of key store containing the TLS/SSL client certificate.
• SSLClientCertPassword: The password for the TLS/SSL client certificate.
• SSLClientCertSubject: The subject of the TLS/SSL client certificate.

Data Model

Overview

This section shows the available API objects and provides more information on executing SQL to Jira Service Desk APIs.

Key Features

• The connector models Jira Service Desk entities like documents, folders, and groups as relational views, allowing you to write SQL to query Jira Service Desk data.
• Stored procedures allow you to execute operations to Jira Service Desk
• Live connectivity to these objects means any changes to your Jira Service Desk account are immediately reflected when using the connector.

Tables

Tables describes the available tables. Tables are statically defined to model Jira Service Desk entities such as RequestApprovals, RequestComments, and RequestParticipants.

Views

Views describes the available views. Views are statically defined to model Jira Service Desk entities such as Users, Organizations, and ServiceDesks.

Stored Procedures

Stored Procedures are function-like interfaces to Jira Service Desk. Stored procedures allow you to execute operations to Jira Service Desk, including downloading documents and moving envelopes.

Collaborative Query Processing

The connector offloads as much of the SELECT statement processing as possible to Jira Service Desk and then processes the rest of the query in memory. API limitations and requirements "are also documented in this section.

See SupportEnhancedSQL for more information on how the connector circumvents API limitations with in-memory client-side processing.

Tables

The connector models the data in Jira Service Desk into a list of tables that can be queried using standard SQL statements.

Generally, querying Jira Service Desk tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Jitterbit Connector for Jira Service Desk Tables

CustomerTransitions

Returns a list of transitions that customers can perform on the request.

Select

The connector will use the Jira Service Desk API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• RequestID supports the = operator.

For example, the following query is processed server side:

SELECT * FROM CustomerTransitions WHERE RequestID = '10001'

Columns

RequestApprovals

This resource represents a request approval.

Select

The connector will use the Jira Service Desk API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the following operator: =.

For example, the following query is processed server side:

SELECT * FROM RequestApprovals WHERE RequestID = '10001' AND ID = '10002'

Columns

RequestComments

This resource represents request comments.

Select

The connector will use the Jira Service Desk API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id, Public support the following operator: =.

For example, the following query is processed server side:

SELECT * FROM RequestComments WHERE RequestID = '10001' AND Id = '10002'
SELECT * FROM RequestComments WHERE RequestID = '10001' AND Public = 'true'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

RequestParticipants

This resource represents request participants.

Select

The connector will use the Jira Service Desk API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• RequestID supports the = operator.

For example, the following query is processed server side:

SELECT * FROM RequestParticipants WHERE RequestID = '10001'

Columns

Views

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard. To find out more about tables and stored procedures, please navigate to their corresponding entries in this help document.

Jitterbit Connector for Jira Service Desk Views

CustomersCloud

This resource represents a customer.

Columns

KnowledgeBaseArticles

The articles which match the given query string across all service desks.

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Organizations

This resource represents an organization.

Select

Columns

QueueInternal

This resource represents a user.

Columns

RequestsInternal

This resource represents a request.

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

RequestSLACycles

This resource represents the SLAs (service level agreements) on a customer request.

Columns

RequestStatusChangelog

This resource represents the status transitions for a customer request.

Select

The connector will use the Jira Service Desk API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• RequestID supports the = operator.
• RequestKey supports the = operator.

For example, the following query is processed server side:

SELECT * FROM RequestStatusChangelog WHERE RequestID = '10001'
SELECT * FROM RequestStatusChangelog WHERE RequestKey = 'TEST-1'

Columns

RequestTypeFields

The fields for a service desk's customer request type.

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

RequestTypeGroups

This resource represents a request type group.

Select

The connector will use the Jira Service Desk API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• ServiceDeskId supports the = operator.

For example, the following query is processed server side:

SELECT * FROM RequestTypeGroups WHERE ServiceDeskId = '1'

Columns

RequestTypes

This resource represents a request type.

Select

The connector will use the Jira Service Desk API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• ServiceDeskId supports the = operator.
• ID supports the = operator.
• GroupIds supports the = operator.

For example, the following query is processed server side:

SELECT * FROM RequestTypes WHERE ServiceDeskId = '1'
SELECT * FROM RequestTypes WHERE Id = '10012'
SELECT * FROM RequestTypes WHERE GroupIds = '12'

Columns

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

ServiceDesks

This resource represents a service desk. A service desk is based on a project in the JIRA platform, and is used to manage customer requests.

Select

The connector will use the Jira Service Desk API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

• Id supports the = operator.

For example, the following query is processed server side:

SELECT * FROM ServiceDesks WHERE ID = '1'

Columns

Users

This resource represents a user.

Select

Columns

Stored Procedures

Stored procedures are available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure because the data does not provide for direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return back a dataset that contains the collection of tuples that constitute the response.

Jitterbit Connector for Jira Service Desk Stored Procedures

AddAttachment

Creates a temporary attachment or assigns a temporary one to a request.

Input

Result Set Columns

AttachTemporaryFile

This method adds one or more temporary attachments to a service desk, which can then be permanently attached to a customer request using AddAttachment stored procedure.

Input

Result Set Columns

CreateCustomer

Creates a new customer.

Input

Result Set Columns

CreateSchema

Creates a schema file for the specified table or view.

Input

Result Set Columns

GetOAuthAccessToken

Gets an authentication token from JIRA.

Input

Result Set Columns

GetOAuthAuthorizationURL

Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the auth token from this URL.

Input

Result Set Columns

RefreshOAuthAccessToken

Refreshes the OAuth access token used for authentication with JiraServiceDesk.

Input

Result Set Columns

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Jira Service Desk:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Requests table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Requests'

Columns

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SampleProcedure stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2

Columns

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Requests table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Requests'

Columns

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:jiraservicedesk:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Collaborative Query Processing

When working with data sources that do not support SQL-92, you can query the sys_sqlinfo view to determine the query capabilities of the underlying APIs, expressed in SQL syntax. The connector offloads as much of the SELECT statement processing as possible to the server and then processes the rest of the query in memory.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the connector can offload to the data source or process client side. Your data source may support additional SQL syntax. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity

Columns

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Authentication

SSO

OAuth

SSL

Schema

Miscellaneous

Authentication

This section provides a complete list of authentication properties you can configure.

AuthScheme

The type of authentication to use when connecting to Jira Service Desk.

Possible Values

Auto, OAuth, Basic, Crowd

Data Type

string

Default Value

Auto

Remarks

• Auto: Lets the driver decide automatically based on the other connection properties you have set.
• OAuth: Set to this to perform OAuth authentication.
• Basic: Set this to use BASIC user / password or user / ApiToken authentication.
• Crowd: Set this to perform Crowd SSO authentication.

URL

The URL to your JIRA Service Desk endpoint.

Data Type

string

Default Value

""

Remarks

The URL to your JIRA Service Desk endpoint; for example, https://yoursitename.atlassian.net.

User

The Jira Service Desk user account used to authenticate.

Data Type

string

Default Value

""

Remarks

Together with Password, this field is used to authenticate against the Jira Service Desk server.

Password

The password used to authenticate the user.

Data Type

string

Default Value

""

Remarks

The User and Password are together used to authenticate with the server.

APIToken

APIToken of the currently authenticated user.

Data Type

string

Default Value

""

Remarks

APIToken of the currently authenticated user. You can retrieve an API Token in this link: https://id.atlassian.com/manage/api-tokens

SSO

This section provides a complete list of SSO properties you can configure.

SSOLoginURL

The identity provider's login URL.

Data Type

string

Default Value

""

Remarks

The identity provider's login URL.

SSOProperties

Additional properties required to connect to the identity provider in a semicolon-separated list.

Data Type

string

Default Value

""

Remarks

Additional properties required to connect to the identity provider in a semicolon-separated list. is used in conjunction with the SSOLoginURL.

SSO configuration is discussed further in .

SSOExchangeUrl

The URL used for consuming the SAML response and exchanging it with Jira Service Desk specific credentials.

Data Type

string

Default Value

""

Remarks

The Jitterbit Connector for Jira Service Desk will use the URL specified here to consume a SAML response and retrieve Jira Service Desk specific credentials. The retrieved credentials are the final piece during the SSO connection that are used to communicate with Jira Service Desk.

SSOAppName

App Name used with SSO for IdPs that require it.

Data Type

string

Default Value

""

Remarks

Along with SSOAppPassword, may be be specified to identify and authenticate to your app configured in the SSO IdP. Currently only Crowd supports it.

SSOAppPassword

App Password used with SSO for IdPs that require it.

Data Type

string

Default Value

""

Remarks

Along with SSOAppName, may be be specified to identify and authenticate to your app configured in the SSO IdP. Currently only Crowd supports it.

OAuth

This section provides a complete list of OAuth properties you can configure.

InitiateOAuth

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values

OFF, GETANDREFRESH, REFRESH

Data Type

string

Default Value

OFF

Remarks

The following options are available:

1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthVersion

The version of OAuth being used.

Possible Values

1.0, 2.0

Data Type

string

Default Value

1.0

Remarks

The version of OAuth being used. The following options are available: 1.0,2.0

OAuthClientId

The client ID assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

The access token for connecting using OAuth.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type

string

Default Value

%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

• Windows: "register://%DSN"
• Unix: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

Scope

This determines the scopes that the OAuth application requests from Jira Service Desk.

Data Type

string

Default Value

""

Remarks

Specify scope to obtain the initial access and refresh token.

By default the connector will request that the user authorize all available scopes. If you want to override this, you can set this property to a space-separated list of OAuth scopes.

CloudId

The Cloud ID for the Atlassian site that was authorized.

Data Type

string

Default Value

""

Remarks

This will be determined automatically during OAuth 2.0 authentication and returned from the GetOAuthAccessToken stored procedure. Do not set a value for CloudId when using InitiateOAuth.

OAuthVerifier

The verifier code returned from the OAuth authorization URL.

Data Type

string

Default Value

""

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

AuthToken

The authentication token used to request and obtain the OAuth Access Token.

Data Type

string

Default Value

""

Remarks

This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.

It can be supplied alongside the AuthKey in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.

AuthKey

The authentication secret used to request and obtain the OAuth Access Token.

Data Type

string

Default Value

""

Remarks

This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.

It can be supplied alongside the AuthToken in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.

OAuthRefreshToken

The OAuth refresh token for the corresponding OAuth access token.

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn

The lifetime in seconds of the OAuth AccessToken.

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

CertificateStoreType

The type of certificate store used with Jira Service Desk Private Application authentication.

Possible Values

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, P10BFILE, SSHPUBLIC_KEY_FILE, PPKFILE, XMLFILE, XMLBLOB

Data Type

string

Default Value

USER

Remarks

The name of the certificate store for the client certificate used in Jira Service Desk private application authentication. Jira Service Desk private application authentication uses SSL client authentication with digital certificates.

Specifying the Certificate Store Type

The CertificateStoreType property can take one of the following values:

Related Connection Properties

To specify the private certificate, you may need to set the following properties in addition to CertificateStoreType:

• CertificateStore: Set this to the name of the certificate store. For example, "MY" for a Windows certificate store or the file name of a file store.
• CertificateStorePassword: If the store is password-protected, provide the password here.
• CertificateSubject: Set this to the subject of the certificate. To locate the certificate in the store, the connector executes a search based on the specified subject. Refer to the CertificateSubject field for details.

CertificateStore

The certificate store used for JIRA Service Desk authentication.

Data Type

string

Default Value

""

Remarks

The location of the certificate store for the client certificate used in Jira Service Desk application authentication.

CertificateStorePassword

The password of the certificate store used with Jira Service Desk authentication.

Data Type

string

Default Value

""

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

CertificateSubject

The subject of the certificate used with Jira Service Desk Private Application authentication.

Data Type

string

Default Value

""

Remarks

The subject of the client certificate used in Jira Service Desk private application authentication.

About the Jira Service Desk Client SSL Auth Flow

Jira Service Desk private application authentication uses SSL client authentication with digital certificates.

Loading a Certificate

When loading a certificate the subject is used to locate the certificate in the store.

• If an exact match is not found, the store is searched for subjects containing the value of the property.
• If a match is still not found, no certificate is selected.
• The special value "*" picks the first certificate in the certificate store.

Specifying the Subject

The certificate subject is a comma-separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=example@jbexample.com". Common fields and their meanings are displayed below.

Note: If a field value contains a comma it must be quoted.

Additional Connection Properties

To specify the private certificate, you need to set CertificateSubject and the following additional properties:

• CertificateStore
• CertificateStoreType
• CertificateStorePassword

SSL

This section provides a complete list of SSL properties you can configure.

SSLClientCert

The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).

Data Type

string

Default Value

""

Remarks

The name of the certificate store for the client certificate.

The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert. If the store is password protected, specify the password in SSLClientCertPassword.

SSLClientCert is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).

SSLClientCertType

The type of key store containing the TLS/SSL client certificate.

Possible Values

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB

Data Type

string

Default Value

USER

Remarks

This property can take one of the following values:

SSLClientCertPassword

The password for the TLS/SSL client certificate.

Data Type

string

Default Value

""

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.

SSLClientCertSubject

The subject of the TLS/SSL client certificate.

Data Type

string

Default Value

*

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, E=support@company.com". The common fields and their meanings are shown below.

If a field value contains a comma, it must be quoted.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type

string

Default Value

%APPDATA%\JiraServiceDesk Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\JiraServiceDesk Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

IncludeCustomFields

A boolean indicating if you would like to include custom fields in the column listing.

Data Type

bool

Default Value

false

Remarks

Setting this to true will cause custom fields to be included in the column listing. To include the custom fields we need to make an individualized request per custom field and this may cause poor performance when listing metadata.

MaxRows

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Other

These hidden properties are used only in specific use cases.

Data Type

string

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

RequestLanguage

Use the requestLanguage to have column names translated in a specific language.

Data Type

string

Default Value

""

Remarks

Use the requestLanguage to have column names translated in a specific language. By default, column names are translated based on the requesting user's language preference, or the Jira site default language if anonymous. The languages available are based on the installed languages in Jira. Provide an IETF BCP 47 language tag as described in this link: https://tools.ietf.org/html/bcp47 .

ServiceDeskID

Service Desk ID of the currently authenticated user.

Data Type

string

Default Value

""

Remarks

Service Desk ID of the currently authenticated user. By default we get the first ID returned from an extra call to get all service desks. You can get the ServiceDeskId by executing a Select query to the ServiceDesks view.

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.