JQL functions (apps)

Get precomputations (apps)

Returns the list of a function's precomputations along with information about when they were created, updated, and last used. Each precomputation has a value - the JQL fragment to replace the custom function clause with.

Permissions required: This API is only accessible to apps and apps can only inspect their own functions.

The new read:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.

get/rest/api/2/jql/function/computation

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/jql/function/computation
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token)

Query parameters

functionKeystring[]

The function key in format:

  • Forge: ari:cloud:ecosystem::extension/[App ID]/[Environment ID]/static/[Function key from manifest]
  • Connect: [App key]__[Module key]
startAtinteger

The index of the first item to return in a page of results (page offset).

maxResultsinteger

The maximum number of items to return per page.

orderBystring

Order the results by a field:

  • functionKey Sorts by the functionKey.
  • used Sorts by the used timestamp.
  • created Sorts by the created timestamp.
  • updated Sorts by the updated timestamp.

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

If there is another page of results, the URL of the next page.

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.

Changes

No recorded changes to this operation across all 26 revisions of this API.