This page provides a guide to Establishing a Connection to Jira in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Jira

Establishing a Connection shows how to authenticate to Jira and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Jira through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Jira by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Jira

To connect set the URL to your Jira endpoint; for example, https://yoursitename.atlassian.net.

Accessing Custom Fields

By default the Cloud surfaces only system fields. To access the custom fields for Issues, either set IncludeCustomFields to true, or extend the Cloud schemas to configure access to custom fields. (See Custom Fields.) Note that the server response time can be significantly slower when custom fields are included.

Authenticating to Jira

Jira supports authentication via either a Personal Access Token or OAuth 2.0.

Personal Access Token (PAT)

PATs are a secure way to authenticate to Jira, acting as a safe alternative to authenticating with a username and password. The advantage of authentication via PAT is that if the system is ever compromised, the administrator can revoke existing tokens immediately. This avoids the need to change the access password in all scripts and integrations.

PATs are created by each individual user. When created, they automatically have the same permissions level as the user. Users can create a PAT either via their Atlassian Settings menu, or using a REST API.

From the Atlassian application:

1. Select the profile picture at the top right of the screen. Jira displays a drop-down list.
2. Choose Settings >Profile.
3. At the left panel, select Personal Access Tokens
4. Click Create token
5. Give the new token a name.
6. If desired, set the token to automatically expire after a certain number of days. (Atlassian displays a reminder message five days before the token actually expires, which gives the user time to create a new token.)
7. Click Create.

The personal token displays. It cannot be viewed or retrieved after creation, so be sure to copy the token now and store it in a safe place.

Now set the following Jira Cloud properties:

• AuthScheme = PAT
• PAT = the value of the generated Personal Access Token.

Note: PATs can also be created using the REST API. For further information, see Jira's documentation on Creating PATs at https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html.

OAuth 2.0

You can leverage Jira's "three-legged" OAuth 2.0 support (3LO) to connect to data without providing your login credentials.

The following procedures assume that AuthScheme has been set to OAuth in all OAuth flows.

API Token

You can establish a connection to any Jira Cloud account by setting the AuthScheme to APIToken and providing the User and APIToken.
An API token is necessary for basic authentication to Cloud instances. To generate one, log in to your Atlassian account and navigate to Security > Create and manage API tokens > Create API token. The generated token will be shown once and should be stored securely.

By default, the Cloud sends the API token using the Basic authentication scheme. The provided User and APIToken are combined in a secure format compatible with services like Jira Cloud or miniOrange app. Alternatively, you can explicitly control the authentication behavior using the APITokenType connection property.

• Set APITokenType to Basic (default), to use standard Basic authentication, which requires both username and API token.
• Set APITokenType to Bearer, to send the token as a Bearer token (with or without username).

This provides flexibility for connecting to environments that expect different token formats while keeping configuration simple.

Basic

You can establish a connection to any Jira Server instance by setting the AuthScheme to Basic. To connect to a Server Instance provide the User and Password.
(Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.)

LDAP

You can establish a connection to any Jira Server instance by setting the AuthScheme to LDAP. Additionally provide the URL, User and Password of the Jira instance. (Note: LDAP Authentication is not currently supported for Cloud accounts.)

Crowd

Set the AuthScheme to Crowd, then configure these connection properties:

• 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 Jira cookies. This URL may have the following formats:
  • https://<authority of Jira instance>/plugins/servlet/samlconsumer
  • https://<authority of Jira instance>/plugins/servlet/samlsso

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 Jira instance>/plugins/servlet/samlconsumer;SSOAppName=CrowdAppName;SSOAppPassword=CrowdAppPassword;

Okta

To connect to Okta, set these properties:

• AuthScheme: Okta.
• User: The authentiating Okta user.
• Password: The password of the authenticating Okta user.
• SSOLoginURL: The SSO provider's login URL.
• SSOExchangeURL: The URL used used to exchange the SAML token for Jira cookies. This URL may have the following formats:
  • https://<authority of Jira instance>/plugins/servlet/samlconsumer
  • https://<authority of Jira instance>/plugins/servlet/samlsso

If you are either using a trusted application or proxy that overrides the Okta client request OR configuring MFA, you must use combinations of SSOProperties to authenticate using Okta. Set any of the following, as applicable:

• APIToken: When authenticating a user via a trusted application or proxy that overrides the Okta client request context, set this to the API Token the customer created from the Okta organization.
• MFAType: If you have configured the MFA flow, set this to one of the following supported types: OktaVerify, Email, or SMS.
• MFAPassCode: If you have configured the MFA flow, set this to a valid passcode.
  If you set this to empty or an invalid value, the Cloud issues a one-time password challenge to your device or email. After the passcode is received, reopen the connection where the retrieved one-time password value is set to the MFAPassCode connection property.
• MFARememberDevice: True by default. Okta supports remembering devices when MFA is required. If remembering devices is allowed according to the configured authentication policies, the Cloud sends a device token to extend MFA authentication lifetime. If you do not want MFA to be remembered, set this variable to False.

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 Jira instance>/plugins/servlet/samlconsumer;

Anonymous

You can connect to public endpoints in Jira that do not require authentication by setting the AuthScheme property to Anonymous. This allows the Cloud to access data without sending user credentials.

When using the Anonymous scheme, you must also set the Timezone connection property explicitly, because timezone data cannot be retrieved dynamically without authentication.

Important: This scheme should only be used when connecting to publicly accessible endpoints that are configured to allow anonymous access. If the Jira instance does not support anonymous access for the requested resource, the connection will fail or return an empty result set.

Set the following properties:

• AuthScheme: Set this to Anonymous.
• Timezone: Set this to the timezone of your Jira instance.

Required Scopes and Endpoint Domains for Jira

When integrating with Jira, your application needs specific permissions to interact with the API.

These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.

This topic provides information about the required access scopes and endpoint domains for the Jira Cloud.

Understanding Scopes

Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.

For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.

Required Scopes for Jira

Scopes can be controlled using the Scope connection property.

Jira Cloud has two types of scopes: Classic and Granular. Jira recommends Classic scopes when available.

Scope	Type	Description
read:jira-user	Classic	View user information in Jira that the user has access to, including usernames, email addresses, and avatars. Required for read and write access.
read:jira-work	Classic	Read Jira project and issue data, search for issues and objects associated with issues like attachments and worklogs. Required for read and write access.
write:jira-work	Classic	Create and edit issues in Jira, post comments as the user, create worklogs, and delete issues. Required for write access.
manage:jira-project	Classic	Create and edit project settings and create new project-level objects (for example, versions and components). Required for write access.
manage:jira-configuration	Classic	Take Jira administration actions (for example, create projects and custom fields, view workflows, and manage issue link types). Required for write access.
read:application-role:jira	Granular	View application roles. Required for read and write access.
read:audit-log:jira	Granular	View audit logs. Required for read and write access.
read:dashboard:jira	Granular	View dashboards. Required for read and write access.
read:filter:jira	Granular	View filters. Required for read and write access.
read:filter.column:jira	Granular	View filter columns. Required for read and write access.
read:group:jira	Granular	View user groups. Required for read and write access.
read:issue:jira	Granular	View issues. Required for read and write access.
write:issue:jira	Granular	Create and update issues. Required for write access.
delete:issue:jira	Granular	Delete issues. Required for write access.
read:issue-meta:jira	Granular	View issue meta. Required for read and write access.
read:attachment:jira	Granular	View issue attachments. Required for read and write access.
write:attachment:jira	Granular	Create and update issue attachments. Required for write access.
delete:attachment:jira	Granular	Delete issue attachments. Required for write access.
read:comment:jira	Granular	View issue comments. Required for read and write access.
write:comment:jira	Granular	Create and update issue comments. Required for write access.
delete:comment:jira	Granular	Delete issue comments. Required for write access.
read:comment.property:jira	Granular	View issue comment properties. Required for read and write access.
write:comment.property:jira	Granular	Create and update issue comment properties. Required for write access.
delete:comment.property:jira	Granular	Delete issue comment properties. Required for write access.
read:field:jira	Granular	View fields. Required for read and write access.
write:field:jira	Granular	Create and update fields. Required for write access.
read:field.option:jira	Granular	View field options. Required for read and write access.
read:field.options:jira	Granular	Read field options. Required for read and write access.
read:custom-field-contextual-configuration:jira	Granular	Read custom field contextual configurations. Required for read and write access.
write:custom-field-contextual-configuration:jira	Granular	Save custom field contextual configurations. Required for write access.
read:field-configuration:jira	Granular	Read field configurations. Required for read and write access.
write:field-configuration:jira	Granular	Save field configurations. Required for write access.
read:issue-link:jira	Granular	View issue links. Required for read and write access.
read:issue-link-type:jira	Granular	View issue link types. Required for read and write access.
read:issue.property:jira	Granular	View issue properties. Required for read and write access.
read:priority:jira	Granular	View priorities. Required for read and write access.
read:resolution:jira	Granular	View resolutions. Required for read and write access.
read:issue-details:jira	Granular	View issue details. Required for read and write access.
read:issue-security-scheme:jira	Granular	View issue security schemes. Required for read and write access.
read:issue-type:jira	Granular	View issue types. Required for read and write access.
read:issue-type-scheme:jira	Granular	View issue type schemes. Required for read and write access.
read:issue-type.property:jira	Granular	View issue type properties. Required for read and write access.
read:issue.watcher:jira	Granular	View issue watchers. Required for read and write access.
read:issue-worklog:jira	Granular	View issue worklogs. Required for read and write access.
read:issue-field-values:jira	Granular	View issue field values. Required for read and write access.
read:issue-security-level:jira	Granular	View issue security levels. Required for read and write access.
read:issue-status:jira	Granular	View issue statuses. Required for read and write access.
read:issue.changelog:jira	Granular	View issue changelogs. Required for read and write access.
read:issue.transition:jira	Granular	View issue transitions. Required for read and write access.
delete:issue-type:jira	Granular	Delete issue types. Required for write access.
write:issue-type:jira	Granular	Create and update issue types. Required for write access.
read:user:jira	Granular	View users. Required for read and write access.
read:user.columns:jira	Granular	View user columns. Required for read and write access.
read:project:jira	Granular	View projects. Required for read and write access.
write:project:jira	Granular	Create and update projects. Required for write access.
delete:project:jira	Granular	Delete projects and their details, such as issue types, project lead, and avatars. Required for write access.
read:project-category:jira	Granular	View project categories. Required for read and write access.
read:project.component:jira	Granular	View project components. Required for read and write access.
write:project.component:jira	Granular	Create and update project components. Required for write access.
delete:project.component:jira	Granular	Delete project components. Required for write access.
read:project.property:jira	Granular	View project properties. Required for read and write access.
write:project.property:jira	Granular	Create and update project properties. Required for write access.
delete:project.property:jira	Granular	Delete project properties. Required for write access.
read:project-role:jira	Granular	View project roles. Required for read and write access.
write:project-role:jira	Granular	Create and update project roles. Required for write access.
delete:project-role:jira	Granular	Delete project roles. Required for write access.
read:project-version:jira	Granular	View project versions. Required for read and write access.
write:project-version:jira	Granular	Create and update project versions. Required for write access.
delete:project-version:jira	Granular	Delete project versions. Required for write access.
read:issue.time-tracking:jira	Granular	View issue time tracking. Required for read and write access.
write:issue.time-tracking:jira	Granular	Create and update issue time tracking. Required for write access.
read:user.property:jira	Granular	View user properties. Required for read and write access.
write:user.property:jira	Granular	Create and update user properties. Required for write access.
delete:user.property:jira	Granular	Delete user properties. Required for write access.
read:workflow:jira	Granular	View workflows. Required for read and write access.
read:workflow-scheme:jira	Granular	View workflow schemes. Required for read and write access.
read:status:jira	Granular	View statuses. Required for read and write access.
read:workflow.property:jira	Granular	View workflow properties. Required for read and write access.
read:project-type:jira	Granular	View project types. Required for read and write access.
read:project.email:jira	Granular	View project emails. Required for read and write access.
write:project.email:jira	Granular	Create and update project emails. Required for write access.
read:role:jira	Granular	View roles. Required for read and write access.
read:user-configuration:jira	Granular	View user configurations. Required for read and write access.
write:user-configuration:jira	Granular	Create and update user configurations. Required for write access.
delete:user-configuration:jira	Granular	Delete user configurations. Required for write access.
read:jql:jira	Granular	View JQL. Required for read and write access.
validate:jql:jira	Granular	Validate JQL. Required for read and write access.

Jira Data Center has one type of scopes as shown in the table below.

Scope	Description
READ	View projects and issues the user account can view, including any related items, such as dashboards, filters, attachments, or comments. Also view the user profile.
WRITE	Create, update, and delete projects and issues the user account can change, including any related items, such as dashboards, filters, attachments, or comments. Also change the user profile.
ADMIN	Perform most administrative functions on the entire Jira instance, excluding functions such as backups, imports, and infrastructure settings which are limited to system administrators.
SYSTEM_ADMIN	Perform all administrative functions on the entire Jira instance, including functions such as backups, imports, and infrastructure settings. Note: This scope is not utilized by CData Cloud.

Understanding Endpoint Domains

Endpoint domains are the specific URLs that the application needs to communicate with in order to authenticate, retrieve records, and perform other essential operations.

Allowlisting these domains ensures that the network traffic between your application and the API is not blocked by firewalls or security settings.

Note: Most users do not need to make any special configurations. Allowlisting is typically only necessary for environments with strict security measures, such as restricted outbound network traffic.

Required Endpoint Domains for Jira

Domain	Always Required	Description
<URL>	TRUE	The URL of your Jira instance.
api.atlassian.com	FALSE	The base URL of the Jira API. Required when AuthScheme is set to OAuth.
<SSOLoginURL>	FALSE	The URL of your SSO provider. Required when AuthScheme is set to OKTA or CROWD.
<SSOExchangeURL>	FALSE	Your SSO Exchange URL. Required when AuthScheme is set to OKTA or CROWD.

Customizing the SSL Configuration

To enable TLS, set the following:

• URL: Prefix the connection string with https://

