Atlassian: Update fields associated with field schemes

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

← Field schemes operations · Get started

Operation atlassian.updatefieldsassociatedwithschemes

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

Referenced models: Update fields associated with field schemes — 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 fields associated with field schemes — response body — value Response for updating field associations
`$ (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Update fields associated with field schemes — response body — value Response for updating field associations
`$ (anyOf 2)`	null	Alternative

Referenced models: Update fields associated with field schemes — response body — value Response for updating field associations

Schemas

Update fields associated with field schemes — response body — value Response for updating field associations

Field	Type	Presence	Description and constraints
`$`	object	Root	Response for updating field associations.
`results`	JSON	Optional
`results (anyOf 1)`	array	Alternative	Unique items: true
`results (anyOf 1)[]`	Model	Each item	Expand Update fields associated with field schemes — response body — value Response for updating field associations results array item
`results (anyOf 2)`	null	Alternative

Referenced models: Update fields associated with field schemes — response body — value Response for updating field associations results array item

Update fields associated with field schemes — request body — body value item

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents an association between a field and its operations. write Only: true Additional keys: not allowed
`restrictedToWorkTypes`	array	Optional	(optional) Work types to restrict field to. Replaces any existing work type associations for the field. If not provided, the field is associated to any work types. Unique items: true
`restrictedToWorkTypes[]`	integer	Each item	(optional) Work types to restrict field to. Replaces any existing work type associations for the field. If not provided, the field is associated to any work types. Format: int64
`schemeIds`	array	Required within parent	Scheme IDs to associate field with Unique items: true
`schemeIds[]`	integer	Each item	Scheme IDs to associate field with Format: int64

Update fields associated with field schemes — response body — value Response for updating field associations results array item

Field	Type	Presence	Description and constraints
`$`	object	Root	Partial failure result when updating field scheme to fields associations.
`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
`workTypeIds`	JSON	Optional
`workTypeIds (anyOf 1)`	array	Alternative	Unique items: true
`workTypeIds (anyOf 1)[]`	JSON	Each item
`workTypeIds (anyOf 1)[] (anyOf 1)`	integer	Alternative	Format: int64
`workTypeIds (anyOf 1)[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`workTypeIds (anyOf 2)`	null	Alternative

Policy, approvals and errors

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