Skip to main content

Get help for ARIS Process Mining functions and services

HTTP extraction from Jira Cloud

Use the following settings to configure the connection and HTTP extraction for a Jira Cloud system.

Disclaimer

Any references to third-party applications in this documentation are provided solely for informational purposes. Such references do not constitute any contractual commitment, representation, or warranty of any kind. The information is provided “as is,” and no guarantee is made as to the accuracy, completeness, or currentness of information relating to third-party applications.

Connection

REST-API base URL

The typical base URL for Jira Cloud REST APIs follows this format.

https://<your-domain>.atlassian.net

Key points:

  • Replace <your-domain> with your Jira Cloud instance domain.

Example

https://<your-domain>.atlassian.net/rest/api/3/

Test-connection resources

  • GET /rest/api/3/myself

    Confirms authentication and connectivity by returning details of the current user.

  • GET /rest/api/3/serverInfo

    Returns Jira instance information.

Supported authentication methods

  • OAuth 2.0 (3LO)

    Recommended for user-based access.

    Client credentials flow:

    • Only for service accounts in enterprise setups.

    • Limited scope; not for standard Jira issue APIs.

  • API Token + Basic Auth

    Username: email address

    Password: API token

  • Bearer token

    Used in OAuth flows.

Permissions or scopes

Scopes define access to specific resources.

Examples

Scope / Permission

Purpose

read:jira-user

Read user information

read:jira-work

Read issues and projects

write:jira-work

Create or update issues

offline_access

Refresh tokens without user interaction

Extraction

Jira Cloud API resource endpoints

Note that each sample response structure is simplified to show the main fields typically returned by Jira Cloud. Actual responses may include more nested objects and links.

Resource type

Endpoint

Method

Required Parameters/ Request body

Sample Response

Issues

/rest/api/2/search/jql

POST

{
"fields": [
"key"
],
"jql": "project=PROJECT_NAME"
}

{
"isLast" : false,
"nextPageToken" : "",
"issues" : [ {
"expand" : "",
"self" : "",
"id" : "",
"key" : ""
} ]
}

Pagination

  • Type: Token-based pagination pattern or cursor-based pagination

  • Token property: nextPageToken

  • Response property to stop pagination: isLast

Limitations and known issues

Rate limits

  • Burst: Limited by Atlassian’s API throttling policy. For more information on rate limits, visit the Atlassian Developer website.

Data freshness

  • Real-time for most resources.

Unsupported features

  • No direct bulk export via REST from Jira Cloud for large data sets. For more information on data export from Jira Cloud, visit the Atlassian Support website.

Known bugs or API instabilities

  • Some fields may not appear if not included in fields parameter in /search.

  • See also the jira issue tracker: https://jira.atlassian.com/issues/