With this configuration, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Client SSL Certificates

The Jira Cloud 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.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Cloud models the Jira API as an easy-to-use SQL database. This allows connectivity to Jira Cloud accounts or Jira Server instances. There are three parts to the data model: tables, views, and stored procedures.

Tables

The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables, contain samples of what you might have access to in your Jira account.

Common tables include:

Table	Description
Issues	Provides full access to Jira issues. Supports creation, updates, deletions, and queries for issue records across all projects.
Projects	Provides access to all Jira projects. Supports querying, creating, updating, and deleting project records.
IssueTypes	Queries the available Issue Types in Jira, such as Task, Bug, Epic, and so on.
Users	Provides access to Jira users. Supports querying user details including account ID, email, and group memberships.
Comments	Manages comments added to issues. Supports creating, reading, updating, and deleting issue comments.
Attachments	Provides access to issue attachments in Jira. Supports querying, inserting, and deleting file attachments associated with issues.
Worklogs	Provides full access to Jira worklogs. Supports creating, updating, deleting, and querying logged work hours on issues.
Boards	Enables management of agile boards in Jira. Supports creation, querying, modification, and deletion of boards.
Sprints	Manages Jira sprints. Supports creating, modifying, deleting, and querying sprint data from agile boards.
Epics	Lists all epics across Jira projects, including epic names, summaries, and keys.
ProjectsIssueTypes	Displays issue types configured for each project, including standard and custom issue types.
Statuses	Lists all available issue statuses in Jira, including custom and default statuses used in workflows.
Workflows	Manages the available workflows in Jira, which define the sequence of statuses and transitions for issues.
WorkflowSchemes	Handles the configuration of workflow schemes that assign workflows to issue types across projects.
IssueChangelogs	Provides a detailed history of changes made to issues, including field changes, timestamps, and authors.
IssueLinks	Displays relationships between issues, such as 'blocks', 'duplicates', or 'relates to'.
IssueFixVersions	Returns the list of versions in which specific issues are expected to be resolved.
IssueComponents	Lists components assigned to issues, which typically represent parts or modules of a project.
CustomFieldContext	Returns a list of contexts for a custom field in Jira.
Fields	Retrieves metadata about all fields available in Jira, including both system-defined and custom fields.

API limitations and requirements are documented in each table.

Stored Procedures

Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard create, read, update, delete (CRUD) operations, including managing issues, attachments, and OAuth tokens.

The Cloud models the data in Jira as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Jira Tables

Name	Description
Attachments	Provides access to issue attachments in Jira. Supports querying, inserting, and deleting file attachments associated with issues.
Boards	Query, insert and delete the agile Boards in Jira.
Comments	Manages comments added to issues. Supports creating, reading, updating, and deleting issue comments.
IssueCustomFieldOptions	Create, modify, delete and query the configured Issue Custom Field Options in Jira.
Issues	Provides full access to Jira issues. Supports creation, updates, deletions, and queries for issue records across all projects.
IssueTypes	Query the available Issue Types in Jira.
ProjectComponents	Manages components within Jira projects. Supports creating, updating, deleting, and querying project components.
ProjectRoleActors	Manages role assignments within projects. Retrieves and updates users and groups assigned to project roles.
Projects	Provides access to all Jira projects. Supports querying, creating, updating, and deleting project records.
ProjectVersions	Provides access to project version management. Supports querying, creating, updating, and deleting versions.
RoleActors	Manages default role actors, who are automatically assigned to roles when new projects are created.
Roles	Lists all roles configured in Jira, such as 'Service Desk Team' or 'Project Manager'.
Sprints	Manages Jira sprints. Supports creating, modifying, deleting, and querying sprint data from agile boards.
Users	Provides access to Jira users. Supports querying user details including account ID, email, and group memberships.
Watchers	Query, insert and delete the available issue Watchers in Jira.
Workflows	Manages the available workflows in Jira, which define the sequence of statuses and transitions for issues.
WorkflowSchemes	Handles the configuration of workflow schemes that assign workflows to issue types across projects.
Worklogs	Provides full access to Jira worklogs. Supports creating, updating, deleting, and querying logged work hours on issues.

Provides access to issue attachments in Jira. Supports querying, inserting, and deleting file attachments associated with issues.

Table Specific Information

Select

The Cloud uses the Jira API to process some of the filters.

The Cloud processes other filters within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM Attachments WHERE Id = 10003

To retrieve attachments linked to a specific issue, query the Attachments table by specifying either the IssueId or IssueKey column.

SELECT * FROM Attachments WHERE IssueId = 123

To retrieve attachments linked to issues within a specific project, query the Attachments table by specifying either the ProjectId or ProjectName column.

SELECT * FROM Attachments WHERE ProjectId = 10100

Use the JQL pseudocolumn for more complex filters on the issues to retrieve attachments from. For example, retrieve attachments of issues that were created after January 7th:

SELECT * FROM Attachments WHERE JQL = 'created > 2018-01-07' 

Insert

Upload an attachment to an issue.

INSERT INTO Attachments (FilePath, IssueKey) VALUES ('C:/Users/User/Desktop/info.txt', 'SSFSF-1')

INSERT INTO Attachments (ContentEncoded, Name, IssueKey) VALUES ('U29tZSBjb250ZW50IGhlcmU=', 'Uploaded File', 'SSFSF-1')

Delete

Remove an attachment uploaded to any issue by specifying the Id of the attachment

DELETE FROM Attachments WHERE Id = 10003

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
Id [KEY]	Integer	False			Common	The unique numeric identifier of the attachment within the Jira system.
IssueId [KEY]	Integer	False	Issues.Id	=,<>,>,>=,<,<=,IN,NOT IN	Common	The internal identifier of the issue that the attachment is associated with.
IssueKey	String	False	Issues.Key	=,<>,>,>=,<,<=,IN,NOT IN	Common	The unique key that identifies the issue related to the attachment, such as 'JIRA-101'.
ProjectId	Integer	True	Projects.Id	=,IS,IS NOT,IN,NOT IN	Common	The numeric identifier of the project that contains the issue to which the attachment is linked.
ProjectName	String	True		=,IS,IS NOT,IN,NOT IN	Common	The name of the project that includes the issue where this attachment was added.
IssueCreatedDate	Datetime	False		=,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The timestamp indicating when the issue associated with this attachment was originally created.
IssueUpdatedDate	Datetime	False		=,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The timestamp of the most recent update to the issue related to this attachment.
Filename	String	False			Common	The original name of the uploaded file, including the file extension.
AuthorName	String	False			Common	The username of the user who uploaded the attachment.
AuthorDisplayName	String	False	Users.DisplayName		Common	The full display name of the user who uploaded the attachment, typically shown in the Jira UI.
Created	Datetime	False			Common	The date and time when the attachment was added to the issue.
Size	Integer	False			Common	The total file size of the attachment, in bytes.
MimeType	String	False			Common	The Multipurpose Internet Mail Extensions (MIME) type of the file, used to indicate the file format such as 'application/pdf' or 'image/jpeg'.
Content	String	False			Common	The direct Uniform Resource Identifier (URI) to access or download the full content of the attachment from Jira.
Thumbnail	String	False			Common	The URI to a smaller, thumbnail version of the attachment image if available. Typically used for previews.
AuthorAccountId	String	False	Users.AccountId		Cloud	The unique account ID of the user who uploaded the attachment. This ID is consistent across the Atlassian platform.
AuthorKey	String	False			Server	An internal Jira user key that uniquely identifies the user who added the attachment.

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.

Name	Type	Description
JQL	String	A field for specifying a Jira Query Language (JQL) expression to filter attachments by issue context when querying.
FilePath	String	The absolute path to the file on the local machine to be uploaded as an attachment.
ContentEncoded	String	The content of the file to upload, encoded in BASE64 format. Used in scenarios where direct file access is not possible.
Name	String	The name to assign to the uploaded file, including its extension, which will appear in the issue's attachment list.

Query, insert and delete the agile Boards in Jira.

Table Specific Information

Select

The Cloud uses the Jira API to process some of the filters. The Cloud processes other filters within the Cloud.

The following is an example of a query with server-side filters

SELECT * FROM Boards WHERE Id = 10022

Using other filters:

SELECT * FROM Boards WHERE ProjectKeyOrId = 'QMTH' AND Type = 'scrum'

Note: Valid Type filter values are 'scrum', 'kanban', and 'simple'.

Insert

To insert a new board you must specify Name, Type and FilterId.

INSERT INTO Boards (Name, Type, FilterId) VALUES ('New board', 'scrum', 10200)

Note: Valid input Type values are 'scrum' and 'kanban'.

Delete

To delete a board you must specify its Id.

DELETE FROM Boards WHERE Id = 130

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
Id [KEY]	Integer	True		=	Common	The Id of the board.
Name	String	False		=	Common	The name of the board.
Type	String	False		=	Common	The type of the board. For READ operations valid values are 'scrum', 'kanban', and 'simple'. For CREATE operations only 'scrum' and 'kanban' are supported.

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.

Name	Type	Description
ProjectKeyOrId	String	Filter the agile boards based on the project they are located in.
FilterId	String	ID of a filter that the user has permissions to view. Not supported for team-managed boards.

Manages comments added to issues. Supports creating, reading, updating, and deleting issue comments.

Table Specific Information

Select

You can query this table to retrieve comments posted on all issues.

The Cloud uses the Jira API to process some of the filters.

The Cloud processes other filters within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM Comments

To retrieve comments associated with a specific issue, query the Comments table by specifying either the IssueId or IssueKey column.

SELECT * FROM Comments WHERE IssueId = 10003

To retrieve comments associated to issues within a specific project, query the Comments table by specifying either the ProjectId or ProjectName column.

SELECT * FROM Comments WHERE ProjectId = 10100

Additionally, the Created column can be used in the ORDER BY clause:

SELECT * FROM Comments WHERE IssueId = 10003 ORDER BY Created DESC

Insert

Post a comment as the logged in user. IssueId and Body are required.

INSERT INTO Comments (IssueId, Body) VALUES ('10003', 'Test Comment')

Update

Only the body of the comment can be updated. The IssueId is required for an UPDATE as well.

UPDATE Comments SET Body = 'Updated Comment' WHERE Id = 10202 AND IssueId = 10003

Delete

Delete a comment posted in an issue by providing the Id and IssueId

DELETE FROM Comments WHERE Id = 10202 AND IssueId = 10003

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
Id [KEY]	Integer	True		=	Common	The unique identifier assigned to the comment within the Jira system.
IssueId [KEY]	Integer	False	Issues.Id	=,<>,>,>=,<,<=,IN,NOT IN	Common	The numeric ID of the issue that the comment is associated with. This ID is internal to Jira.
IssueKey	String	False	Issues.Key	=,<>,>,>=,<,<=,IN,NOT IN	Common	The issue key linked to the comment, such as 'PROJ-101', which uniquely identifies the issue in a human-readable format.
ProjectId	Integer	True	Projects.Id	=,IS,IS NOT,IN,NOT IN	Common	The numeric ID of the project that contains the issue the comment belongs to.
ProjectName	String	True		=,IS,IS NOT,IN,NOT IN	Common	The name of the project that includes the issue associated with this comment.
IssueCreatedDate	Datetime	True		=,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The date and time when the issue linked to this comment was originally created.
IssueUpdatedDate	Datetime	True		=,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The date and time when the issue related to this comment was last updated.
AuthorDisplayName	String	True	Users.DisplayName		Common	The full display name of the user who originally created the comment.
AuthorEmail	String	True	Users.EmailAddress		Common	The email address associated with the user who created the comment.
UpdateDisplayName	String	True	Users.DisplayName		Common	The full display name of the user who last updated or edited the comment.
UpdateAuthorEmail	String	True	Users.EmailAddress		Common	The email address of the user who most recently modified the comment.
Body	String	False			Common	The raw content of the comment, typically in plain text or markup, as entered by the author.
RenderedBody	String	True			Common	The processed version of the comment body, rendered in HTML or another display format for the user interface.
Created	Datetime	True			Common	The timestamp indicating when the comment was first submitted.
Updated	Datetime	True			Common	The timestamp indicating the most recent update to the comment, if applicable.
VisibilityType	String	False			Common	The method used to restrict comment visibility, such as by group or project role.
VisibilityValue	String	False			Common	The specific group name or role name used to control who can view the comment.
AuthorAccountName	String	True			Server	The username of the Jira account that created the comment.
AuthorAccountKey	String	True			Server	The unique Jira user key corresponding to the account that authored the comment.
UpdateAuthorAccountKey	String	True			Server	The unique Jira user key of the account that last modified the comment.
UpdateAuthorAccountName	String	True			Server	The username of the user who most recently edited the comment.
AuthorAccountId	String	True	Users.AccountId		Cloud	The Jira account ID of the user who originally posted the comment. This ID is used in API interactions.
UpdateAuthorAccountId	String	True	Users.AccountId		Cloud	The Jira account ID of the user who most recently updated the comment. This is used for audit tracking.
ItemURL	String	True			Common	A URL pointing directly to the comment, allowing users to open it in the Jira interface.

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.

Name	Type	Description
JQL	String	A Jira Query Language (JQL) expression used to retrieve issues with specific comment criteria, such as author or date range.

Create, modify, delete and query the configured Issue Custom Field Options in Jira.

Table Specific Information

Cloud

In Jira Cloud, this object is exposed as a table and supports CREATE, UPDATE, AND DELETE (CUD) operations.

Server

In Jira Server, this object is exposed as a view instead of a table, and CUD operations are not supported.

Select

Cloud

To execute a query in Jira Cloud, you must specify both the CustomFieldId and the Context.

SELECT * FROM IssueCustomFieldOptions WHERE CustomFieldId='customfield_10107' AND context=10307

Alternatively, you can also provide the OptionId.

SELECT * from IssueCustomFieldOptions WHERE OptionId = 10000

Server

To execute a query in Jira Server, you must specify the CustomFieldId if you are not using the OAuth 2.0 AuthScheme.

SELECT * FROM IssueCustomFieldOptions WHERE CustomFieldId='10104'

Alternatively, you can also provide the OptionId.

