Atlassian: Currently being removed Search for issues using JQL (POST)

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

Operation atlassian.searchforissuesusingjqlpost

Provider route: POST /{cloudId}/rest/api/3/search. 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"]["searchForIssuesUsingJqlPost"]>[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.searchForIssuesUsingJqlPost(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.search_for_issues_using_jql_post(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 Currently being removed Search for issues using JQL (POST) — request body — body

Referenced models: Currently being removed Search for issues using JQL (POST) — 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 Search for issues using JQL (GET) — response body

Referenced models: Currently being removed Search for issues using JQL (GET) — response body

Schemas

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

Currently being removed Search for issues using JQL (GET) — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	The result of a JQL search.
`expand`	JSON	Optional
`expand (anyOf 1)`	string	Alternative	Expand options that include additional search result details in the response. Read only: true
`expand (anyOf 2)`	null	Alternative
`issues`	JSON	Optional
`issues (anyOf 1)`	array	Alternative	The list of issues found by the search. Read only: true
`issues (anyOf 1)[]`	Model	Each item	Expand Get issue — response body
`issues (anyOf 2)`	null	Alternative
`maxResults`	JSON	Optional
`maxResults (anyOf 1)`	JSON	Alternative
`maxResults (anyOf 1) (anyOf 1)`	integer	Alternative	The maximum number of results that could be on the page. Format: int32 Read only: true
`maxResults (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`maxResults (anyOf 2)`	null	Alternative
`names`	JSON	Optional
`names (anyOf 1)`	object	Alternative	The ID and name of each field in the search results. Read only: true Additional keys: see wildcard field
`names (anyOf 1).*`	string	Additional keys	Read only: true
`names (anyOf 2)`	null	Alternative
`schema`	JSON	Optional
`schema (anyOf 1)`	object	Alternative	The schema describing the field types in the search results. Read only: true Additional keys: see wildcard field
`schema (anyOf 1).*`	Model	Additional keys	Expand Create custom field — response body — schema The schema of a field
`schema (anyOf 2)`	null	Alternative
`startAt`	JSON	Optional
`startAt (anyOf 1)`	JSON	Alternative
`startAt (anyOf 1) (anyOf 1)`	integer	Alternative	The index of the first item returned on the page. Format: int32 Read only: true
`startAt (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`startAt (anyOf 2)`	null	Alternative
`total`	JSON	Optional
`total (anyOf 1)`	JSON	Alternative
`total (anyOf 1) (anyOf 1)`	integer	Alternative	The number of results on the page. Format: int32 Read only: true
`total (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`total (anyOf 2)`	null	Alternative
`warningMessages`	JSON	Optional
`warningMessages (anyOf 1)`	array	Alternative	Any warnings related to the JQL query. Read only: true
`warningMessages (anyOf 1)[]`	string	Each item	Read only: true
`warningMessages (anyOf 2)`	null	Alternative

Referenced models: Get issue — response body, Create custom field — response body — schema The schema of a field

Currently being removed Search for issues using JQL (POST) — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`expand`	array	Optional	Use [expand](#expansion) to include additional information about issues in the response. Note that, unlike the majority of instances where `expand` is specified, `expand` is defined as a list of values. The expand options are: * `renderedFields` Returns field values rendered in HTML format. * `names` Returns the display name of each field. * `schema` Returns the schema describing a field type. * `transitions` Returns all possible transitions for the issue. * `operations` Returns all possible operations for the issue. * `editmeta` Returns information about how each field can be edited. * `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.
`expand[]`	string	Each item
`fields`	array	Optional	A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: * `all` Returns all fields. `navigable` Returns navigable fields. Any issue field, prefixed with a minus to exclude. The default is `navigable`. Examples: `summary,comment` Returns the summary and comments fields only. * `-description` Returns all navigable (default) fields except description. * `*all,-comment` Returns all fields except comments. Multiple `fields` parameters can be included in a request. Note: All navigable fields are returned by default. This differs from [GET issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields.
`fields[]`	string	Each item
`fieldsByKeys`	boolean	Optional	Reference fields by their key (rather than ID). The default is `false`.
`jql`	string	Optional	A [JQL](https://confluence.atlassian.com/x/egORLQ) expression.
`maxResults`	integer	Optional	The maximum number of items to return per page. Default: 50 Format: int32
`properties`	array	Optional	A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.
`properties[]`	string	Each item
`startAt`	integer	Optional	The index of the first item to return in the page of results (page offset). The base index is `0`. Format: int32
`validateQuery`	string	Optional	Determines how to validate the JQL query and treat the validation results. Supported values: * `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings). * `warn` Returns all errors as warnings. * `none` No validation is performed. * `true` Deprecated A legacy synonym for `strict`. * `false` Deprecated A legacy synonym for `warn`. The default is `strict`. Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value. One of: strict, warn, none, true, false

Create custom field — response body — schema The schema of a field

Field	Type	Presence	Description and constraints
`$`	object	Root	The schema of a field.
`configuration`	JSON	Optional
`configuration (anyOf 1)`	object	Alternative	If the field is a custom field, the configuration of the field. Read only: true Additional keys: see wildcard field
`configuration (anyOf 1).*`	JSON	Additional keys	Read only: true
`configuration (anyOf 2)`	null	Alternative
`custom`	JSON	Optional
`custom (anyOf 1)`	string	Alternative	If the field is a custom field, the URI of the field. Read only: true
`custom (anyOf 2)`	null	Alternative
`customId`	JSON	Optional
`customId (anyOf 1)`	JSON	Alternative
`customId (anyOf 1) (anyOf 1)`	integer	Alternative	If the field is a custom field, the custom ID of the field. Format: int64 Read only: true
`customId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`customId (anyOf 2)`	null	Alternative
`items`	JSON	Optional
`items (anyOf 1)`	string	Alternative	When the data type is an array, the name of the field items within the array. Read only: true
`items (anyOf 2)`	null	Alternative
`system`	JSON	Optional
`system (anyOf 1)`	string	Alternative	If the field is a system field, the name of the field. Read only: true
`system (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The data type of the field. Read only: true
`type (anyOf 2)`	null	Alternative

Get issue — response body — fields To Include actually Included, excluded, included

Field	Type	Presence	Description and constraints
`$`	object	Root
`actuallyIncluded`	JSON	Optional
`actuallyIncluded (anyOf 1)`	array	Alternative	Unique items: true
`actuallyIncluded (anyOf 1)[]`	string	Each item
`actuallyIncluded (anyOf 2)`	null	Alternative
`excluded`	JSON	Optional
`excluded (anyOf 1)`	array	Alternative	Unique items: true
`excluded (anyOf 1)[]`	string	Each item
`excluded (anyOf 2)`	null	Alternative
`included`	JSON	Optional
`included (anyOf 1)`	array	Alternative	Unique items: true
`included (anyOf 1)[]`	string	Each item
`included (anyOf 2)`	null	Alternative

Get edit issue metadata — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A list of editable field details.
`fields`	JSON	Optional
`fields (anyOf 1)`	object	Alternative	Read only: true Additional keys: see wildcard field
`fields (anyOf 1).*`	Model	Additional keys	Expand Get edit issue metadata — response body — fields object value
`fields (anyOf 2)`	null	Alternative

Referenced models: Get edit issue metadata — response body — fields object value

Policy, approvals and errors

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