Atlassian: Add screen tab field

← Screen tab fields operations · Get started

Operation atlassian.addscreentabfield

Provider route: POST /{cloudId}/rest/api/3/screens/{screenId}/tabs/{tabId}/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["screenTabFields"]["addScreenTabField"]>[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.screenTabFields.addScreenTabField(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.screen_tab_fields.add_screen_tab_field(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.screenId	integer	Required within parent	Format: int64
path.tabId	integer	Required within parent	Format: int64
query	object	Optional	Additional keys: not allowed
query.skipFieldAssociation	boolean	Optional	Whether to skip associating the added field with projects linked to this screen. By default, adding a field to a screen tab also updates the field configuration of associated projects, making the field visible in issue experiences. When set to true, the field is added to the screen tab only and will not be visible in experiences such as issue view for associated projects unless the field association is updated separately. Default: false
body	Model	Required within parent	Expand Add screen tab field — request body — body

Referenced models: Add screen tab field — 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 Add screen tab field — response body

Referenced models: Add screen tab field — response body

Schemas

Add screen tab field — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
fieldId	string	Required within parent	The ID of the field to add.

Add screen tab field — response body

Field	Type	Presence	Description and constraints
$	object	Root	A screen tab field.
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the screen tab field. Read only: true
id (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the screen tab field. Required on create and update. The maximum length is 255 characters.
name (anyOf 2)	null	Alternative

Policy, approvals and errors

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

Official provider source