SELECT * from IssueCustomFieldOptions WHERE OptionId = 10000

Insert

Cloud

To add a new custom field option, you must specify the option Name along with the CustomFieldId and the Context.

INSERT INTO IssueCustomFieldOptions (CustomFieldId, Context, Name ) VALUES ('customfield_10107', '10307', 'NewAddedOption')

Update

Cloud

To update a custom field option, you must specify the OptionId along with the CustomFieldId and Context in the WHERE clause criteria.

UPDATE [IssueCustomFieldOptions] SET Name = 'NewUpdatedOption123', OptionId='10866' WHERE CustomFieldId='customfield_10107' AND Context='10307' AND OptionId='10866'

Delete

Cloud

To delete a custom field option, you must specify the OptionId along with the CustomFieldId and Context in the WHERE clause criteria.

DELETE FROM [IssueCustomFieldOptions] WHERE CustomFieldId='customfield_10107' AND Context='10307' AND OptionId='10866'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
OptionId [KEY]	String	False		=	Common	The ID of the custom field option.
Name	String	False			Common	The Name of the custom field option.
CustomFieldId	String	False	IssueCustomFields.Id	=	Common	The ID of the custom field.
Context	String	False	CustomFieldContext.Id	=	Cloud	The context of the custom field option.
Disabled	Boolean	False			Common	Whether the option is disabled.

Provides full access to Jira issues. Supports creation, updates, deletions, and queries for issue records across all projects.

Table Specific Information

You should set the IncludeCustomFields connection property to 'True' in order to dynamically retrieve the Custom Fields columns and values (like Sprint, Epic, ...) when querying this table.

You can search for Issues by using SQL and JQL (Jira Query Language).

Select

JQL

SELECT * FROM Issues WHERE JQL = ' project = "New project" AND Status WAS "open" '

SQL

SELECT * FROM Issues WHERE ProjectId > 10001 OR Updated <= '2016/03/29 15:00'

The Cloud uses the Jira API to process some of the filters. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SQL and JQL

SELECT * FROM Issues WHERE ProjectName = 'New project' AND JQL = ' status WAS "open" '

Filter time interval fields like TimeSpent, OriginalEstimate and RemainingEstimate by specifying hours, days, weeks, minutes and so on.

SELECT * FROM Issues WHERE RemainingEstimate = '1m 2d' AND TimeSpent = '3m 2w'

Insert

Create a new issue in the Project. Project (specify either ProjectId or ProjectKey), IssueType (specify either IssueTypeId or IssueTypeName), and Summary are required for Inserts. ProjectName may also be specified instead, but it will cost an additional request to the server to find the ProjectKey value that it belongs to. Depending on the Project and the IssueType more fields may be required.

INSERT INTO Issues (ProjectId, Summary, IssueTypeId, CustomField1) VALUES (10000, 'Desc from prod', 10100, 'test')
INSERT INTO Issues (ProjectKey, Summary, IssueTypeName, CustomField1) VALUES ('PROD', 'Desc from prod', 'Task', 'test')

Update

Update info of existing issues by providing the Id

UPDATE Issues SET Summary = 'Desc FROM prod', CustomField1 = 'ValidValue' WHERE Id = '10003'

You can also modify some aggregate fields for a specific issue. You can modify FixVersionsAggregate, AffectedVersionsAggregate, ComponentsAggregate and IssueLinksAggregate. Using the special inputs for these columns, you can assign, remove and update the appropriate field for an issue. Note that the object must first be created in the Jira application to use it with the provider queries. NOTE: The IssuelinksAggregate field has slightly different input requirements, outlined further below.

Structure for adding a fix version:

{ "add": {"name":"example"} }

or

{ "add": {"id":"1234"} }

An example query:

UPDATE Issues SET FixVersionsAggregate = '{"add":{"name":"extra"}}' WHERE Id = 19683

You can only add one object at a time, but using the set command you can assign multiple objects. IMPORTANT NOTE: The set command will overwrite all the previous objects, meaning that previous entries will be discarded, and only the objects specified in the set command will be saved to the issue. The set command must be followed by an array:

{ "set":  [ {"name":"New Component 1"}, {"name":"Old Component 2"} ] }

or 

{ "set":  [ {"id":"1234"}, {"name":"Old Component 2"} ] }

And an example query would be:

UPDATE Issues SET ComponentsAggregate = '{ "set":  [ {"id":"1234"}, {"name":"Old Components 2"} ] }' WHERE Id = 19683

You can also remove an entry one at a time using the remove command:

{ "remove": {"name":"example"} }

or

{ "remove": {"id":"1234"} }

UPDATE Issues SET AffectedVersionsAggregate = '{"remove":{"name":"extra"}}' WHERE id = 19683

These commands are also applicable when inserting a new issue:

INSERT INTO Issues (ProjectId, Summary, IssueTypeId, FixVersionsAggregate) VALUES (10000, 'Desc from prod', 10100, '{"add":{"name":"Example1"}}')

INSERT INTO Issues (ProjectId, Summary, IssueTypeId, FixVersionsAggregate) VALUES (10000, 'Desc from prod', 10100, '{"set":[{"name":"Example1"}]}')

IssueLinksAggregate

Only the 'add' operation is supported with IssueLinksAggregate, and you must specify the type of the link and the direction of the link, either 'outwardIssue' or 'inwardIssue', but not both. The valid link types are Blocks, RootCause, Relates, Duplicate and Cloners

{ "add":
  { "outwardIssue":
      {"key":"COB-15"},
    "type":
      {"name":"Cloners"}
  }
}

or

{ "add":
  { "inwardIssue":
    {"key":"FIL-78"},
    "type":
    {"name":"Blocks"}
  }
}

INSERT INTO Issues (ProjectId, Summary, IssueTypeId, FixVersionsAggregate) VALUES (10000, 'Desc from prod', 10100, '{"add":{"outwardIssue":{"key":"COB-15"},"type":{"name":"Cloners"}}}')

"UPDATE Issues SET IssuelinksAggregate = '{"add":{"inwardIssue":{"key":"FIL-1"},"type":{"name":"Blocks"}}}' WHERE Id = '22204'"

Delete

Delete an issue by providing the Id. Note that subtasks that have not been completed will be deleted as well.

DELETE FROM Issues WHERE Id = '10003'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
Id [KEY]	Int	True		=,!=,>,>=,<,<=,IN,NOT IN	Common	The unique numeric identifier assigned to the issue by Jira.
Key	String	True		=,!=,>,>=,<,<=,IN,NOT IN	Common	The unique key used to reference the issue, typically in the format 'PROJ-123'.
IssueTypeId	String	False		=,!=,IS,IS NOT,IN,NOT IN	Common	The internal identifier of the issue type, such as 'Bug', 'Task', or 'Story'.
IssueTypeName	String	True		=,!=,IS,IS NOT,IN,NOT IN	Common	The human-readable name of the issue type, such as 'Bug' or 'Task'.
ProjectId	Integer	False		=,!=,IS,IS NOT,IN,NOT IN	Common	The unique identifier of the project that contains the issue.
ProjectName	String	True		=,!=,IS,IS NOT,IN,NOT IN	Common	The name of the project that the issue belongs to.
ProjectKey	String	False		=,!=,IS,IS NOT,IN,NOT IN	Common	The unique key of the project, often used as the prefix in issue keys (for example, 'PROJ').
ParentId	Int	False		=,!=,IN,NOT IN	Common	The ID of the parent issue, used when the issue is a subtask.
ParentKey	String	True		=,!=,IN,NOT IN	Common	The key of the parent issue, used when the issue is a subtask.
ParentIssueTypeId	String	True			Common	The issue type ID of the parent issue, providing insight into the parent issue's classification.
ParentIssueTypeName	String	True			Common	The issue type name of the parent issue, such as 'Story' or 'Task'.
ParentStatusId	String	True			Common	The status ID of the parent issue, indicating the workflow status.
ParentStatusName	String	True			Common	The status name of the parent issue, such as 'In Progress' or 'Done'.
ResolutionId	String	True		=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The resolution ID of the issue, representing how the issue was resolved.
ResolutionName	String	True		=,!=,IS,IS NOT,IN,NOT IN	Common	The human-readable name of the issue's resolution, such as 'Fixed' or 'Duplicate'.
ResolutionDescription	String	True			Common	A detailed explanation of the resolution applied to the issue.
ResolutionDate	Datetime	True		=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The date and time the issue was marked as resolved.
Workratio	Long	True		=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	A percentage value comparing the amount of time spent versus the estimated effort.
LastViewed	Datetime	True		=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The date and time the issue was last viewed by the current user.
WatchCount	Int	True		=,!=,>,>=,<,<=,IN,NOT IN	Common	The number of users who are watching the issue for updates.
IsWatching	Bool	True			Common	If the current authenticated user is watching this issue, the value is 'true'; otherwise 'false'.
Created	Datetime	True		=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The timestamp when the issue was initially created in Jira.
PriorityId	String	False		=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The ID representing the priority level assigned to the issue.
PriorityName	String	True		=,!=,IS,IS NOT,IN,NOT IN	Common	The name of the priority level, such as 'High', 'Medium', or 'Low'.
TimeSpentSeconds	Long	True			Common	The total time spent working on the issue, measured in seconds.
TimeSpent	String	True		=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The total time spent on the issue, formatted as a human-readable string (for example, '2h 30m').
RemainingEstimateSeconds	Long	True			Common	The remaining estimated effort required to complete the issue, in seconds.
RemainingEstimate	String	False		=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The remaining time estimate formatted as a string (for example, '1d 2h').
OriginalEstimateSeconds	Long	True			Common	The original estimated time required to complete the issue, in seconds.
OriginalEstimate	String	False		=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The original time estimate displayed as a formatted string (for example, '3d').
AggregateTimeSpent	Long	True			Common	The total time spent across the issue and its subtasks, in seconds.
AggregateTimeOriginalEstimate	Long	True			Common	The total of the original time estimates for the issue and all its subtasks.
AggregateTimeEstimate	Long	True			Common	The current total remaining estimate for the issue and all of its subtasks.
AssigneeDisplayName	String	True			Common	The full display name of the user assigned to the issue.
AssigneeKey	String	True		=,!=,IS,IS NOT,IN,NOT IN	Common	[DEPRECATED] The key identifier of the assignee. Use AssigneeAccountId instead.
AssigneeAccountId	String	False		=,!=,IS,IS NOT,IN,NOT IN	Common	The Atlassian account ID of the user assigned to the issue.
AssigneeName	String	False		=,!=,IS,IS NOT,IN,NOT IN	Common	The username of the assignee, used in older Jira instances.
AssigneeEmail	String	True		=,!=,IS,IS NOT,IN,NOT IN	Common	The email address of the user assigned to the issue.
Updated	Datetime	True		=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The timestamp of the last update made to the issue.
StatusId	String	True		=,!=,IS,IS NOT,IN,NOT IN	Common	The internal identifier of the issue's current workflow status.
StatusName	String	True		=,!=,IS,IS NOT,IN,NOT IN	Common	The name of the issue's status, such as 'To Do', 'In Progress', or 'Done'.
StatusCategoryId	Integer	True		=,!=,IS,IS NOT,IN,NOT IN	Common	The category ID associated with the issue status, used to group similar workflow statuses.
StatusCategoryKey	String	True		=,!=,IS,IS NOT,IN,NOT IN	Common	The key used to identify the status category, such as 'new', 'indeterminate', or 'done'.
StatusCategoryName	String	True		=,!=,IS,IS NOT,IN,NOT IN	Common	The display name of the status category, used to group workflow states.
Description	String	False		IS,IS NOT	Common	A detailed explanation of the issue's problem, task, or request.
Summary	String	False		IS,IS NOT	Common	A brief summary or title that provides an overview of the issue.
CreatorDisplayName	String	True			Common	The full display name of the user who created the issue.
CreatorName	String	True		=,!=,IS,IS NOT,IN,NOT IN	Common	The username of the issue creator, typically used in legacy Jira systems.
CreatorAccountId	String	True		=,!=,IS,IS NOT,IN,NOT IN	Common	The Atlassian account ID of the user who created the issue.
CreatorKey	String	True		=,!=,IS,IS NOT,IN,NOT IN	Common	[DEPRECATED] The key identifier for the issue creator. Use CreatorAccountId instead.
CreatorEmail	String	True		=,!=,IS,IS NOT,IN,NOT IN	Common	The email address of the user who created the issue.
ReporterDisplayName	String	True			Common	The full display name of the user who reported the issue.
ReporterName	String	False		=,!=,IS,IS NOT,IN,NOT IN	Common	The username of the reporter, used in legacy Jira systems.
ReporterKey	String	True		=,!=,IS,IS NOT,IN,NOT IN	Common	[DEPRECATED] The key identifier for the reporter. Use ReporterAccountId instead.
ReporterAccountId	String	False		=,!=,IS,IS NOT,IN,NOT IN	Common	The Atlassian account ID of the user who reported the issue.
ReporterEmail	String	True		=,!=,IS,IS NOT,IN,NOT IN	Common	The email address of the user who reported the issue.
AggregateProgress	Long	True			Common	The total progress made on the issue, including progress on all subtasks, measured in seconds.
TotalProgress	Long	True			Common	The total estimated time for the issue and all its subtasks.
Votes	Int	True		=,!=,>,>=,<,<=,IN,NOT IN	Common	The number of users who have voted for this issue as being important or needing attention.
HasVotes	Bool	True			Common	Indicates whether the issue has any user votes. Returns 'true' if votes exist, otherwise 'false'.
DueDate	Date	False		=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The due date by which the issue is expected to be completed.
Labels	String	False		=,!=,IS,IS NOT,IN,NOT IN	Common	A comma-separated list of labels applied to the issue for categorization or filtering.
Environment	String	False		LIKE,NOT LIKE,IS,IS NOT	Common	Describes the technical or physical environment relevant to the issue (such as OS, browser, or hardware).
SecurityLevel	String	False		=,!=,IS,IS NOT,IN, NOT IN	Common	The security level applied to the issue, restricting visibility to a defined user group.
FixVersionsAggregate	String	False			Common	A comma-separated list of versions in which the issue is or will be resolved.
ComponentsAggregate	String	False			Common	A list of project components that this issue is associated with.
IssueLinksAggregate	String	False			Common	A list of links to other issues that relate to or are dependent on this issue.
AffectedVersionsAggregate	String	False			Common	A list of versions affected by this issue.
SubtasksAggregate	String	True			Common	A collection of subtasks associated with the issue.
CustomField1	Any	False			Common	A user-defined custom field for the issue. Custom fields appear when 'IncludeCustomFields' is enabled.
CustomField2	Any	False			Common	Another user-defined custom field available when 'IncludeCustomFields' is set to 'true'.
ItemURL	String	True			Common	A browsable URL linking directly to the issue in the Jira web interface.

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.

