Atlassian: Get field schemes

Atlassian fieldSchemes.getFieldAssociationSchemes: arguments, response, policy and SDK examples.

← Field schemes operations · Get started

Operation atlassian.getfieldassociationschemes

Provider route: GET /{cloudId}/rest/api/3/config/fieldschemes. 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["fieldSchemes"]["getFieldAssociationSchemes"]>[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.fieldSchemes.getFieldAssociationSchemes(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.field_schemes.get_field_association_schemes(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.projectId`	array	Optional
`query.projectId[]`	integer	Each item	Format: int64
`query.query`	string	Optional
`query.startAt`	integer	Optional	Default: 0 Format: int64
`query.maxResults`	integer	Optional	Default: 50 Format: int32 Maximum: 100

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 schemes — response body

Referenced models: Get field schemes — response body

Schemas

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

Referenced models: Get field schemes — response body — values The list of items item

Get field schemes — response body — values The list of items item

Field	Type	Presence	Description and constraints
`$`	object	Root	Response object for getting a field association scheme.
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`fieldsCount`	JSON	Optional
`fieldsCount (anyOf 1)`	JSON	Alternative
`fieldsCount (anyOf 1) (anyOf 1)`	integer	Alternative	Format: int64
`fieldsCount (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`fieldsCount (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	JSON	Alternative
`id (anyOf 1) (anyOf 1)`	integer	Alternative	Format: int64
`id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id (anyOf 2)`	null	Alternative
`isDefault`	JSON	Optional
`isDefault (anyOf 1)`	boolean	Alternative
`isDefault (anyOf 2)`	null	Alternative
`links`	JSON	Optional
`links (anyOf 1)`	Model	Alternative	Expand Get field scheme — response body — links associations, projects
`links (anyOf 2)`	null	Alternative
`matchedFilters`	JSON	Optional
`matchedFilters (anyOf 1)`	Model	Alternative	Expand Get field schemes — response body — values The list of items item matched Filters project Ids, query
`matchedFilters (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative
`name (anyOf 2)`	null	Alternative

Referenced models: Get field scheme — response body — links associations, projects, Get field schemes — response body — values The list of items item matched Filters project Ids, query

Get field scheme — response body — links associations, projects

Field	Type	Presence
`$`	object	Root
`associations`	JSON	Optional
`associations (anyOf 1)`	string	Alternative
`associations (anyOf 2)`	null	Alternative
`projects`	JSON	Optional
`projects (anyOf 1)`	string	Alternative
`projects (anyOf 2)`	null	Alternative

Get field schemes — response body — values The list of items item matched Filters project Ids, query

Field	Type	Presence	Description and constraints
`$`	object	Root	Matched filters for field association scheme search.
`projectIds`	JSON	Optional
`projectIds (anyOf 1)`	array	Alternative	Unique items: true
`projectIds (anyOf 1)[]`	JSON	Each item
`projectIds (anyOf 1)[] (anyOf 1)`	integer	Alternative	Format: int64
`projectIds (anyOf 1)[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`projectIds (anyOf 2)`	null	Alternative
`query`	JSON	Optional
`query (anyOf 1)`	string	Alternative
`query (anyOf 2)`	null	Alternative

Policy, approvals and errors

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

Report an issue with this page