Atlassian: Currently being removed Evaluate Jira expression

← Jira expressions operations · Get started

Operation atlassian.evaluatejiraexpression

Provider route: POST /{cloudId}/rest/api/3/expression/eval. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["jiraExpressions"]["evaluateJiraExpression"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.jiraExpressions.evaluateJiraExpression(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.jira_expressions.evaluate_jira_expression(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.cloudId	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
query	object	Optional	Additional keys: not allowed
query.expand	string	Optional
body	Model	Required within parent	Expand Currently being removed Evaluate Jira expression — request body — body

Referenced models: Currently being removed Evaluate Jira expression — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Currently being removed Evaluate Jira expression — response body

Referenced models: Currently being removed Evaluate Jira expression — response body

Schemas

7 more schemas are linked from the tables above, on the schema pages.

Currently being removed Evaluate Jira expression — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
context	Model	Optional	Expand Currently being removed Evaluate Jira expression — request body — body context The context in which the Jira expression is evaluated.
expression	string	Required within parent	The Jira expression to evaluate.

Referenced models: Currently being removed Evaluate Jira expression — request body — body context

Currently being removed Evaluate Jira expression — response body

Field	Type	Presence	Description and constraints
$	object	Root	The result of evaluating a Jira expression.
meta	JSON	Optional
meta (anyOf 1)	Model	Alternative	Expand Currently being removed Evaluate Jira expression — response body — meta complexity, issues Contains various characteristics of the performed expression evaluation.
meta (anyOf 2)	null	Alternative
value	JSON	Optional
value (anyOf 1)	JSON	Alternative	The value of the evaluated expression. It may be a primitive JSON value or a Jira REST API object. (Some expressions do not produce any meaningful results—for example, an expression that returns a lambda function—if that's the case a simple string representation is returned. These string representations should not be relied upon and may change without notice.)
value (anyOf 2)	null	Alternative

Referenced models: Currently being removed Evaluate Jira expression — response body — meta complexity, issues

Currently being removed Evaluate Jira expression — request body — body context

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
board	integer	Optional	The ID of the board that is available under the `board` variable when evaluating the expression. Format: int64
custom	array	Optional	Custom context variables and their types. These variable types are available for use in a custom context: * `user`: A [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user) specified as an Atlassian account ID. * `issue`: An [issue](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#issue) specified by ID or key. All the fields of the issue object are available in the Jira expression. * `json`: A JSON object containing custom content. * `list`: A JSON list of `user`, `issue`, or `json` variable types.
custom[]	Model	Each item	Expand Currently being removed Evaluate Jira expression — request body — body context custom item
customerRequest	integer	Optional	The ID of the customer request that is available under the `customerRequest` variable when evaluating the expression. This is the same as the ID of the underlying Jira issue, but the customer request context variable will have a different type. Format: int64
issue	Model	Optional	Expand Currently being removed Evaluate Jira expression — request body — body context issue The issue that is available under the `issue` variable when evaluating the expression.
issues	Model	Optional	Expand Currently being removed Evaluate Jira expression — request body — body context issues The collection of issues that is available under the `issues` variable when evaluating the expression.
project	Model	Optional	Expand Currently being removed Evaluate Jira expression — request body — body context issue The project that is available under the `project` variable when evaluating the expression.
serviceDesk	integer	Optional	The ID of the service desk that is available under the `serviceDesk` variable when evaluating the expression. Format: int64
sprint	integer	Optional	The ID of the sprint that is available under the `sprint` variable when evaluating the expression. Format: int64

Referenced models: Currently being removed Evaluate Jira expression — request body — body context custom item, Currently being removed Evaluate Jira expression — request body — body context issue, Currently being removed Evaluate Jira expression — request body — body context issues

Currently being removed Evaluate Jira expression — response body — meta complexity, issues

Field	Type	Presence	Description and constraints
$	object	Root
complexity	JSON	Optional
complexity (anyOf 1)	Model	Alternative	Expand Currently being removed Evaluate Jira expression — response body — meta complexity, issues complexity beans, expensive Operations, primitive Values, steps Contains information about the expression complexity. For example, the number of steps it took to evaluate the expression.
complexity (anyOf 2)	null	Alternative
issues	JSON	Optional
issues (anyOf 1)	Model	Alternative	Expand Currently being removed Evaluate Jira expression — response body — meta complexity, issues issues Meta data describing the `issues` context variable Contains information about the `issues` variable in the context. For example, is the issues were loaded with JQL, information about the page will be included here.
issues (anyOf 2)	null	Alternative

Referenced models: Currently being removed Evaluate Jira expression — response body — meta complexity, issues issues Meta data describing the `issues` context variable, Currently being removed Evaluate Jira expression — response body — meta complexity, issues complexity beans, expensive Operations, primitive Values, steps

Currently being removed Evaluate Jira expression — request body — body context custom item

Field	Type	Presence	Description and constraints
$	object	Root	discriminator: {"mapping": {"issue": "#/components/schemas/IssueContextVariable", "json": "#/components/schemas/JsonContextVariable", "user": "#/components/schemas/UserContextVariable"}, "propertyName": "type"} Additional keys: not allowed
type	string	Required within parent	Type of custom context variable.
$ (oneOf 1)	Model	Alternative	Expand Currently being removed Evaluate Jira expression — request body — body context custom item type user
$ (oneOf 2)	Model	Alternative	Expand Currently being removed Evaluate Jira expression — request body — body context custom item type issue
$ (oneOf 3)	Model	Alternative	Expand Currently being removed Evaluate Jira expression — request body — body context custom item type json

Referenced models: Currently being removed Evaluate Jira expression — request body — body context custom item type issue, Currently being removed Evaluate Jira expression — request body — body context custom item type json, Currently being removed Evaluate Jira expression — request body — body context custom item type user

Currently being removed Evaluate Jira expression — request body — body context issue

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
id	integer	Optional	The ID of the referenced item. Format: int64
key	string	Optional	The key of the referenced item.

Currently being removed Evaluate Jira expression — request body — body context issues

Field	Type	Presence	Description and constraints
$	object	Root	The JQL specifying the issues available in the evaluated Jira expression under the `issues` context variable. Additional keys: not allowed
jql	Model	Optional	Expand Currently being removed Evaluate Jira expression — request body — body context issues jql The JQL query that specifies the set of issues available in the Jira expression.

Referenced models: Currently being removed Evaluate Jira expression — request body — body context issues jql

Currently being removed Evaluate Jira expression — response body — meta complexity, issues issues Meta data describing the `issues` context variable

Field	Type	Presence	Description and constraints
$	object	Root	Meta data describing the `issues` context variable.
jql	JSON	Optional
jql (anyOf 1)	Model	Alternative	Expand Currently being removed Evaluate Jira expression — response body — meta complexity, issues issues Meta data describing the `issues` context variable jql count, max Results, start At, total Count, validation Warnings
jql (anyOf 2)	null	Alternative

Referenced models: Currently being removed Evaluate Jira expression — response body — meta complexity, issues issues Meta data describing the `issues` context variable jql count, max Results, start At, total Count, validation Warnings

Policy, approvals and errors

SDK function policy ID: atlassian.evaluatejiraexpression. Catalog operation: evaluatejiraexpression. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["read:jira-user", "read:jira-work"]

Official provider source