Name	Type	Description
JQL	String	Used to filter and search issues using Jira Query Language (JQL).
Attachments	String	Used to query issues that have attachments. Can be filtered using IS EMPTY or IS NOT EMPTY.
Comment	String	Filters issues that contain a comment with specified text content.
Category	String	Allows filtering of issues based on the category of the associated project.
SprintId	Integer	Filters issues by the numeric ID of the sprint they belong to.
SprintName	String	Filters issues by the name of the sprint they are part of.
Filter	String	Queries issues using the name or ID of a saved filter.

Query the available Issue Types in Jira.

Select

The Cloud uses the Jira API to process some of the filters.

The Cloud processes other filters within the Cloud.

SELECT * FROM IssueTypes WHERE Id = 3

Insert

Name is required to insert. The following query creates a new issue type:

INSERT INTO IssueTypes (Name, Description, Subtask) VALUES ('Issue type name 3', 'test description', false)

Update

You can update by specifying the issue type Id:

UPDATE IssueTypes SET Name = 'Updated Name 3', Description = 'Updated description' WHERE Id = 10306

Delete

Delete an issue type by specifying the issue type Id:

DELETE FROM IssueTypes WHERE Id = 10306

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
Id [KEY]	String	True		=	Common	The Id of the issue type.
Name	String	False			Common	The name of the issue type.
Description	String	False			Common	The description of the issue type.
Subtask	Boolean	False			Common	The subtask of the issue type. Not applicable for update.
HierarchyLevel	Int	False			Cloud	Hierarchy level of the issue type.
IconUrl	String	True			Common	The icon URL of the issue type.
EntityId	String	True			Cloud	Unique ID for next-gen projects.
Self	String	True			Common	The URL of these issue type details.
Scope	String	True			Cloud	Details of the next-gen projects the issue type is available in.
AvatarId	Int	True			Common	The ID of the issue type's avatar.

Manages components within Jira projects. Supports creating, updating, deleting, and querying project components.

Table Specific Information

Select

The Cloud uses the Jira API to process some of the filters. The Cloud processes other filters within the Cloud.

For example, the following queries are processed server side:

Retrieve the components of each project

SELECT * FROM ProjectComponents

You can also filter the components by their Id or the Project they are part of:

SELECT * FROM ProjectComponents WHERE Id = 10022 

Using ProjectId:

SELECT * FROM ProjectComponents WHERE ProjectId = 10027 

Using ProjectKey:

SELECT * FROM ProjectComponents WHERE ProjectKey = 'QMTH' 

Insert

Create a new Component for the project. The ProjectKey and Name columns are required.

INSERT INTO ProjectComponents (ProjectKey, Name, AssigneeType) VALUES ('COB', 'Testing Component', 'PROJECT_LEAD')

Update

Make changes to a project component, specifying the Id column of the component to modify.

UPDATE ProjectComponents SET LeadKey = 'newlead' WHERE Id = 10065

Delete

Remove a component of the project by specifying the Id.

DELETE FROM ProjectComponents WHERE Id = 10065

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
Id [KEY]	Integer	True		=	Common	A unique identifier for the project component, used to reference it in Jira.
ProjectId	Integer	True	Projects.Id	=,IN	Common	The internal ID of the project to which the component belongs.
ProjectKey	String	False		=,IN	Common	The unique key of the project associated with the component, typically used in issue keys.
Name	String	False			Common	The name assigned to the project component, used to categorize and organize issues.
Description	String	False			Common	A detailed explanation of the component's purpose or scope within the project.
LeadDisplayName	String	True			Common	The display name of the user designated as the lead for this component, often responsible for overseeing related work.
LeadKey	String	False			Common	The unique key identifying the user who is the lead of this component.
AssigneeType	String	False			Common	Indicates the default assignee type for issues filed under this component, such as 'Project Lead' or 'Component Lead'. The allowed values are PROJECT_DEFAULT, COMPONENT_LEAD, PROJECT_LEAD, UNASSIGNED.
AssigneeDisplayName	String	True			Common	The display name of the user who will be assigned issues by default for this component.
AssigneeKey	String	True			Common	The user key of the default assignee for issues in this component.
IsAssigneeTypeValid	Boolean	True			Common	If the value is 'true', the specified assignee type is valid in the context of the project; if 'false', it is not a valid selection.

Manages role assignments within projects. Retrieves and updates users and groups assigned to project roles.

Select

The Cloud will use the Jira API to process filters that refer to ProjectId, ProjectKey and RoleId while the rest of the filter is executed client side within the Cloud. The Jira APIs support filters using the equals (=) and IN operator with ProjectId, ProjectKey and RoleId. Note that either ProjectId, ProjectKey or RoleId must be specified with a comparison type of equals (=) for SELECT SQL statement.

For example, the following queries are processed server side:

Retrieve all actors for a specific project:

SELECT * FROM ProjectRoleActors WHERE ProjectId = '10650'

SELECT * FROM ProjectRoleActors WHERE ProjectKey = 'MYP'

Retrieve all actors for a specific role in all projects:

SELECT * FROM ProjectRoleActors WHERE RoleId = '10329'

Retrieve all actors for a specific project:

SELECT * FROM ProjectRoleActors WHERE RoleId = '10329' AND ProjectId = '10650'

Retrieve all actors for specific projects:

SELECT * FROM ProjectRoleActors WHERE RoleId = '10329' AND ProjectId IN ('10650', '10651', '10652')

Retrieve all actors for specific roles in a project:

SELECT * FROM ProjectRoleActors WHERE RoleId IN ('10329', '10330', '10331') AND ProjectId = '10650'

Insert

Cloud

Add a user as an actor to a role in a specific project by specifying the user's account Id.

INSERT INTO ProjectRoleActors (ProjectId, RoleId, ActorUserAccountId) VALUES ('10650', '10329', '63acbf336f068efec8f6e0c3')

Add a group as an actor to a role in a specific project by either specifying the group's Id or name.

INSERT INTO ProjectRoleActors (ProjectId, RoleId, ActorGroupGroupId) VALUES ('10650', '10329', '0eed15e3-80cc-41d0-ba1a-b408658caf4d')

INSERT INTO ProjectRoleActors (ProjectId, RoleId, ActorGroupName) VALUES ('10650', '10329', 'JohnTest1')

Server

Add a user as an actor to a role by specifying the project, role and user's name.

INSERT INTO ProjectRoleActors (ProjectId, RoleId, UserName) VALUES ('10000', '10101', 'myuser')

Add a group as an actor to a role by specifying the project, role and group's name.

INSERT INTO ProjectRoleActors (ProjectId, RoleId, GroupName) VALUES ('10000', '10101', 'test-group')

Delete

Cloud

Delete an actor from a role by specifying the project, role and the user's account Id, the group's name or the group's Id.

DELETE FROM ProjectRoleActors WHERE ProjectId = '10650' AND RoleId = '10329' AND ActorUserAccountId = '63acbf336f068efec8f6e0c3'

DELETE FROM ProjectRoleActors WHERE ActorGroupGroupId = '0eed15e3-80cc-41d0-ba1a-b408658caf4d' AND ProjectId = '10650' AND RoleId = '10330'

DELETE FROM ProjectRoleActors WHERE ActorGroupName = 'JohnTest1' AND ProjectId = '10650' AND RoleId = '10330'

Server

Delete a default actor from a role by specifying the user's name or the group's name.

DELETE FROM ProjectRoleActors WHERE ProjectId = '10000' AND RoleId = '10101' AND UserName = 'myuser'

DELETE FROM ProjectRoleActors WHERE ProjectId = '10000' AND RoleId = '10101' AND GroupName = 'test-group'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
Id [KEY]	Long	False			Common	A unique identifier for the role actor, which represents either a user or a group assigned to a project role.
DisplayName	String	False			Common	The display name of the role actor. For users, this can reflect privacy settings and return a masked or alternative value instead of the actual name.
Type	String	False			Common	The type of role actor, such as 'atlassian-user-role-actor' for users or 'atlassian-group-role-actor' for groups.
Name	String	False			Server	The name of the project role that this actor is associated with.
AvatarUrl	String	False			Common	The URL to the avatar image representing the role actor (user or group).
ActorUserAccountId	String	False			Cloud	The unique account ID of the user acting in the role, consistent across all Atlassian products.
ActorGroupName	String	False			Cloud	The name of the group acting in the role. As group names can change, groupId is recommended for reliable identification.
ActorGroupDisplayName	String	False			Cloud	The human-readable display name of the group acting in the role.
ActorGroupGroupId	String	False			Cloud	The ID of the group associated with the project role.
RoleId	Long	False	Roles.Id	=,IN	Common	The ID of the project role that the actor is assigned to.
ProjectId	Integer	False	Projects.Id	=,IN	Common	The numeric ID of the project in which the role actor is defined.
ProjectKey	String	False	Projects.Key	=,IN	Common	The unique key of the project associated with the project role.

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.

Name	Type	Description
UserName	String	Used in Server platform only for Insert/Delete operations. Specifies the username of the user to be added or removed from the project role.
GroupName	String	Used in Server platform only for Insert/Delete operations. Specifies the name of the group to be added or removed from the project role.

Provides access to all Jira projects. Supports querying, creating, updating, and deleting project records.

Select

When connecting to Jira Cloud (rather than Jira Data Center) instances, the Cloud uses the Jira API to process WHERE clause conditions built with the following columns and operators.

• Id supports the '=' and 'IN' operators.
• Key supports the '=', 'LIKE' and 'IN' operators.
• Name supports the 'LIKE' operator.
• ProjectTypeKey supports the '=' operator.
• ProjectCategoryId supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Projects WHERE Id = 10000

Additionally, the Jira API handles ORDER BY (ASC/DESC) clauses for the Key, Name, LeadDisplayName, and ProductCategoryName columns in Jira Cloud instances. For example:

SELECT * FROM Projects ORDER BY Name ASC

The Cloud processes other filters client-side.

INSERT

Key, Name, LeadName and ProjectTypeKey are required to insert. The following query creates a new project:

INSERT INTO Projects (Key, Name, LeadName, ProjectTypeKey, Description) VALUES ('EXE4', 'Inserted Project 4', 'admin', 'business', 'New business project.')

Update

You can update by specifying either Id or Key:

UPDATE Projects SET Description = 'Updated description', AssigneeType = 'UNASSIGNED', LeadName = 'admin2' WHERE Key = 'EXE4'

Delete

Delete a project by specifying either Id or Key:

DELETE FROM Projects WHERE Key = 'EXE4'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
Id [KEY]	Int	True		=	Common	A unique numeric identifier assigned to the project within the Jira instance. This ID is used internally and in API requests to reference the project.
Key	String	False		=	Common	The short, unique project key used as a prefix for issue identifiers (such as 'PROJ-123'). It is typically assigned when the project is created and used in search queries and issue references.
Name	String	False			Common	The full display name of the project as seen in the Jira UI. This is the main title used to identify the project in dashboards, boards, and menus.
Description	String	False			Common	A free-text description that provides an overview of the project's purpose, goals, stakeholders, or context. Often used to help team members and collaborators understand the scope of the project.
LeadEmailAddress	String	True	Users.EmailAddress		Common	The email address of the user assigned as the project lead. The project lead is typically responsible for managing the project and receives notifications by default.
LeadDisplayName	String	True	Users.DisplayName		Common	The display name (as shown in the Jira UI) of the user designated as the lead for the project.
ComponentsAggregate	String	True			Common	A comma-separated list of all components configured in the project. Components are used to categorize issues within a project and can represent subsystems, teams, or functional areas.
IssueTypesAggregate	String	True			Common	A comma-separated list of the issue types available in the project, such as 'Bug', 'Task', 'Story', 'Epic', or custom issue types. Each issue type defines a distinct kind of work item.
Url	String	True			Common	A user-defined web URL that can be associated with the project for external references, documentation, or integration. This field is optional.
Email	String	True			Common	The email address associated with the project, typically used for contact or notification purposes. This value can be customized per project.
AssigneeType	String	False			Common	Indicates the default assignment strategy for new issues created in the project. Common values include 'UNASSIGNED' or 'PROJECT_LEAD'.
VersionsAggregate	String	True			Common	A comma-separated list of version names configured in the project. Versions can be used for release planning and tracking progress toward a release milestone.
RolesAggregate	String	True			Common	A comma-separated list of roles defined in the project, such as 'Administrator', 'Developer', or 'Viewer'. Each role controls the permissions and responsibilities of users in the project.
ProjectKeysAggregate	String	True			Common	A list of all project keys historically associated with this project. This includes previous keys if the project key has ever been changed.
ProjectCategoryId	String	False			Common	The identifier of the project category to which this project belongs. Categories group projects into logical sets for filtering and reporting.
ProjectCategoryName	String	True			Common	The name of the category assigned to this project. This is used to organize and display projects by type or purpose in the Jira interface.
ProjectCategoryDescription	String	True			Common	A free-text description of the project category, used to provide additional context or clarification for users browsing categorized projects.
ProjectTypeKey	String	False			Common	The key representing the type of project. Common values include 'software', 'service_desk', or 'business', which determine the features and interface available.
LeadAccountId	String	False	Users.AccountId		Cloud	The unique Atlassian account ID of the project lead. This identifier is consistent across all Atlassian Cloud products and replaces deprecated user keys.
LeadAccountKey	String	True	Users.Key		Server	[DEPRECATED] A legacy identifier used to represent the project lead, typically replaced by LeadAccountId in modern Jira Cloud instances.
LeadAccountName	String	False	Users.Name		Server	[DEPRECATED] The legacy username of the project lead, used in older Jira Server installations. Replaced by account ID in Jira Cloud.
Simplified	Boolean	True			Cloud	A boolean value that indicates whether the project is team-managed (formerly called next-gen) or company-managed. Team-managed projects allow simplified configuration by project admins.
ItemURL	String	True			Common	A direct URL to the project in the Jira web interface, allowing users to quickly navigate to the project's main overview page.

