Atlassian: Bulk pin or unpin issue panel to projects

← Issue panels operations · Get started

Operation atlassian.bulkpinunpinprojectsasync

Provider route: POST /{cloudId}/rest/api/3/forge/panel/action/bulk/async. 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["issuePanels"]["bulkPinUnpinProjectsAsync"]>[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.issuePanels.bulkPinUnpinProjectsAsync(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_panels.bulk_pin_unpin_projects_async(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 Bulk pin or unpin issue panel to projects — request body — body

Referenced models: Bulk pin or unpin issue panel to projects — 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 Bulk edit issues — response body

Referenced models: Bulk edit issues — response body

Schemas

Bulk pin or unpin issue panel to projects — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
moduleId	string	Required within parent	The moduleId of the Forge panel in the format `ari:cloud:ecosystem::extension/{app-id}/{environment-id}/static/{module-key}`
projectList	array	Required within parent	The list of projects to pin or unpin the issue panel to or from. Maximum items: 1000 Minimum items: 0
projectList[]	Model	Each item	Expand Bulk pin or unpin issue panel to projects — request body — body project List item

Referenced models: Bulk pin or unpin issue panel to projects — request body — body project List item

Bulk edit issues — response body

Field	Type	Presence	Description and constraints
$	object	Root
taskId	JSON	Optional
taskId (anyOf 1)	string	Alternative
taskId (anyOf 2)	null	Alternative

Bulk pin or unpin issue panel to projects — request body — body project List item

Field	Type	Presence	Description and constraints
$	object	Root	The list of projects to pin or unpin the issue panel to or from. Additional keys: not allowed
action	string	Required within parent	The action to perform: PIN or UNPIN. One of: PIN, UNPIN
projectIdOrKey	string	Required within parent	The project ID or key.

Policy, approvals and errors

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