Atlassian: Get field configuration issue type items

← Issue field configurations operations · Get started

Operation atlassian.getfieldconfigurationschememappings

Provider route: GET /{cloudId}/rest/api/3/fieldconfigurationscheme/mapping. 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["issueFieldConfigurations"]["getFieldConfigurationSchemeMappings"]>[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.issueFieldConfigurations.getFieldConfigurationSchemeMappings(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_field_configurations.get_field_configuration_scheme_mappings(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.startAt	integer	Optional	Default: 0 Format: int64
query.maxResults	integer	Optional	Default: 50 Format: int32
query.fieldConfigurationSchemeId	array	Optional	Maximum items: 50 Minimum items: 1 Unique items: true
query.fieldConfigurationSchemeId[]	integer	Each item	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 field configuration issue type items — response body

Referenced models: Get field configuration issue type items — response body

Schemas

Get field configuration issue type items — 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 field configuration issue type items — response body — values The list of items item
values (anyOf 2)	null	Alternative

Referenced models: Get field configuration issue type items — response body — values The list of items item

Get field configuration issue type items — response body — values The list of items item

Field	Type	Presence	Description and constraints
$	object	Root	The field configuration for an issue type.
fieldConfigurationId	JSON	Optional
fieldConfigurationId (anyOf 1)	string	Alternative	The ID of the field configuration.
fieldConfigurationId (anyOf 2)	null	Alternative
fieldConfigurationSchemeId	JSON	Optional
fieldConfigurationSchemeId (anyOf 1)	string	Alternative	The ID of the field configuration scheme.
fieldConfigurationSchemeId (anyOf 2)	null	Alternative
issueTypeId	JSON	Optional
issueTypeId (anyOf 1)	string	Alternative	The ID of the issue type or *default*. When set to *default* this field configuration issue type item applies to all issue types without a field configuration.
issueTypeId (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.getfieldconfigurationschememappings. Catalog operation: getfieldconfigurationschememappings. 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: ["manage:jira-configuration"]

Official provider source