Atlassian: Update gadget on dashboard

← Dashboards operations · Get started

Operation atlassian.updategadget

Provider route: PUT /{cloudId}/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}. 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["dashboards"]["updateGadget"]>[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.dashboards.updateGadget(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.dashboards.update_gadget(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.dashboardId	integer	Required within parent	Format: int64
path.gadgetId	integer	Required within parent	Format: int64
body	Model	Required within parent	Expand Update gadget on dashboard — request body — body

Referenced models: Update gadget on dashboard — 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 gadget on dashboard — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	The details of the gadget to update. Additional keys: not allowed
color	string	Optional	The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`. write Only: true
position	Model	Optional	Expand Add gadget to dashboard — request body — body position The position of the gadget.
title	string	Optional	The title of the gadget. write Only: true

Referenced models: Add gadget to dashboard — request body — body position

Add gadget to dashboard — request body — body position

Field	Type	Presence	Description and constraints
$	object	Root	Details of a gadget position. write Only: true Additional keys: not allowed
column	integer	Required within parent	The column position of the gadget. Format: int32
row	integer	Required within parent	The row position of the gadget. Format: int32

Policy, approvals and errors

SDK function policy ID: atlassian.updategadget. Catalog operation: updategadget. 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: ["write:jira-work"]

No-content response statuses: [204]

Official provider source