Atlassian: Get announcement banner configuration

← Announcement banner operations · Get started

Operation atlassian.getbanner

Provider route: GET /{cloudId}/rest/api/3/announcementBanner. 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["announcementBanner"]["getBanner"]>[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.announcementBanner.getBanner(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.announcement_banner.get_banner(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}$

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 Get announcement banner configuration — response body

Referenced models: Get announcement banner configuration — response body

Schemas

Get announcement banner configuration — response body

Field	Type	Presence	Description and constraints
$	object	Root	Announcement banner configuration.
hashId	JSON	Optional
hashId (anyOf 1)	string	Alternative	Hash of the banner data. The client detects updates by comparing hash IDs. Read only: true
hashId (anyOf 2)	null	Alternative
isDismissible	JSON	Optional
isDismissible (anyOf 1)	boolean	Alternative	Flag indicating if the announcement banner can be dismissed by the user. Read only: true
isDismissible (anyOf 2)	null	Alternative
isEnabled	JSON	Optional
isEnabled (anyOf 1)	boolean	Alternative	Flag indicating if the announcement banner is enabled or not. Read only: true
isEnabled (anyOf 2)	null	Alternative
message	JSON	Optional
message (anyOf 1)	string	Alternative	The text on the announcement banner. Read only: true
message (anyOf 2)	null	Alternative
visibility	JSON	Optional
visibility (anyOf 1)	string	Alternative	Visibility of the announcement banner. Known values: public, private Read only: true
visibility (anyOf 2)	null	Alternative

Policy, approvals and errors

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