Atlassian: Get field parameters

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

← Field schemes operations · Get started

Operation atlassian.getfieldassociationschemeitemparameters

Provider route: GET /{cloudId}/rest/api/3/config/fieldschemes/{id}/fields/{fieldId}/parameters. 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"]["getFieldAssociationSchemeItemParameters"]>[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.getFieldAssociationSchemeItemParameters(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_scheme_item_parameters(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.id`	integer	Required within parent	Format: int64
`path.fieldId`	string	Required within parent

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

Referenced models: Get field parameters — response body

Schemas

Get field parameters — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Response object for getting field association parameters.
`fieldId`	JSON	Optional
`fieldId (anyOf 1)`	string	Alternative
`fieldId (anyOf 2)`	null	Alternative
`parameters`	JSON	Optional
`parameters (anyOf 1)`	Model	Alternative	Expand Get field parameters — response body — parameters description, is Required, renderer Type
`parameters (anyOf 2)`	null	Alternative
`workTypeParameters`	JSON	Optional
`workTypeParameters (anyOf 1)`	array	Alternative
`workTypeParameters (anyOf 1)[]`	Model	Each item	Expand Get field parameters — response body — work Type Parameters array item
`workTypeParameters (anyOf 2)`	null	Alternative

Referenced models: Get field parameters — response body — parameters description, is Required, renderer Type, Get field parameters — response body — work Type Parameters array item

Get field parameters — response body — parameters description, is Required, renderer Type

Field	Type	Presence
`$`	object	Root
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`isRequired`	JSON	Optional
`isRequired (anyOf 1)`	boolean	Alternative
`isRequired (anyOf 2)`	null	Alternative
`rendererType`	JSON	Optional
`rendererType (anyOf 1)`	string	Alternative
`rendererType (anyOf 2)`	null	Alternative

Get field parameters — response body — work Type Parameters array item

Field	Type	Presence	Description and constraints
`$`	object	Root
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`isRequired`	JSON	Optional
`isRequired (anyOf 1)`	boolean	Alternative
`isRequired (anyOf 2)`	null	Alternative
`rendererType`	JSON	Optional
`rendererType (anyOf 1)`	string	Alternative
`rendererType (anyOf 2)`	null	Alternative
`workTypeId`	JSON	Optional
`workTypeId (anyOf 1)`	JSON	Alternative
`workTypeId (anyOf 1) (anyOf 1)`	integer	Alternative	Format: int64
`workTypeId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`workTypeId (anyOf 2)`	null	Alternative

Policy, approvals and errors

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