Provides access to project version management. Supports querying, creating, updating, and deleting versions.

Table Specific Information

Select

The Cloud uses the Jira API to process some of the filters. The Cloud processes other filters within the Cloud. For example, the following queries are processed server side:

Retrieve the versions for all projects:

SELECT * FROM ProjectVersions 

You can also filter by the Id, ProjectKey, or ProjectId. For example:

SELECT * FROM ProjectVersions WHERE Id = 10022 

Using ProjectId:

SELECT * FROM ProjectVersions WHERE ProjectId = 10022 

Using ProjectKey:

SELECT * FROM ProjectVersions WHERE ProjectKey = 'QMTH' 

Insert

Create a new version to be used throughout the project. The Name and either ProjectId or ProjectKey columns are required.

INSERT INTO ProjectVersions (ProjectId, Name, Description, ReleaseDate, StartDate) VALUES ('10000', 'HR Component', 'Example version description', '2018-04-04', '2018-02-02')

Update

Make changes to a project version, specifying the Id column of the version to modify.

UPDATE ProjectVersions SET Released = 'true' WHERE Id = 10065

Delete

Remove a version of the project by specifying the Id column.

DELETE FROM ProjectVersions WHERE Id = 10065

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
Id [KEY]	Integer	True		=	Common	The unique identifier for the version within the project.
ProjectId	Integer	False	Projects.Id	=,IN	Common	The unique identifier of the project to which this version belongs.
ProjectKey	String	False		=,IN	Common	The key of the project associated with this version, used to reference the project in queries and URLs.
Name	String	False			Common	The name assigned to the version, often representing a milestone or release number such as '1.0.0' or 'Q4 2024'.
Description	String	False			Common	A textual description providing context or notes about what the version includes or represents.
Released	Boolean	False			Common	Indicates whether the version has been officially released. If the value is 'true', the version is considered complete and available.
ReleaseDate	Date	False			Common	The official release date of the version, typically used for scheduling and reporting purposes.
StartDate	Date	False			Common	The planned start date for work associated with this version. Optional and used mainly for roadmap planning.
UserStartDate	Date	False			Common	The user-defined date indicating when the work on this version is expected to begin. Used for manual planning.
UserReleaseDate	Date	False			Common	The user-defined date indicating when the work on this version is expected to end. Helps track expectations versus actuals.
Overdue	Boolean	True			Common	Indicates whether the version's release date has passed without being marked as released.
Archived	Boolean	False			Common	Indicates whether the version is archived. Archived versions are no longer active and are typically hidden from default views.

Manages default role actors, who are automatically assigned to roles when new projects are created.

Select

The Cloud will use the Jira API to process filters that refer to RoleId while the rest of the filter is executed client side within the Cloud. The Jira APIs support filters using the equals (=) and IN operator with RoleId.

For example, the following queries are processed server side:

Retrieve all the default actors for all roles:

SELECT * FROM RoleActors

Retrieve all the default actors for a specific role:

SELECT * FROM RoleActors WHERE RoleId = '10002'

Insert

Cloud

Add a user as a default actor to a role by specifying the user's account Id.

INSERT INTO RoleActors (ActorUserAccountId, RoleId) VALUES ('63acbf336f068efec8f6e0c3', '10326')

Add a group as a default actor to a role by either specifying the group's Id or name.

INSERT INTO RoleActors (ActorGroupGroupId, RoleId) VALUES ('ad8da7e1-7b66-408e-a61c-c4c8383ca5d1', '10326')

INSERT INTO RoleActors (ActorGroupName, RoleId) VALUES ('testGroupName', '10326')

Server

Add a user as a default actor to a role by specifying the user's key.

INSERT INTO RoleActors (RoleId, UserKey) VALUES ('10102', 'JIRAUSER10001')

Add a group as a default actor to a role by specifying the group's name.

INSERT INTO RoleActors (RoleId, GroupName) VALUES ('10102', 'test-group')

Delete

Cloud

Delete a default actor from a role by specifying the RoleId and the user's account Id, the group's name or the group's Id.

DELETE FROM RoleActors WHERE RoleId = '10326' AND ActorUserAccountId = '63acbf336f068efec8f6e0c3' 

DELETE FROM RoleActors WHERE RoleId = '10325' AND ActorGroupName = 'Developers' 

DELETE FROM RoleActors WHERE RoleId = '10325' AND ActorGroupGroupId = '6dd7f7e1-77f0-4cd1-b8e1-a069830a8f1d' 

Server

Delete a default actor from a role by specifying the user's key or the group's name.

DELETE FROM RoleActors WHERE RoleId = '10102' AND UserKey = 'JIRAUSER10001'

DELETE FROM RoleActors WHERE RoleId = '10102' AND GroupName = 'test-group'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
Id [KEY]	Long	False			Common	The unique identifier assigned to the role actor, used to distinguish users or groups associated with a Jira project role.
DisplayName	String	False			Common	The display name of the user or group associated with the project role. This can differ based on the user's privacy settings.
Type	String	False			Common	The type of role actor, such as 'atlassian-user-role-actor' for users or 'atlassian-group-role-actor' for groups.
AvatarUrl	String	False			Common	The URL to the avatar image representing the user or group in the UI.
ActorUserAccountId	String	False	Users.AccountId		Cloud	The Atlassian account ID of the user associated with the project role. This ID uniquely identifies the user across all Atlassian products.
ActorGroupName	String	False	Groups.Name		Cloud	The name of the group associated with the project role. Since group names can change, group IDs are recommended for stable identification.
ActorGroupDisplayName	String	False			Cloud	The human-readable display name of the group that acts in the role.
ActorGroupGroupId	String	False	Groups.Id		Cloud	The stable ID of the group associated with the project role.
Name	String	False			Server	The name of the Jira role that this actor is assigned to, such as 'Developers' or 'Administrators'.
RoleId	Long	False	Roles.Id	=,IN	Common	The unique identifier for the Jira role that the actor is assigned to.

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.

Name	Type	Description
UserKey	String	Used only on Jira Server. The key of the user to be inserted or removed from the project role.
GroupName	String	Used only on Jira Server. The name of the group to be inserted or removed from the project role.

Lists all roles configured in Jira, such as 'Service Desk Team' or 'Project Manager'.

Select

The Cloud will use the Jira API to process filters that refer to Id while the rest of the filter is executed client side within the Cloud. The Jira APIs support filters using the equals (=) operator with Id.

For example, the following queries are processed server side:

Retrieve all the available Roles:

SELECT * FROM Roles

Retrieve a specific Role:

SELECT * FROM Roles WHERE Id = '10002'

Update

Update the role name and description by specifying the role Id

UPDATE Roles SET Description = 'test_updated', Name = 'test_updated' WHERE Id = 10002

Delete

Delete a role by specifying the Id.

DELETE FROM Roles WHERE Id = '10002'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
Id [KEY]	Long	False		=	Common	The unique identifier of the role within the Jira instance.
Name	String	False			Common	The name of the project role, such as 'Developers', 'Administrators', or 'Users'.
Description	String	False			Common	A textual explanation of the purpose or responsibilities associated with the role.
Actors	String	False			Common	A list of users and groups assigned to this role, either by default or per project.
Scope	String	False			Cloud	Defines the scope at which the role is applicable, such as global or project-specific.
IsAdmin	Boolean	False			Cloud	If the value is 'true', this role is designated as the administrator role for the associated project. If the value is 'false', it is not an admin role.
IsDefault	Boolean	False			Cloud	If the value is 'true', this role is automatically assigned to users by default for new projects. If the value is 'false', it is not a default role.

Manages Jira sprints. Supports creating, modifying, deleting, and querying sprint data from agile boards.

Table Specific Information

Select

To retrieve a list of Sprints in your Jira account, you can query the BoardSprints view.

The Cloud uses the Jira API to process some of the filters. The Cloud will process the rest of the filter client side within itself. For example, the following query is processed server-side:

SELECT * FROM Sprints WHERE Id = 122 
SELECT * FROM Sprints WHERE Id IN ('1', '2', '3')

INSERT

Create a new sprint and link it to a board. The OriginBoardId and the Name columns are required for inserting a new sprint.

INSERT INTO Sprints (OriginBoardId, Name, Goal, StartDate, EndDate) VALUES ('1', 'Inserted Sprint', 'Complete target', '2018-02-02', '2018-04-04')

Update

Make changes to a sprint by specifying the sprint's Id.

UPDATE Sprints SET State = 'active' WHERE Id = 305

Delete

Remove a sprint by specifying the Id.

DELETE FROM Sprints WHERE Id = 305

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
Id [KEY]	Integer	True		=,IN	Common	A unique numeric identifier assigned to the sprint. Used internally to reference the sprint in Jira and API calls.
Name	String	False			Common	The name given to the sprint, typically reflecting its time frame or theme. Helps teams identify and organize sprints easily.
State	String	False		=	Common	The current state of the sprint. Valid states include 'future' (not started), 'active' (in progress), and 'closed' (completed). States transition in this strict order. The allowed values are future, active, closed.
Goal	String	False			Common	A short statement describing the objective of the sprint. Helps align the team on what the sprint is intended to achieve.
OriginBoardId	Integer	False	Boards.Id		Common	The ID of the agile board from which the sprint was created. This value is set at creation and cannot be changed.
StartDate	Datetime	False			Common	The date and time when the sprint was officially started. Typically marks the beginning of the development cycle.
EndDate	Datetime	False			Common	The planned date and time when the sprint is expected to end. This can be used to calculate sprint duration and track timelines.
CompleteDate	Datetime	True			Common	The actual date and time when the sprint was marked as completed in Jira. Useful for reporting and retrospective analysis.

Provides access to Jira users. Supports querying user details including account ID, email, and group memberships.

Select

The Cloud executes filters other than the following client-side within the Cloud. The Jira APIs have limited support for filtering the Name, DisplayName, and EmailAddress columns with the LIKE operator.

Specify Name, DisplayName, and EmailAddress one at a time.

The Jira supports filters based on these columns combined with the Active or IncludeInactive columns. For example the following queries are processed server side:

SELECT * FROM Users WHERE Name LIKE '%John%' AND Active = false AND IncludeInactive = true

Query the Users belonging to a specific group by specifying either the GroupName or the GroupId:

SELECT * FROM Users WHERE GroupName = 'Testing team'
SELECT * FROM Users WHERE GroupId = '3dd7e7a1-77f7-4ac1-b8e1-a069830a7f1d'

You can also retrieve a list of all groups and their members:

SELECT * FROM Users WHERE GroupName IN (SELECT Name FROM Groups)

Use the IssueKey and ProjectKey pseudo-columns to find users who can browse a specific issue or any issue in a project.

SELECT * FROM Users WHERE IssueKey = 'PRJ-1'
SELECT * FROM Users WHERE ProjectKey = 'PRJ'

Insert

The input to INSERT must be an email address:

INSERT INTO Users(EmailAddress) VALUES ('[email protected]')

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
GroupName	String	True		=,IN	Common	The name of the Jira group that the user belongs to. Groups are used to manage permissions and roles collectively.
EmailAddress	String	False		=	Common	The primary email address associated with the user's Jira account. This is often used for notifications and communication.
Active	Bool	True			Common	If the value is 'true', the user account is currently active and able to log in. If the value is 'false', the account is deactivated and cannot access Jira.
TimeZone	String	True			Common	The time zone preference set in the user's profile. This affects how times and dates are displayed in the interface for that user.
Locale	String	True			Common	The locale setting for the user, which defines the language and regional formatting used in the UI, such as number or date formats.
AccountId [KEY]	String	True			Cloud	The globally unique identifier for the user across all Atlassian cloud products. This replaces legacy fields like 'key' and 'name' in cloud environments.
AccountType	String	False			Cloud	Indicates the type of user account, such as 'atlassian' for managed users or 'app' for automated or bot accounts.
Products	String	False				A comma-separated list of Jira products the user has access to, such as 'jira-core', 'jira-servicedesk', 'jira-product-discovery', or 'jira-software'. This helps determine license usage and available features.
Key [KEY]	String	True			Server	The legacy Jira user key. While deprecated in cloud environments, it is still used in server and data center editions for user identification.
Name	String	False			Server	The legacy Jira username. This is primarily used in server environments and has been replaced by 'AccountId' in cloud.

Query, insert and delete the available issue Watchers in Jira.

Select

The Cloud will use the Jira APIs to process filters based on IssueId or IssueKey. One of these is required to retrieve results. IssueId and IssueKey can be used only with the equal (=) operator.

The Cloud will execute other filters client-side within itself.

For example, the following query is processed server side:

SELECT * FROM Watchers WHERE IssueId = '10100'
SELECT * FROM Watchers WHERE IssueKey = 'PRJ-1'

Insert

Adds a new watcher to an existing issue.

Cloud

To add a new watcher to a specific issue, you must specify the AccountId of the user and either the IssueId or IssueKey of the issue.

INSERT INTO Watchers (IssueId, AccountId) values(19393, '63acbf336f068efec8f6e0c3')
INSERT INTO Watchers (IssueKey, AccountId) values('CD-352', '63acbf336f068efec8f6e0c3')

Sever

To add a new watcher to a specific issue, you must specify the Name of the user and either the IssueId or IssueKey of the issue.

INSERT INTO Watchers (IssueId, Name) values(19393, 'CDataUser')
INSERT INTO Watchers (IssueKey, Name) values('CD-352', 'CDataUser')

Delete

Removes a watcher from an existing issue.

Cloud

To remove a watcher from a specific issue, you must specify the AccountId of the user and either the IssueId or IssueKey of the issue.

