Atlassian: Get field reference data (POST)

← Jql operations · Get started

Operation atlassian.getautocompletepost

Provider route: POST /{cloudId}/rest/api/3/jql/autocompletedata. 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["jql"]["getAutoCompletePost"]>[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.jql.getAutoCompletePost(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.jql.get_auto_complete_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 Get field reference data (POST) — request body — body

Referenced models: Get field reference data (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 Get field reference data (GET) — response body

Referenced models: Get field reference data (GET) — response body

Schemas

Get field reference data (GET) — response body

Field	Type	Presence	Description and constraints
$	object	Root	Lists of JQL reference data.
jqlReservedWords	JSON	Optional
jqlReservedWords (anyOf 1)	array	Alternative	List of JQL query reserved words.
jqlReservedWords (anyOf 1)[]	string	Each item
jqlReservedWords (anyOf 2)	null	Alternative
visibleFieldNames	JSON	Optional
visibleFieldNames (anyOf 1)	array	Alternative	List of fields usable in JQL queries.
visibleFieldNames (anyOf 1)[]	Model	Each item	Expand Get field reference data (GET) — response body — visible Field Names List of fields usable in JQL queries item
visibleFieldNames (anyOf 2)	null	Alternative
visibleFunctionNames	JSON	Optional
visibleFunctionNames (anyOf 1)	array	Alternative	List of functions usable in JQL queries.
visibleFunctionNames (anyOf 1)[]	Model	Each item	Expand Get field reference data (GET) — response body — visible Function Names List of functions usable in JQL queries item
visibleFunctionNames (anyOf 2)	null	Alternative

Referenced models: Get field reference data (GET) — response body — visible Field Names List of fields usable in JQL queries item, Get field reference data (GET) — response body — visible Function Names List of functions usable in JQL queries item

Get field reference data (POST) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Details of how to filter and list search auto complete information. Additional keys: not allowed
includeCollapsedFields	boolean	Optional	Include collapsed fields for fields that have non-unique names. Default: false
projectIds	array	Optional	List of project IDs used to filter the visible field details returned.
projectIds[]	integer	Each item	Format: int64

Get field reference data (GET) — response body — visible Field Names List of fields usable in JQL queries item

Field	Type	Presence	Description and constraints
$	object	Root	Details of a field that can be used in advanced searches.
auto	JSON	Optional
auto (anyOf 1)	string	Alternative	Whether the field provide auto-complete suggestions. Known values: true, false
auto (anyOf 2)	null	Alternative
cfid	JSON	Optional
cfid (anyOf 1)	string	Alternative	If the item is a custom field, the ID of the custom field.
cfid (anyOf 2)	null	Alternative
deprecated	JSON	Optional
deprecated (anyOf 1)	string	Alternative	Whether this field has been deprecated. Known values: true, false
deprecated (anyOf 2)	null	Alternative
deprecatedSearcherKey	JSON	Optional
deprecatedSearcherKey (anyOf 1)	string	Alternative	The searcher key of the field, only passed when the field is deprecated.
deprecatedSearcherKey (anyOf 2)	null	Alternative
displayName	JSON	Optional
displayName (anyOf 1)	string	Alternative	The display name contains the following: * for system fields, the field name. For example, `Summary`. * for collapsed custom fields, the field name followed by a hyphen and then the field name and field type. For example, `Component - Component[Dropdown]`. * for other custom fields, the field name followed by a hyphen and then the custom field ID. For example, `Component - cf[10061]`.
displayName (anyOf 2)	null	Alternative
operators	JSON	Optional
operators (anyOf 1)	array	Alternative	The valid search operators for the field.
operators (anyOf 1)[]	string	Each item
operators (anyOf 2)	null	Alternative
orderable	JSON	Optional
orderable (anyOf 1)	string	Alternative	Whether the field can be used in a query's `ORDER BY` clause. Known values: true, false
orderable (anyOf 2)	null	Alternative
searchable	JSON	Optional
searchable (anyOf 1)	string	Alternative	Whether the content of this field can be searched. Known values: true, false
searchable (anyOf 2)	null	Alternative
types	JSON	Optional
types (anyOf 1)	array	Alternative	The data types of items in the field.
types (anyOf 1)[]	string	Each item
types (anyOf 2)	null	Alternative
value	JSON	Optional
value (anyOf 1)	string	Alternative	The field identifier.
value (anyOf 2)	null	Alternative

Get field reference data (GET) — response body — visible Function Names List of functions usable in JQL queries item

Field	Type	Presence	Description and constraints
$	object	Root	Details of functions that can be used in advanced searches.
displayName	JSON	Optional
displayName (anyOf 1)	string	Alternative	The display name of the function.
displayName (anyOf 2)	null	Alternative
isList	JSON	Optional
isList (anyOf 1)	string	Alternative	Whether the function can take a list of arguments. Known values: true, false
isList (anyOf 2)	null	Alternative
supportsListAndSingleValueOperators	JSON	Optional
supportsListAndSingleValueOperators (anyOf 1)	string	Alternative	Whether the function supports both single and list value operators. Known values: true, false
supportsListAndSingleValueOperators (anyOf 2)	null	Alternative
types	JSON	Optional
types (anyOf 1)	array	Alternative	The data types returned by the function.
types (anyOf 1)[]	string	Each item
types (anyOf 2)	null	Alternative
value	JSON	Optional
value (anyOf 1)	string	Alternative	The function identifier.
value (anyOf 2)	null	Alternative

Policy, approvals and errors

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