Atlassian: Check issues against JQL

Atlassian issueSearch.matchIssues: arguments, response, policy and SDK examples.

Operation atlassian.matchissues

Provider route: POST /{cloudId}/rest/api/3/jql/match. 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["issueSearch"]["matchIssues"]>[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.issueSearch.matchIssues(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.issue_search.match_issues(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}$
`body`	Model	Required within parent	Expand Check issues against JQL — request body — body

Referenced models: Check issues against JQL — 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 Check issues against JQL — response body

Referenced models: Check issues against JQL — response body

Schemas

Check issues against JQL — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	List of issues and JQL queries. Additional keys: not allowed
`issueIds`	array	Required within parent	A list of up to 50 issue IDs. Unique items: true
`issueIds[]`	integer	Each item	A list of up to 50 issue IDs. Format: int64
`jqls`	array	Required within parent	A list of up to 10 JQL queries.
`jqls[]`	string	Each item	A list of up to 10 JQL queries.

Check issues against JQL — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A list of matched issues or errors for each JQL query, in the order the JQL queries were passed.
`matches`	JSON	Optional
`matches (anyOf 1)`	array	Alternative
`matches (anyOf 1)[]`	Model	Each item	Expand Check issues against JQL — response body — matches array item
`matches (anyOf 2)`	null	Alternative

Referenced models: Check issues against JQL — response body — matches array item

Check issues against JQL — response body — matches array item

Field	Type	Presence	Description and constraints
`$`	object	Root	A list of the issues matched to a JQL query or details of errors encountered during matching.
`errors`	JSON	Optional
`errors (anyOf 1)`	array	Alternative	A list of errors. Unique items: true
`errors (anyOf 1)[]`	string	Each item	A list of errors.
`errors (anyOf 2)`	null	Alternative
`matchedIssues`	JSON	Optional
`matchedIssues (anyOf 1)`	array	Alternative	A list of issue IDs. Unique items: true
`matchedIssues (anyOf 1)[]`	JSON	Each item
`matchedIssues (anyOf 1)[] (anyOf 1)`	integer	Alternative	A list of issue IDs. Format: int64
`matchedIssues (anyOf 1)[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`matchedIssues (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.matchissues. Catalog operation: matchissues. 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-work"]

Official provider source

Report an issue with this page