DELETE Watchers WHERE IssueId=19393 AND AccountId='63acbf336f068efec8f6e0c3'
DELETE Watchers WHERE IssueKey='CD-352' AND AccountId='63acbf336f068efec8f6e0c3'

Sever

To remove a watcher from a specific issue, you must specify the Name of the user and either the IssueId or IssueKey of the issue.

DELETE Watchers WHERE IssueId=19393 AND Name='CDataUser'
DELETE Watchers WHERE IssueKey='CD-352' AND Name='CDataUser'

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
DisplayName	String	True			Common	The displayed name of the watcher.
EmailAddress	String	True			Common	The email address of the watcher.
AccountId [KEY]	String	False	Users.AccountId		Cloud	The accountId of the watcher.
Key [KEY]	String	True			Server	The account key of the watcher.
Name	String	False			Server	The name of the watcher.
IssueId [KEY]	String	False		=,EMP_EQ	Common	The issue Id of the watcher.
IssueKey	String	False		=,EMP_EQ	Common	The issue key of the watcher.

Manages the available workflows in Jira, which define the sequence of statuses and transitions for issues.

Select

Most filters are processed client side, though there are a few exceptions to this:

• The Cloud uses the Jira APIs to process filters on the Name that use the equals (=) and IN operators only.
• The Cloud processes WHERE filters for the IsActive and Query columns with only the equals (=) operator server-side.

For example, the following queries are executed server side:

SELECT * FROM Workflows WHERE Name = 'abc'

SELECT * FROM Workflows WHERE Name IN ('abc','def','ghi')

SELECT * FROM Workflows WHERE IsActive = true AND Query = 'flow'

The Scope, Statuses, and Workflows columns accept aggregate values and are only used for inserting to and updating Workflows.

INSERT INTO Workflows(Scope, Statuses, Workflows) VALUES ('{"type":"GLOBAL"}', '[{"description":"","name":"To Do #2","statusCategory":"TODO","statusReference":"f0b24de5-25e7-4fab-ab94-63d81db6c0c0"}]', '[{"description":"","name":"Software workflow 1","startPointLayout":{"x":-100.00030899047852,"y":-153.00020599365235},"statuses":[{"layout":{"x":114.99993896484375,"y":-16},"properties":{},"statusReference":"f0b24de5-25e7-4fab-ab94-63d81db6c0c0"}],"transitions":[{"actions":[],"description":"","from":[],"id":"1","name":"Create","properties":{},"to":{"statusReference":"f0b24de5-25e7-4fab-ab94-63d81db6c0c0"},"triggers":[],"type":"INITIAL","validators":[]}]}]')", true)

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
Id	String	False				The unique identifier of the workflow within Jira. This ID is used internally and in API operations to reference the workflow.
Name	String	False		IN		The name assigned to the workflow, which typically reflects the process or team it supports (for example, 'Software Development Workflow').
Description	String	False				A user-defined explanation of what the workflow represents or how it should be used. Helpful for distinguishing between similar workflows.
Created	String	False				The timestamp indicating when the workflow was initially created.
Updated	String	False				The timestamp indicating the most recent update to the workflow. Reflects configuration or metadata changes.
IsDefault	Boolean	False				If the value is 'true', the workflow is currently designated as the default workflow for its associated issue type or project.
CanDelete	Boolean	False				If the value is 'true', the workflow can be deleted by users with appropriate permissions. Some system workflows cannot be deleted.
CanEdit	Boolean	False				If the value is 'true', the workflow can be edited. This can be restricted based on permissions or if the workflow is active.
IsActive	Boolean	False		=		If the value is 'true', the workflow is currently in use by one or more projects. Active workflows can be subject to restrictions for modification or deletion.
Query	String	False		=		Used in search queries to filter workflows by name. Supports case-insensitive, partial string matching.
Scope	String	False				A JavaScript Object Notation (JSON) object defining the scope of the workflow, such as whether it is global or limited to specific projects. This is write-only and does not appear in SELECT statements.
Statuses	String	False				A JSON object specifying the statuses included in the workflow. Used during workflow creation or updates to define transitions and state logic.
Workflows	String	False				A JSON object containing the full workflow configuration. Used for bulk creation or update of workflows and not returned in SELECT queries.

Handles the configuration of workflow schemes that assign workflows to issue types across projects.

Note: This table is available only in the Jira Cloud version.

Select

The Cloud will use the Jira API to process filters that refer to Id while the rest of the filter is executed client side within the Cloud. The Jira APIs support filters using the equals (=) operator with Id.

For example, the below queries are processed server side.

Retrieve all the available workflow schemes:

SELECT * FROM WorkflowSchemes

Retrieve a specific workflow scheme by Id:

SELECT * FROM WorkflowSchemes WHERE Id = 10400

Insert

Name is required to insert. The following query creates a new workflow scheme:

INSERT INTO WorkflowSchemes (name, Description, DefaultWorkflow, IssueTypeMappingsAggregate) VALUES('Jira Service Management IT Support Workflow', 'Incident Management workflow for Jira Service Management.', 'jira', '{"10201": "jira"}')

Update

You can update by specifying the workflow scheme Id:

UPDATE WorkflowSchemes SET Name = 'Jira Updated Service Management IT Support Workflow', Description='Updated incident Management workflow for Jira Service Management.' WHERE Id =11526

Delete

Delete a workflow scheme by specifying the workflow scheme Id:

DELETE WorkflowSchemes WHERE Id=11526

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
Id [KEY]	Integer	True		=	Cloud	The unique identifier of the workflow scheme. This ID is used to manage and reference the scheme in Jira operations.
Name	String	False			Cloud	The user-defined name of the workflow scheme. Workflow schemes define how issues transition through workflows based on their issue types.
Description	String	False			Cloud	An optional description that explains the purpose or usage of the workflow scheme. Useful for distinguishing between multiple schemes.
IssueTypeMappingsAggregate	String	False			Cloud	A JavaScript Object Notation (JSON)-style aggregate listing mappings between issue types and workflows. Each mapping pairs an issue type ID with the name of its assigned workflow.
DefaultWorkflow	String	False			Cloud	The name of the workflow used for issue types not explicitly mapped in the scheme. Acts as a fallback when no direct mapping is available.
Self	String	True			Cloud	A REST API URL pointing to the workflow scheme resource. Useful for retrieving or updating the scheme programmatically.

Provides full access to Jira worklogs. Supports creating, updating, deleting, and querying logged work hours on issues.

Table Specific Information

Select

You can query this table to retrieve worklogs of Jira projects. The Cloud will use the Jira APIs to process filters based on the following columns and operators. The Cloud will execute other filters client-side. The below example queries are processed server side.

To retrieve worklogs linked to a specific issue, query the Worklogs table by specifying either the IssueId or IssueKey column.

SELECT * FROM Worklogs WHERE IssueId = 123

To retrieve worklogs linked to issues within a specific project, query the Worklogs table by specifying either the ProjectId or ProjectName column.

SELECT * FROM Worklogs WHERE ProjectId = 10100

Insert

IssueId, Started, and TimeSpentSeconds are required to insert. The following query logs work done for an issue:

INSERT INTO Worklogs (IssueId, Started, TimeSpentSeconds) VALUES (10003, '2017-03-20 20:00:00', 10000)

Update

Both the worklog Id and IssueId are required to modify the worklog:

UPDATE Worklogs SET TimeSpentSeconds = 200000 WHERE Id = 10602 AND IssueId = 10003

Delete

Delete a worklog of an issue by providing the Id and IssueId:

DELETE FROM Worklogs WHERE Id = 10602 AND IssueId = 10003

GetDeleted

This retrieves Ids of the deleted worklogs:

GETDELETED FROM Worklogs

Columns

Name	Type	ReadOnly	References	SupportedOperators	Platform	Description
Id [KEY]	String	True		=	Common	The unique identifier of the worklog entry used to distinguish it from all other worklogs in the system.
IssueId [KEY]	Integer	False	Issues.Id	=,<>,>,>=,<,<=,IN,NOT IN	Common	The internal numeric ID of the Jira issue associated with this worklog entry. This links the worklog to a specific issue.
IssueKey	String	False	Issues.Key	=,IN,NOT IN	Common	The human-readable key of the Jira issue (such as 'ABC-123') that this worklog entry pertains to.
ProjectId	Integer	True	Projects.Id	=,IS,IS NOT,IN,NOT IN	Common	The numeric ID of the project to which the issue belongs. This helps associate the worklog with a broader context.
ProjectName	String	True		=,IS,IS NOT,IN,NOT IN	Common	The name of the project that the associated issue and worklog entry belong to.
IssueCreatedDate	Datetime	True		=,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The date and time when the issue associated with this worklog was originally created.
IssueUpdatedDate	Datetime	True		=,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The date and time when the issue associated with this worklog was last updated.
AuthorDisplayName	String	True	Users.DisplayName	=,!=,IS,IS NOT,IN,NOT IN	Common	The display name of the user who initially created the worklog entry.
UpdateAuthorDisplayName	String	True	Users.DisplayName		Common	The display name of the user who most recently updated or modified the worklog entry.
Comment	String	False		LIKE,NOT LIKE	Common	The free-text comment or description added by the user to describe the work performed during this logged time.
Created	Datetime	True		=,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The date and time when the worklog entry was created in Jira.
Updated	Datetime	True			Common	The date and time when the worklog entry was last modified.
VisibilityType	String	False			Common	The category of restriction that controls who can view this worklog entry, such as role-based or group-based visibility.
VisibilityValue	String	False			Common	The specific value used to enforce visibility restrictions, such as the name of the user role or group allowed to view the entry.
Started	Datetime	False			Common	The exact date and time when the user began working, according to this logged work entry.
TimeSpent	String	False			Common	The total time spent on the issue, as logged in this worklog entry, formatted as a string (such as '3h 15m').
TimeSpentSeconds	Long	False			Common	The total time spent on the issue in seconds, useful for precise calculations and aggregations.
AuthorAccountId	String	True	Users.AccountId	=,!=,IS,IS NOT,IN,NOT IN	Cloud	The Atlassian account ID of the user who created the worklog, used for cross-product user identification.
UpdateAuthorAccountId	String	True	Users.AccountId		Cloud	The Atlassian account ID of the user who last updated the worklog, used for consistent tracking of changes.
AuthorAccountKey	String	True	Users.Key		Server	The legacy user key of the person who created the worklog entry. This field can not be supported in newer Jira versions.
AuthorAccountName	String	True	Users.Name	=,!=,IS,IS NOT,IN,NOT IN	Server	The legacy username of the worklog creator. This value can be deprecated in favor of accountId.
UpdateAuthorAccountKey	String	True	Users.Key		Server	The legacy user key of the person who last updated the worklog entry. This value can be deprecated.
UpdateAuthorAccountName	String	True	Users.Name		Server	The legacy username of the user who last modified the worklog. This field can not be supported in newer Jira versions.
ItemURL	String	True				A direct URL to view the specific worklog entry in the Jira UI, useful for navigation or reporting.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Jira Views

Name	Description
AdvancedSettings	Returns a list of advanced application properties configured in Jira, as displayed on the Advanced Settings page.
ApplicationRoles	Retrieves all configured application roles, which control user access and are managed through Jira's Application Access settings.
Audit	Retrieves audit log records, offering insights into changes and administrative actions performed within the Jira account.
BoardConfiguration	Displays the configuration settings of agile boards, including filters, estimation type, and card layout.
BoardIssues	Lists all issues displayed on agile boards, including their rank and column placement.
BoardSprints	Retrieves a list of sprints associated with a specific agile board, including active, future, and closed sprints.
Configuration	Returns system-level Jira configuration details, such as time tracking and attachment settings.
CustomFieldContext	Returns a list of contexts for a custom field in Jira.
Dashboards	Retrieves dashboards available to the user, including those shared with others or marked as favorites.
Epics	Lists all epics across Jira projects, including epic names, summaries, and keys.
FavouriteFilters	Returns filters marked as favorites by the current user, enabling easy access to commonly used searches.
Fields	Retrieves metadata about all fields available in Jira, including both system-defined and custom fields.
Filters	Displays saved filters created by users to retrieve specific issue sets. Not available in Jira Server deployments.
FiltersUsers	Returns the users or groups that specific filters are shared with.
Groups	Lists user groups configured in the Jira instance, including group names and descriptions.
GroupsUsers	Retrieves mappings between users and their associated groups.
IssueAffectedVersions	Returns the software versions affected by specific issues, indicating where the bug or feature is observed.
IssueChangelogs	Provides a detailed history of changes made to issues, including field changes, timestamps, and authors.
IssueComponents	Lists components assigned to issues, which typically represent parts or modules of a project.
IssueCustomFields	Retrieves metadata and configuration of custom fields created in the Jira instance.
IssueFixVersions	Returns the list of versions in which specific issues are expected to be resolved.
IssueLinks	Displays relationships between issues, such as 'blocks', 'duplicates', or 'relates to'.
IssueLinkTypes	Lists all available link types that can be used to create relationships between issues.
IssueNavigatorDefaultColumns	Retrieves the default column layout for the issue navigator, which defines which fields are shown in search results.
IssuePriorities	Returns all priority levels available in the Jira instance, such as 'High', 'Medium', and 'Low'.
IssueResolutions	Retrieves all resolution values used to indicate how issues were completed, such as 'Fixed' or 'Won't Fix'.
IssueSecurityLevelMembers	Retrieves the users and groups associated with specific issue security levels, which control visibility of issues.
IssueSubtasks	Lists all subtasks associated with Jira issues, including parent-child relationships and statuses.
IssueTransitions	Displays all possible transitions for issues, including available status changes and transition rules.
MyPermissions	Returns the permissions granted to the current user based on their roles and group memberships.
PermissionGrants	Displays all permission grants defined in permission schemes, including scope and associated roles or groups.
Permissions	Lists the complete set of permissions available in Jira, such as 'Browse Projects' or 'Edit Issues'.
PermissionSchemes	Retrieves defined permission schemes, which are used to manage access control across Jira projects.
ProjectCategories	Lists all available project categories, which are used to organize and group Jira projects.
ProjectRoles	Retrieves role definitions that can be assigned across projects, such as 'Developers' or 'Administrators'.
ProjectsIssueTypes	Displays issue types configured for each project, including standard and custom issue types.
ProjectsPermissionScheme	Returns the permission scheme currently assigned to each project.
ProjectTypes	Lists all available project types in Jira, such as business, software, or service management projects.
SecurityLevels	Returns all configured security levels, which determine visibility of issues for specific users or groups.
SecuritySchemes	Lists security schemes that group security levels and apply them to Jira projects.
SprintIssues	Retrieves issues assigned to agile sprints, including their rank and progress within the sprint.
Statuses	Lists all available issue statuses in Jira, including custom and default statuses used in workflows.
TimeTrackingProviders	Displays the time tracking providers configured in the Jira instance, which manage estimation and logging.
Votes	Query the available Votes in Jira.
WorkflowStatusCategories	Lists all status categories such as 'To Do', 'In Progress', or 'Done' used to group workflow statuses visually.
WorkflowStatuses	Displays all statuses used in Jira workflows, along with their properties and associated categories.
WorklogDeleted	Retrieves records of deleted worklogs, useful for audit trails or troubleshooting time tracking inconsistencies.

