Jira

Authentication methods

Atlassian Cloud, API Token

To generate a token:

1. Visit https://id.atlassian.com/manage-profile/security/api-tokens

2. Create an API token

3. Use it in conjunction with your username, typically your email address

API Tokens are different to the API keys that you create in the Admin app.

If you generate an API key and use it, the connector will still authenticate successfully but it'll likely have no Jira privileges. In the case of inbound Issue syncs, it may complete successfully with zero records.

Inbound Syncs

You can add a JQL clause to filter the issues in the sync.

The following streams are supported:

• issues

  • issue_worklogs *

  • issue_comments *

  • issue_links

  • issue_watchers *

• permissions

• users

• issue_types

• issue_link_types

• group_users

• groups

• project_categories

• status_categories

• statuses

• resolutions

• priorities

• agile_boards

• projects

*Please note that selecting these child streams of issues may add significant overhead to the initial sync, as these related objects often need to be fetched by individual issue.

Outbound Syncs

You can sync outbound to the following objects:

• Issues

You can use the Create or Upsert sync strategies to create and/or edit Jira issues.

When linking to other objects like Assignee, Project, Reporter, Issue Type etc, the Jira API uses various combinations of id, name, key to reference these. The Omnata field mapper will name the target fields accordingly. For example, mapping to "Assignee Account ID" from a column containing an account id will link the appropriate assignee. Similarly, mapping to "Issue Type Name" from a column containing the name of a valid issue type, will link to that issue type.

Functions

JQL_QUERY

Executes a JQL query and returns a specific page of results.

Parameters:

• CONNECTION_SLUG (VARCHAR): The slug of the connection to query

• QUERY (VARCHAR): The JQL query

• START_INDEX (INT): The offset to return, use 0 to start from the beginning

• RECORD_LIMIT (INT) The number of records to return, starting from the offset

Examples:

select RECORD
from table(OMNATA_JIRA_PLUGIN.UDFS.JQL_QUERY(
                'my-jira-connection',
                'project=KAN AND updated > -1d',
                0,
                50));