Atlassian: Get visible issue field options

Atlassian issueCustomFieldOptionsApps.getVisibleIssueFieldOptions: arguments, response, policy and SDK examples.

← Issue custom field options apps operations · Get started

Operation atlassian.getvisibleissuefieldoptions

Provider route: GET /{cloudId}/rest/api/3/field/{fieldKey}/option/suggestions/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["issueCustomFieldOptionsApps"]["getVisibleIssueFieldOptions"]>[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.issueCustomFieldOptionsApps.getVisibleIssueFieldOptions(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_custom_field_options_apps.get_visible_issue_field_options(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}$
`path.fieldKey`	string	Required within parent
`query`	object	Optional	Additional keys: not allowed
`query.startAt`	integer	Optional	Default: 0 Format: int64
`query.maxResults`	integer	Optional	Default: 50 Format: int32
`query.projectId`	integer	Optional	Format: int64

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 all issue field options — response body

Referenced models: Get all issue field options — response body

Schemas

Get all issue field options — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A page of items.
`isLast`	JSON	Optional
`isLast (anyOf 1)`	boolean	Alternative	Whether this is the last page. Read only: true
`isLast (anyOf 2)`	null	Alternative
`maxResults`	JSON	Optional
`maxResults (anyOf 1)`	JSON	Alternative
`maxResults (anyOf 1) (anyOf 1)`	integer	Alternative	The maximum number of items that could be returned. 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
`nextPage`	JSON	Optional
`nextPage (anyOf 1)`	string	Alternative	If there is another page of results, the URL of the next page. Format: uri Read only: true
`nextPage (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the page. Format: uri Read only: true
`self (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. Format: int64 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 items returned. Format: int64 Read only: true
`total (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`total (anyOf 2)`	null	Alternative
`values`	JSON	Optional
`values (anyOf 1)`	array	Alternative	The list of items. Read only: true
`values (anyOf 1)[]`	Model	Each item	Expand Get issue field option — response body
`values (anyOf 2)`	null	Alternative

Referenced models: Get issue field option — response body

Get issue field option — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of the options for a select list issue field.
`config`	JSON	Optional
`config (anyOf 1)`	Model	Alternative	Expand Get issue field option — response body — config Details of the projects the option is available in
`config (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	JSON	Alternative
`id (anyOf 1) (anyOf 1)`	integer	Alternative	The unique identifier for the option. This is only unique within the select field's set of options. Format: int64
`id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id (anyOf 2)`	null	Alternative
`properties`	JSON	Optional
`properties (anyOf 1)`	object	Alternative	The properties of the object, as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see [Issue Field Option Property Index](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/)) are defined in the descriptor for the issue field module. Additional keys: see wildcard field
`properties (anyOf 1).*`	JSON	Additional keys
`properties (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	string	Alternative	The option's name, which is displayed in Jira.
`value (anyOf 2)`	null	Alternative

Referenced models: Get issue field option — response body — config Details of the projects the option is available in

Get issue field option — response body — config Details of the projects the option is available in

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of the projects the option is available in.
`attributes`	JSON	Optional
`attributes (anyOf 1)`	array	Alternative	DEPRECATED Unique items: true
`attributes (anyOf 1)[]`	string	Each item	Known values: notSelectable, defaultValue
`attributes (anyOf 2)`	null	Alternative
`scope`	JSON	Optional
`scope (anyOf 1)`	Model	Alternative	Expand Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2 Defines the projects that the option is available in. If the scope is not defined, then the option is available in all projects.
`scope (anyOf 2)`	null	Alternative

Referenced models: Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2

Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2

Field	Type	Presence	Description and constraints
`$`	object	Root
`global`	JSON	Optional
`global (anyOf 1)`	Model	Alternative	Expand Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2 global attributes Defines the behavior of the option within the global context. If this property is set, even if set to an empty object, then the option is available in all projects.
`global (anyOf 2)`	null	Alternative
`projects`	JSON	Optional
`projects (anyOf 1)`	array	Alternative	DEPRECATED Unique items: true
`projects (anyOf 1)[]`	JSON	Each item
`projects (anyOf 1)[] (anyOf 1)`	integer	Alternative	Format: int64
`projects (anyOf 1)[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`projects (anyOf 2)`	null	Alternative
`projects2`	JSON	Optional
`projects2 (anyOf 1)`	array	Alternative	Defines the projects in which the option is available and the behavior of the option within each project. Specify one object per project. The behavior of the option in a project context overrides the behavior in the global context. Unique items: true
`projects2 (anyOf 1)[]`	Model	Each item	Expand Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2 projects2 array item
`projects2 (anyOf 2)`	null	Alternative

Referenced models: Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2 global attributes, Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2 projects2 array item

Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2 global attributes

Field	Type	Presence	Description and constraints
`$`	object	Root
`attributes`	JSON	Optional
`attributes (anyOf 1)`	array	Alternative	Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default. Unique items: true
`attributes (anyOf 1)[]`	string	Each item	Known values: notSelectable, defaultValue
`attributes (anyOf 2)`	null	Alternative

Get issue field option — response body — config Details of the projects the option is available in scope global, projects, projects2 projects2 array item

Field	Type	Presence	Description and constraints
`$`	object	Root
`attributes`	JSON	Optional
`attributes (anyOf 1)`	array	Alternative	Defines the behavior of the option in the project.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default. Unique items: true
`attributes (anyOf 1)[]`	string	Each item	Known values: notSelectable, defaultValue
`attributes (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	JSON	Alternative
`id (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the project that the option's behavior applies to. Format: int64
`id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id (anyOf 2)`	null	Alternative

Policy, approvals and errors

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