Atlassian: Get issue picker suggestions

← Issue search operations · Get started

Operation atlassian.getissuepickerresource

Provider route: GET /{cloudId}/rest/api/3/issue/picker. 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"]["getIssuePickerResource"]>[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.getIssuePickerResource(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.get_issue_picker_resource(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.query	string	Optional
query.currentJQL	string	Optional
query.currentIssueKey	string	Optional
query.currentProjectId	string	Optional
query.showSubTasks	boolean	Optional
query.showSubTaskParent	boolean	Optional

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 Get issue picker suggestions — response body

Referenced models: Get issue picker suggestions — response body

Schemas

Get issue picker suggestions — response body

Field	Type	Presence	Description and constraints
$	object	Root	A list of issues suggested for use in auto-completion.
sections	JSON	Optional
sections (anyOf 1)	array	Alternative	A list of issues for an issue type suggested for use in auto-completion. Read only: true
sections (anyOf 1)[]	Model	Each item	Expand Get issue picker suggestions — response body — sections array item
sections (anyOf 2)	null	Alternative

Referenced models: Get issue picker suggestions — response body — sections array item

Get issue picker suggestions — response body — sections array item

Field	Type	Presence	Description and constraints
$	object	Root	A type of issue suggested for use in auto-completion.
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the type of issues suggested for use in auto-completion. Read only: true
id (anyOf 2)	null	Alternative
issues	JSON	Optional
issues (anyOf 1)	array	Alternative	A list of issues suggested for use in auto-completion. Read only: true
issues (anyOf 1)[]	Model	Each item	Expand Get issue picker suggestions — response body — sections array item issues array item
issues (anyOf 2)	null	Alternative
label	JSON	Optional
label (anyOf 1)	string	Alternative	The label of the type of issues suggested for use in auto-completion. Read only: true
label (anyOf 2)	null	Alternative
msg	JSON	Optional
msg (anyOf 1)	string	Alternative	If no issue suggestions are found, returns a message indicating no suggestions were found, Read only: true
msg (anyOf 2)	null	Alternative
sub	JSON	Optional
sub (anyOf 1)	string	Alternative	If issue suggestions are found, returns a message indicating the number of issues suggestions found and returned. Read only: true
sub (anyOf 2)	null	Alternative

Referenced models: Get issue picker suggestions — response body — sections array item issues array item

Get issue picker suggestions — response body — sections array item issues array item

Field	Type	Presence	Description and constraints
$	object	Root	An issue suggested for use in the issue picker auto-completion.
id	JSON	Optional
id (anyOf 1)	JSON	Alternative
id (anyOf 1) (anyOf 1)	integer	Alternative	The ID of the issue. Format: int64 Read only: true
id (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id (anyOf 2)	null	Alternative
img	JSON	Optional
img (anyOf 1)	string	Alternative	The URL of the issue type's avatar. Read only: true
img (anyOf 2)	null	Alternative
key	JSON	Optional
key (anyOf 1)	string	Alternative	The key of the issue. Read only: true
key (anyOf 2)	null	Alternative
keyHtml	JSON	Optional
keyHtml (anyOf 1)	string	Alternative	The key of the issue in HTML format. Read only: true
keyHtml (anyOf 2)	null	Alternative
summary	JSON	Optional
summary (anyOf 1)	string	Alternative	The phrase containing the query string in HTML format, with the string highlighted with HTML bold tags. Read only: true
summary (anyOf 2)	null	Alternative
summaryText	JSON	Optional
summaryText (anyOf 1)	string	Alternative	The phrase containing the query string, as plain text. Read only: true
summaryText (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.getissuepickerresource. Catalog operation: getissuepickerresource. 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