Atlassian: Update field parameters

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

← Field schemes operations · Get started

Operation atlassian.updatefieldassociationschemeitemparameters

Provider route: PUT /{cloudId}/rest/api/3/config/fieldschemes/fields/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"]["updateFieldAssociationSchemeItemParameters"]>[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.updateFieldAssociationSchemeItemParameters(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.update_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}$
`body`	object	Required within parent	Additional keys: see wildcard field
`body.*`	array	Additional keys
`body.*[]`	Model	Each item	Expand Update field parameters — request body — body value item

Referenced models: Update field parameters — request body — body value item

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
`$`	JSON	Root
`$ (anyOf 1)`	JSON	Alternative
`$ (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Update field parameters — response body — value results
`$ (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Update field parameters — response body — value results
`$ (anyOf 2)`	null	Alternative

Referenced models: Update field parameters — response body — value results

Schemas

Update field parameters — response body — value results

Field	Type	Presence	Description and constraints
`$`	object	Root	Response bean for field scheme parameter update operations.
`results`	JSON	Optional
`results (anyOf 1)`	array	Alternative	Unique items: true
`results (anyOf 1)[]`	Model	Each item	Expand Update field parameters — response body — value results results array item
`results (anyOf 2)`	null	Alternative

Referenced models: Update field parameters — response body — value results results array item

Update field parameters — request body — body value item

Field	Type	Presence	Description and constraints
`$`	object	Root	Request bean for updating field scheme parameters across multiple schemes and work types. write Only: true Additional keys: not allowed
`parameters`	Model	Optional	Expand Update field parameters — request body — body value item parameters
`schemeIds`	array	Optional	The list of field scheme IDs to update
`schemeIds[]`	integer	Each item	The list of field scheme IDs to update Format: int64
`workTypeParameters`	array	Optional	The list of work type-specific parameter overrides, may be empty if only default parameters are being updated
`workTypeParameters[]`	Model	Each item	Expand Update field parameters — request body — body value item work Type Parameters item

Referenced models: Update field parameters — request body — body value item parameters, Update field parameters — request body — body value item work Type Parameters item

Update field parameters — response body — value results results array item

Field	Type	Presence	Description and constraints
`$`	object	Root	Result of updating field scheme parameters for a specific field, scheme, and optional work type.
`error`	JSON	Optional
`error (anyOf 1)`	string	Alternative
`error (anyOf 2)`	null	Alternative
`fieldId`	JSON	Optional
`fieldId (anyOf 1)`	string	Alternative
`fieldId (anyOf 2)`	null	Alternative
`schemeId`	JSON	Optional
`schemeId (anyOf 1)`	JSON	Alternative
`schemeId (anyOf 1) (anyOf 1)`	integer	Alternative	Format: int64
`schemeId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`schemeId (anyOf 2)`	null	Alternative
`success`	JSON	Optional
`success (anyOf 1)`	boolean	Alternative
`success (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

Update field parameters — request body — body value item parameters

Field	Type	Presence	Description and constraints
`$`	object	Root	The default parameters to apply to the field across all work types in the specified schemes, may be null if only work type-specific updates are needed Additional keys: not allowed
`description`	string	Optional	The custom description for the field, null to preserve current description
`isRequired`	boolean	Optional	Whether the field is required, null to preserve current requirement setting
`rendererType`	string	Optional	The renderer type for the field, null to preserve current renderer type One of: jira-text-renderer, atlassian-wiki-renderer

Update field parameters — request body — body value item work Type Parameters item

Field	Type	Presence	Description and constraints
`$`	object	Root	The list of work type-specific parameter overrides, may be empty if only default parameters are being updated Additional keys: not allowed
`description`	string	Optional	The custom description for the field for this work type, null to use default or preserve current
`isRequired`	boolean	Optional	Whether the field is required for this work type, null to use default or preserve current
`rendererType`	string	Optional	The renderer type for the field for this work type, null to use default or preserve current One of: jira-text-renderer, atlassian-wiki-renderer
`workTypeId`	integer	Optional	The ID of the work type (issue type) for which these parameters apply Format: int64

Policy, approvals and errors

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

No-content response statuses: [204]

Official provider source

Report an issue with this page