Atlassian: Create field configuration scheme

← Issue field configurations operations · Get started

Operation atlassian.createfieldconfigurationscheme

Provider route: POST /{cloudId}/rest/api/3/fieldconfigurationscheme. 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"]["createFieldConfigurationScheme"]>[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.createFieldConfigurationScheme(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.create_field_configuration_scheme(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	Model	Required within parent	Expand Create field configuration scheme — request body — body

Referenced models: Create field configuration scheme — 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
$	Model	Root	Expand Create field configuration scheme — response body

Referenced models: Create field configuration scheme — response body

Schemas

Create field configuration scheme — response body

Field	Type	Presence	Description and constraints
$	object	Root	Details of a field configuration scheme.
description	JSON	Optional
description (anyOf 1)	string	Alternative	The description of the field configuration scheme.
description (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the field configuration scheme.
id (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the field configuration scheme.
name (anyOf 2)	null	Alternative

Create field configuration scheme — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	The details of the field configuration scheme. Additional keys: not allowed
description	string	Optional	The description of the field configuration scheme. Maximum length: 1024 write Only: true
name	string	Required within parent	The name of the field configuration scheme. The name must be unique. Maximum length: 255 write Only: true

Policy, approvals and errors

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