Returns a list of advanced application properties configured in Jira, as displayed on the Advanced Settings page.

Table Specific Information

Select

SELECT * FROM AdvancedSettings

Columns

Name	Type	References	SupportedOperators	Platform	Description
Id [KEY]	String		=	Common	A unique identifier assigned to each application property in Jira's advanced settings. This value is used internally to distinguish different configuration items.
Name	String			Common	The key or internal name of the application property, which defines what specific feature or setting it controls in the Jira environment.
Description	String			Common	A human-readable explanation of the application's property purpose, detailing what aspect of Jira functionality it affects.
Type	String			Common	Indicates the data type expected for the property's value, such as string, number, or boolean, which determines how the value is interpreted and validated.
Value	String			Common	The user-defined value that is currently set for the application property, which overrides the default behavior and customizes the instance configuration.
DefaultValue	String			Common	The original system-defined value that Jira assigns to the property if no custom value is set. This serves as a fallback for consistent behavior.
AllowedValues	String			Common	A list of acceptable values that the property can take. This can include specific strings, numeric ranges, or boolean values, and helps ensure that user input remains valid.

Retrieves all configured application roles, which control user access and are managed through Jira's Application Access settings.

Table Specific Information

Select

The Cloud uses the Jira API to process some of the filters.

The Cloud processes other filters within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM ApplicationRoles WHERE Key = 'jira-software'

Columns

Name	Type	References	SupportedOperators	Platform	Description
Key [KEY]	String		=	Common	A unique identifier used to reference the application role programmatically. This value is used in API calls and internal configuration.
Name	String			Common	The user-friendly display name of the application role, such as 'Jira Software' or 'Jira Service Management'.
Groups	String			Common	A comma-separated list of Jira groups associated with this application role. Users in these groups gain access to the role's features.
DefaultGroups	String			Common	A comma-separated list of groups automatically assigned this role when new users are created, providing them with default application access.
SelectedByDefault	Boolean			Common	If the value is 'true', this application role is automatically selected for new users during account creation unless otherwise specified.
NumberOfSeats	Integer			Common	The total number of user licenses allocated to this application role, as defined by your Jira subscription.
RemainingSeats	Integer			Common	The number of user licenses still available for this application role, based on current usage and subscription limits.
UserCount	Integer			Common	The total number of active users currently consuming seats under this application role.
UserCountDescription	String			Common	A brief description of the user types included in the seat count, such as active users or users with specific group memberships.
HasUnlimitedSeats	Boolean			Common	If the value is 'true', there is no limit to the number of users who can be assigned this application role.
Platform	Boolean			Common	If the value is 'true', this application role is part of the Jira platform core (jira-core), as opposed to an add-on like Jira Software or Jira Service Management.

Retrieves audit log records, offering insights into changes and administrative actions performed within the Jira account.

Table Specific Information

Select

The Cloud uses the Jira API to process some of the filters.

The Cloud processes other filters within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM Audit WHERE Filter = 'ab'

Columns

Name	Type	References	SupportedOperators	Platform	Description
RecordId	Integer			Common	The unique identifier of the audit record, used to distinguish individual audit log entries.
Summary	String			Common	A brief summary describing what change occurred, such as a permission update or user role change.
RemoteAddress	String			Common	The IP address from which the action was performed, providing traceability of the source system.
AuthorKey	String			Common	The unique internal key of the user or system that performed the audited action.
Created	Datetime			Common	The timestamp indicating when the change was recorded in the audit log.
Category	String			Common	The general category of the change, such as 'User Management', 'Project Configuration', or 'Workflow Edits'.
EventSource	String			Common	The origin of the event that triggered the audit record, such as a UI interaction or REST API call.
Description	String			Common	A detailed explanation of the change that was made, including the context and nature of the update.
ItemId	String			Common	A system-generated unique identifier of the item (such as a user, project, or setting) that was changed.
ItemName	String			Common	The name of the item affected by the audited change, such as a project name or field label.
ItemTypeName	String			Common	The type of the item that was changed, such as 'Custom Field', 'User', or 'Project'.
ItemParentId	String			Common	The unique identifier of the parent object, if the audited item is part of a hierarchy (such as a field within a project).
ItemParentName	String			Common	The name of the parent object related to the item, such as the project or configuration scheme name.
FieldName	String			Common	The name of the specific field that was changed, such as 'Permission Scheme' or 'Project Lead'.
ChangedFrom	String			Common	The original value of the field before the change was applied.
ChangedTo	String			Common	The new value of the field after the change was completed.

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.

Name	Type	Description
Filter	String		A keyword filter used to return only audit records that contain a specified string in at least one field. For example, using 'permission' will return changes involving permission updates.

Displays the configuration settings of agile boards, including filters, estimation type, and card layout.

Columns

Name	Type	References	SupportedOperators	Platform	Description
BoardId [KEY]	Integer	Boards.Id	=,IN		The unique identifier of the board whose configuration is being returned. This value is used to query specific boards.
ColumnConfig	String				The configuration settings for the columns displayed on the board. Includes the order of columns, mapped issue statuses, and any applied constraints such as minimum or maximum issue counts. Constraint types include: 'none', 'issueCount', and 'issueCountExclSubs' (excluding subtasks).
Filter	String				A reference to the saved filter associated with the board, which determines the set of issues shown.
Name	String				The name assigned to the board, typically defined by users to describe the board's purpose or project.
CustomFieldIdRank	Integer				The internal ID of the custom field used for issue ranking within the board. This is often used to control issue order in backlog and active sprints.
Self	String				The URL that links to the board resource in the Jira API. This is useful for programmatic access or navigation.
SubQuery	String				A Jira Query Language (JQL) subquery used by the board to further refine the issue set beyond the main filter.
Type	String				The type of board, such as 'scrum' or 'kanban', which determines how issues are displayed and managed.
EstimationDisplayName	String				The human-readable name of the field used for issue estimation, such as 'Story Points' or 'Original Estimate'.
EstimationFieldId	String				The ID of the field used to provide estimates on the board. This links to a specific custom or system field.
EstimationType	String				Indicates the method of estimation used for the board. Accepted values include: 'none' (no estimation), 'issueCount' (based on issue count), or 'field' (based on a specific custom field such as story points).

Lists all issues displayed on agile boards, including their rank and column placement.

Table Specific Information

Select

The Cloud uses the Jira API to process some of the filters. The Cloud processes other filters within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM BoardIssues WHERE BoardId = '1' 
SELECT * FROM BoardIssues WHERE BoardId IN (70, 215) 

Columns

Name	Type	References	SupportedOperators	Platform	Description
Id [KEY]	Integer	Issues.Id	=,IN	Common	The unique identifier of the issue as stored in Jira.
Key	String	Issues.Key	=,IN	Common	The issue key, which is a human-readable identifier composed of the project key and issue number (such as 'PROJ-123').
BoardId [KEY]	Integer	Boards.Id	=,IN	Common	The ID of the board that includes this issue. This links the issue to a specific agile board (for example, Scrum or Kanban).
IssueTypeId	String	IssueTypes.Id	=,!=,IS,IS NOT,IN,NOT IN	Common	The unique identifier for the issue type (such as 'task', 'story', 'bug') assigned to the issue.
IssueTypeName	String		=,!=,IS,IS NOT,IN,NOT IN	Common	The display name of the issue type, which describes the nature of the issue (for example, 'Story', 'Bug', or 'Task').
StatusId	Integer	Statuses.Id	=,!=,IS,IS NOT,IN,NOT IN	Common	The ID of the current status of the issue, used internally in Jira's workflow engine.
StatusName	String		=,!=,IS,IS NOT,IN,NOT IN	Common	The name of the current status of the issue, such as 'To Do', 'In Progress', or 'Done'.
ProjectId	Integer	Projects.Id	=,!=,IS,IS NOT,IN,NOT IN	Common	The internal ID of the project that the issue belongs to.
ProjectKey	String	Projects.Key	=,!=,IS,IS NOT,IN,NOT IN	Common	The short code identifier of the project (for example, 'PROJ') that this issue is part of.
ProjectName	String		=,!=,IS,IS NOT,IN,NOT IN	Common	The name of the project to which the issue belongs.
ClosedSprintsAggregate	String			Common	A list of sprints that this issue has previously been assigned to and that are now closed. This provides historical sprint data.
Created	Datetime		=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The timestamp when the issue was initially created in Jira.
Updated	Datetime		=,!=,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The timestamp of the last update made to the issue, including changes to status, assignees, or fields.

Retrieves a list of sprints associated with a specific agile board, including active, future, and closed sprints.

Table Specific Information

Select

The Cloud uses the Jira API to process some of the filters. The Cloud processes other filters within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM BoardSprints WHERE BoardId = 122 

Using BoardId:

SELECT * FROM BoardSprints WHERE BoardId IN (12, 42) 

Boards of type 'kanban' do not support sprints, so you can retrieve all the sprints faster if you use a query like the following:

SELECT * FROM BoardSprints WHERE BoardId IN (SELECT Id FROM Boards WHERE Type != 'kanban') 

Columns

Name	Type	References	SupportedOperators	Platform	Description
Id [KEY]	Integer			Common	The unique identifier of the sprint used to reference the sprint within Jira.
BoardId [KEY]	Integer	Boards.Id	=,IN	Common	The identifier of the board the sprint belongs to. Sprints are created and managed within the context of a board.
Name	String			Common	The user-defined name of the sprint, typically representing a time-boxed development iteration.
State	String		=	Common	The current lifecycle state of the sprint. Valid values include 'future', 'active', and 'closed', with transitions limited to 'future' → 'active' → 'closed'. The allowed values are future, active, closed.
Goal	String			Common	The goal or objective defined for the sprint, often used to communicate the sprint's focus or expected outcome.
OriginBoardId	Integer	Boards.Id	=	Common	The identifier of the board where the sprint was initially created. This value is read-only and cannot be changed.
StartDate	Datetime			Common	The date and time when the sprint was started, marking the beginning of the sprint duration.
EndDate	Datetime			Common	The scheduled end date and time of the sprint, representing the planned close of the sprint window.
CompleteDate	Datetime			Common	The actual completion date of the sprint. This field is set when the sprint is officially closed.

Returns system-level Jira configuration details, such as time tracking and attachment settings.

Table Specific Information

Select

The Cloud processes all filters specified on this table client-side within the Cloud.

SELECT * FROM Configuration

Columns

Name	Type	References	SupportedOperators	Platform	Description
VotingEnabled	Boolean			Common	Indicates whether users are allowed to vote on issues to signal importance or interest.
WatchingEnabled	Boolean			Common	Specifies whether users can watch issues to receive notifications about updates or changes.
UnassignedIssuesAllowed	Boolean			Common	Determines whether issues can remain unassigned, without a designated responsible user.
SubTasksEnabled	Boolean			Common	Specifies whether sub-tasks can be created under standard issues to break down work into smaller pieces.
IssueLinkingEnabled	Boolean			Common	Indicates whether issues can be linked to each other using relationship types such as 'blocks' or 'relates to'.
TimeTrackingEnabled	Boolean			Common	Controls whether time tracking features, such as logging work and estimating time, are enabled.
AttachmentsEnabled	Boolean			Common	Determines whether users can upload attachments to issues, such as documents, screenshots, or logs.
WorkingHoursPerDay	Double			Common	Specifies the standard number of working hours per day, used in time tracking and reporting.
WorkingDaysPerWeek	Double			Common	Specifies the standard number of working days per week, typically used for capacity planning and time estimation.
TimeFormat	String			Common	The format used to display time values, such as 12-hour or 24-hour format.
DefaultUnit	String			Common	The default unit of time used in Jira, such as minutes, hours, or days, for time tracking and estimation.

Returns a list of contexts for a custom field in Jira.

Columns

Name	Type	References	SupportedOperators	Platform	Description
Id [KEY]	String				The Id of the context.
CustomFieldId	String		=		The CustomFieldId.
Name	String				The Name of the context.
Description	String				The Description of the context.
IsGlobalContext	Boolean				Whether the context is global.
IsAnyIssueType	Boolean				Whether the context apply to all issue types.

Retrieves dashboards available to the user, including those shared with others or marked as favorites.

Table Specific Information

Select

The Cloud uses the Jira API to process some of the filters. Jira supports the Id and Filter columns but not both at the same time.

The Cloud processes other filters within the Cloud.

For example, the following queries are processed server side.

SELECT * FROM Dashboards WHERE Id = 10001

You can also filter on the pseudo column Filter:

SELECT * FROM Dashboards WHERE Filter = 'favourite'

Columns

Name	Type	References	SupportedOperators	Platform	Description
Id [KEY]	String		=	Common	The unique identifier assigned to the dashboard within Jira. This ID is used to reference the dashboard programmatically.
Name	String			Common	The display name of the dashboard, visible to users in the Jira interface.
View	String			Common	The direct URL that allows users to view the dashboard in the Jira interface.

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.

