Atlassian: Update field configuration items

← Issue field configurations operations · Get started

Operation atlassian.updatefieldconfigurationitems

Provider route: PUT /{cloudId}/rest/api/3/fieldconfiguration/{id}/fields. 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"]["updateFieldConfigurationItems"]>[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.updateFieldConfigurationItems(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.update_field_configuration_items(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
body	Model	Required within parent	Expand Update field configuration items — request body — body

Referenced models: Update field configuration items — request body — body

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
$	null	Root

Schemas

Update field configuration items — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Details of field configuration items. Additional keys: not allowed
fieldConfigurationItems	array	Required within parent	Details of fields in a field configuration. write Only: true
fieldConfigurationItems[]	Model	Each item	Expand Update field configuration items — request body — body field Configuration Items item

Referenced models: Update field configuration items — request body — body field Configuration Items item

Update field configuration items — request body — body field Configuration Items item

Field	Type	Presence	Description and constraints
$	object	Root	A field within a field configuration. Additional keys: not allowed
description	string	Optional	The description of the field within the field configuration.
id	string	Required within parent	The ID of the field within the field configuration.
isHidden	boolean	Optional	Whether the field is hidden in the field configuration.
isRequired	boolean	Optional	Whether the field is required in the field configuration.
renderer	string	Optional	The renderer type for the field within the field configuration.

Policy, approvals and errors

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