getPrecomputations
Get precomputations (apps)
Details
- Method:
GET - Path:
/rest/api/3/jql/function/computation - Operation ID:
getPrecomputations
Parameters
{
"functionKey": {
"description": "The function key in format:\n\n * Forge: `ari:cloud:ecosystem::extension/[App ID]/[Environment ID]/static/[Function key from manifest]`\n * Connect: `[App key]__[Module key]`",
"required": false,
"location": "query",
"type": "array"
},
"startAt": {
"description": "The index of the first item to return in a page of results (page offset).",
"required": false,
"location": "query",
"type": "integer",
"format": "int64"
},
"maxResults": {
"description": "The maximum number of items to return per page.",
"required": false,
"location": "query",
"type": "integer",
"format": "int32"
},
"orderBy": {
"description": "[Order](#ordering) the results by a field:\n\n * `functionKey` Sorts by the functionKey.\n * `used` Sorts by the used timestamp.\n * `created` Sorts by the created timestamp.\n * `updated` Sorts by the updated timestamp.",
"required": false,
"location": "query",
"type": "string"
}
}Response Schema
{
"additionalProperties": false,
"description": "A page of items.",
"properties": {
"isLast": {
"description": "Whether this is the last page.",
"readOnly": true,
"type": "boolean"
},
"maxResults": {
"description": "The maximum number of items that could be returned.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"nextPage": {
"description": "If there is another page of results, the URL of the next page.",
"format": "uri",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the page.",
"format": "uri",
"readOnly": true,
"type": "string"
},
"startAt": {
"description": "The index of the first item returned.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"total": {
"description": "The number of items returned.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"values": {
"description": "The list of items.",
"items": {
"additionalProperties": false,
"description": "Jql function precomputation.",
"properties": {
"arguments": {
"description": "The list of arguments function was invoked with.",
"items": {
"readOnly": true,
"type": "string"
},
"readOnly": true,
"type": "array"
},
"created": {
"description": "The timestamp of the precomputation creation.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"error": {
"description": "The error message to be displayed to the user.",
"readOnly": true,
"type": "string"
},
"field": {
"description": "The field the function was executed against.",
"readOnly": true,
"type": "string"
},
"functionKey": {
"description": "The function key.",
"readOnly": true,
"type": "string"
},
"functionName": {
"description": "The name of the function.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The id of the precomputation.",
"readOnly": true,
"type": "string"
},
"operator": {
"description": "The operator in context of which function was executed.",
"readOnly": true,
"type": "string"
},
"updated": {
"description": "The timestamp of the precomputation last update.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"used": {
"description": "The timestamp of the precomputation last usage.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"value": {
"description": "The JQL fragment stored as the precomputation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('getPrecomputations', {
# Add required parameters here
})