Skip to content

Function: getPrecomputations() ​

ts
function getPrecomputations(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;

Defined in: src/cloud/api/jqlFunctionsApps.ts:27

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.

Parameters ​

ParameterTypeDescription
clientClient-
parameters?{ functionKey?: string[]; maxResults?: number; orderBy?: | string & object | "created" | "updated" | "functionKey" | "used" | "-created" | "+created" | "-functionKey" | "+functionKey" | "-used" | "+used" | "-updated" | "+updated"; startAt?: number; }-
parameters.functionKey?string[]The function key in format: - Forge: ari:cloud:ecosystem::extension/[App ID]/[Environment ID]/static/[Function key from manifest] - Connect: [App key]__[Module key]
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.orderBy?| string & object | "created" | "updated" | "functionKey" | "used" | "-created" | "+created" | "-functionKey" | "+functionKey" | "-used" | "+used" | "-updated" | "+updated"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.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>