Name	Type	Description
Filter	String		An optional filter to limit the results to specific categories of dashboards. For example, 'favourite' shows dashboards marked as favorites, while 'my' shows dashboards owned by the current user. The allowed values are favourite, my.

Lists all epics across Jira projects, including epic names, summaries, and keys.

Table Specific Information

Select

The Cloud uses the Jira API to process some of the filters.

The Cloud processes other filters within the Cloud.

For example, the following queries are filtered server-side:

SELECT * FROM Epics WHERE BoardId = 1

SELECT * FROM Epics WHERE BoardId IN (1, 2, 3)

By specifying the Id or Key of a certain epic:

SELECT * FROM Epics WHERE Id = 10000 

SELECT * FROM Epics WHERE Id IN (10000, 10001) 

SELECT * FROM Epics WHERE Key = 'TSS-9151' 

SELECT * FROM Epics WHERE Key IN ('TSS-9151', 'TSS-9152') 

Columns

Name	Type	References	SupportedOperators	Platform	Description
Id [KEY]	Integer		=,IN	Common	The unique numeric identifier of the Epic, used to reference the Epic internally.
Key [KEY]	String		=,IN	Common	The unique key assigned to the Epic, typically visible in the Jira user interface (such as 'EPIC-101').
BoardId [KEY]	Integer	Boards.Id	=,IN	Common	The identifier of the Jira board where the Epic is managed. This helps link the Epic to a specific agile board.
Name	String			Common	The name or title of the Epic, used to identify it in issue listings and reports.
Done	Boolean			Common	If the value is 'true', the Epic has been marked as complete. If the value is 'false', the Epic is still in progress.
ColorKey	String			Common	The color key assigned to the Epic, used to visually distinguish it from other issues in Jira boards.
Summary	String			Common	A short text summary providing additional context or a high-level overview of the Epic's purpose or goals.

Returns filters marked as favorites by the current user, enabling easy access to commonly used searches.

Columns

Name	Type	References	SupportedOperators	Platform	Description
Id [KEY]	Integer			Common	The unique identifier assigned to the favorite filter, used to distinguish it from other filters.
Name	String			Common	The display name assigned to the favorite filter, typically chosen by the user.
JQLExpression	String			Common	The Jira Query Language (JQL) expression used by the filter to retrieve a specific set of issues based on defined criteria.
Description	String			Common	An optional, user-provided explanation of the filter's purpose or what type of issues it returns.
OwnerDisplayName	String			Common	The full display name of the user who created and owns the favorite filter.
OwnerAccountId	String			Cloud	The unique account ID of the user who owns the favorite filter, used for identification across the Jira platform.
Count	Integer			Cloud	The total number of users who have marked this filter as a favorite, indicating its popularity or usefulness.
OwnerKey	String			Server	The internal key that uniquely identifies the user who owns the favorite filter.

Retrieves metadata about all fields available in Jira, including both system-defined and custom fields.

Columns

Name	Type	References	SupportedOperators	Platform	Description
Id [KEY]	String			Common	The unique identifier of the field, used internally by Jira to reference the field.
Key	String			Common	The system or custom-defined key that identifies the field in API operations and configurations.
Name	String			Common	The display name of the field as shown in the Jira user interface.
Custom	Boolean			Common	Indicates whether the field is a user-defined custom field ('true') or a built-in system field ('false').
Orderable	Boolean			Common	If the value is 'true', the field can be included in issue sort operations. If 'false', it cannot be used for ordering results.
Navigable	Boolean			Common	If the value is 'true', the field is visible in the issue navigator. If 'false', it is hidden from navigation views.
Searchable	Boolean			Common	If the value is 'true', the field supports inclusion in search queries. If 'false', it cannot be queried through Jira Query Language (JQL).

Displays saved filters created by users to retrieve specific issue sets. Not available in Jira Server deployments.

Table Specific Information

Select

The Cloud uses the Jira API to process some of the filters.

The Cloud processes other filters within the Cloud.

Retrieve all filters:

SELECT * FROM Filters 

By specifying the Id of a certain filter:

SELECT * FROM Filters WHERE Id = 10001 

Columns

Name	Type	References	SupportedOperators	Platform	Description
Id [KEY]	Integer		=	Cloud	The unique identifier of the filter used to reference it in the Jira API and user interface.
Name	String			Cloud	The display name assigned to the filter for easier identification.
JQLExpression	String			Cloud	The Jira Query Language (JQL) expression that defines the filter's search criteria for issues.
Description	String			Cloud	A short explanation of what the filter does or what it is intended to find.
OwnerDisplayName	String		=	Cloud	The display name of the user who created and owns the filter.
Favourite	Boolean			Cloud	If the value is 'true', the filter is marked as a favourite by the current user.
FavouritedCount	Integer			Cloud	The number of users who have marked this filter as a favourite.
SubscriptionsAggregate	String			Cloud	A list of users who are subscribed to receive notifications when the filter results change.
SharePermissionsAggregate	String			Cloud	A list of groups or users with whom the filter has been shared.

Returns the users or groups that specific filters are shared with.

Columns

Name	Type	References	SupportedOperators	Platform	Description
AccountId [KEY]	String		=		The globally unique account ID of the user, which is used across all Atlassian cloud services to identify the user regardless of email or username changes.
FilterId [KEY]	String	Filters.Id	=		The unique identifier of the saved filter that the user has access to or is associated with. Filters define sets of issues based on Jira Query Language (JQL) criteria.
DisplayName	String		=		The name that is shown for the user in the Jira user interface. This is typically their full name and is used in dashboards, issue fields, and mentions.
EmailAddress	String		=		The primary email address associated with the user's Atlassian account. This is used for notifications and account recovery.
Active	Bool				If the value is 'true', the user is currently active and has permission to log in and interact with Jira. If 'false', the user has been deactivated.
TimeZone	String				The time zone configured in the user's profile. This setting affects how dates and times are displayed throughout the Jira interface for that user.
Locale	String				The language and regional settings selected by the user, which determine formats for numbers, dates, times, and the UI language.
AccountType	String				The classification of the user account. This can indicate whether the account belongs to a regular user, a third-party application, or an internal system user such as a bot or integration.

Lists user groups configured in the Jira instance, including group names and descriptions.

Table Specific Information

Select

The Cloud uses the Jira API to process some of the filters. The Cloud processes other filters within the Cloud.

SELECT * FROM GROUPS WHERE Name <> 'administrator' AND CONTAINS(Name, 'jira')

Columns

Name	Type	References	SupportedOperators	Platform	Description
Id [KEY]	String			Common	A unique identifier for the group, used internally to reference the group within Jira.
Name	String		=,!=,CONTAINS	Common	The name of the group as it appears in Jira. This is typically used for permission schemes and role assignments.
Html	String			Common	The raw HTML representation of the group object. This may be used in UI rendering or API responses.
LabelsAggregate	String			Common	A comma-separated list of labels that are associated with the group. Labels can help categorize or describe the group's function or purpose.

Retrieves mappings between users and their associated groups.

View Specific Information

Select

The Cloud utilizes the Jira API to process WHERE clause conditions that include the following columns and supported operators. Any remaining filters are applied client-side by the Cloud.

To effectively query the GroupsUsers view, you must specify a value for either the GroupName column or the GroupId column (the latter is exclusive to cloud instances). If neither GroupName nor GroupId is provided, the Cloud will automatically iterate through all groups to retrieve all associated users, which may result in increased query times.

As shown in the examples below, to retrieve users who belong to a specific group, include either the GroupName or GroupId in your query.

• Using GroupId:
  

  SELECT * FROM GroupsUsers WHERE GroupId = '37f2babd-27ef-442e-8642-15b6cafba31c'

• Using GroupName:
  

  SELECT * FROM GroupsUsers WHERE GroupName = 'jira-software-users'

Columns

Name	Type	References	SupportedOperators	Platform	Description
AccountId [KEY]	String			Cloud	The unique account ID of the user across all Atlassian products, used for identifying the user in a platform-wide context.
Key [KEY]	String			Server	The internal key used to identify the user within Jira. This can differ from the account ID.
GroupId [KEY]	String		=	Cloud	The unique identifier of the group that the user belongs to. Used to map group memberships.
GroupName [KEY]	String		=	Common	The name of the group the user is associated with. Groups are often used for permission management.
Name	String			Server	The Jira username of the user. This value can be deprecated in some contexts in favor of AccountId.
DisplayName	String			Common	The full display name of the user as shown in the Jira UI and user directories.
EmailAddress	String			Common	The email address associated with the user's Atlassian account.
Active	Bool			Common	If the value is 'true', the user is currently active and able to log in. If 'false', the account is inactive or suspended.
TimeZone	String			Common	The time zone configured in the user's profile, which affects how time-related data is displayed.
Locale	String			Cloud	The locale (language and region format) specified in the user's profile, used to localize the UI.
AccountType	String			Cloud	The type of account the user holds, such as 'atlassian' or 'app'. Useful for distinguishing user roles or access methods.
Products	String			Cloud	A comma-separated list of Jira products the user has access to. For example: jira-core, jira-servicedesk, jira-product-discovery, jira-software.

Returns the software versions affected by specific issues, indicating where the bug or feature is observed.

Table Specific Information

You can search IssueAffectedVersions by using SQL and JQL (Jira Query Language).

Select

The Cloud uses the Jira API to process some of the filters.

The Cloud processes other filters within the Cloud.

The available columns for IssueAffectedVersions are IssueId, IssueKey, and JQL. For example:

SELECT * FROM IssueAffectedVersions WHERE IssueId > 10022 AND IssueId < 10090

Columns

Name	Type	References	SupportedOperators	Platform	Description
VersionId [KEY]	String		=,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The unique identifier of the version that is marked as affected by the issue. Used to track which versions are impacted.
IssueId [KEY]	Integer	Issues.Id	=,<>,>,>=,<,<=,IN,NOT IN	Common	The internal numeric ID of the issue associated with the affected version.
IssueKey	String	Issues.Key	=,<>,>,>=,<,<=,IN,NOT IN	Common	The readable issue key (such as 'PROJ-123') that identifies the issue associated with the affected version.
IssueCreatedDate	Datetime		=,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The date and time when the issue related to the affected version was originally created.
IssueUpdatedDate	Datetime		=,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The date and time when the issue associated with the affected version was last updated.
Name	String			Common	The name assigned to the affected version, typically representing a release or milestone.
Archived	Boolean			Common	If the value is 'true', the affected version has been archived and is no longer active in project planning.
Released	Boolean			Common	If the value is 'true', the affected version has been officially released.
ReleaseDate	Date			Common	The scheduled or actual release date for the affected version, if available.

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.

Name	Type	Description
JQL	String		Jira Query Language (JQL) allows structured querying of issues. Use this to filter affected versions based on issue criteria.

Provides a detailed history of changes made to issues, including field changes, timestamps, and authors.

Table Specific Information

You can search IssueChangelogs by using SQL and JQL (Jira Query Language).

Select

The Cloud uses the Jira API to process some of the filters.

The Cloud processes other filters within the Cloud.

The available columns for server-side filtering for IssueChangelogs are IssueId, IssueKey, ProjectId, ProjectKey, ProjectName, and JQL. For example:

SELECT * FROM IssueChangelogs WHERE IssueId<>10022
SELECT * FROM IssueChangelogs WHERE ProjectKey = 'PRJ'

Columns

Name	Type	References	SupportedOperators	Platform	Description
HistoryId [KEY]	Integer			Common	The unique identifier of the changelog entry that records a specific modification made to an issue, used to differentiate individual changes in the issue history.
ItemField [KEY]	String			Common	The name of the specific field that was changed in the issue, such as priority, assignee, or status.
IssueId	Integer	Issues.Id	=,<>,>,>=,<,<=,IN,NOT IN	Common	The internal numeric identifier of the issue for which the changelog entry applies, used to relate the change to the correct issue.
IssueKey	String	Issues.Key	=,<>,>,>=,<,<=,IN,NOT IN	Common	The human-readable key of the issue (such as 'JIRA-123') that was updated in the changelog entry.
Created	Datetime			Common	The exact date and time when the change was recorded in the issue history.
IssueCreatedDate	Datetime		=,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The timestamp indicating when the issue itself was originally created, regardless of the change.
IssueUpdatedDate	Datetime		=,<>,>,>=,<,<=,IS,IS NOT,IN,NOT IN	Common	The timestamp marking the most recent update to the issue at the time of the changelog entry.
ItemFieldType	String			Common	The type of field that was changed, such as string, user, option, or date, providing context for how the data is handled.
ItemFrom	String			Common	The internal or stored value of the field before the change occurred, useful for identifying the exact prior state.
ItemFromString	String			Common	A human-readable version of the field's value before the update, shown as it would appear in the Jira UI.
ItemTo	String			Common	The internal or stored value of the field after the change was applied.
ItemToString	String			Common	A human-readable version of the field's new value after the change, shown as it would appear in the Jira UI.
AuthorDisplayName	String			Common	The full display name of the user who made the change, typically shown in the Jira UI.
AuthorAccountId	String			Cloud	The unique identifier of the user account in Atlassian systems that performed the change, ensuring consistent identification across products.
AuthorName	String			Cloud	The legacy username or short name of the user who made the change, used in older Jira configurations.
AuthorAccountKey	String			Server	The internal key identifying the account that made the change, used to link user actions to account metadata.
AuthorAccountName	String			Server	The full account name of the user who performed the update, often used in directory integrations or audit trails.
ProjectId	Integer	Projects.Id	=,!=,IS,IS NOT,IN,NOT IN	Common	The unique numeric identifier of the project associated with the issue, used for internal references and queries.
ProjectKey	String	Projects.Key	=,!=,IS,IS NOT,IN,NOT IN	Common	The readable key of the project (such as 'PROJ') that the issue belongs to, used in URLs and filters.
ProjectName	String		=,!=,IS,IS NOT,IN,NOT IN	Common	The descriptive name of the project that contains the issue, providing context for where the issue resides.

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.

Name	Type	Description
JQL	String		Jira Query Language (JQL) allows users to filter changelog entries based on conditions like project, user, field, or date ranges.