Atlassian: Get issue panel pin status for projects

Atlassian issuePanels.getBulkPinStatus: arguments, response, policy and SDK examples.

Operation atlassian.getbulkpinstatus

Provider route: POST /{cloudId}/rest/api/3/forge/panel/action/bulk/status. 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"]["getBulkPinStatus"]>[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.getBulkPinStatus(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.get_bulk_pin_status(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 Get issue panel pin status for projects — request body — body

Referenced models: Get issue panel pin status for 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 Get issue panel pin status for projects — response body

Referenced models: Get issue panel pin status for projects — response body

Schemas

Get issue panel pin status for 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 IDs or keys of the projects to check the issue panel pin status for. Maximum items: 1000 Minimum items: 0
`projectList[]`	string	Each item	The IDs or keys of the projects to check the issue panel pin status for.

Get issue panel pin status for projects — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`moduleId`	JSON	Optional
`moduleId (anyOf 1)`	string	Alternative	The moduleId of the Forge panel that was requested.
`moduleId (anyOf 2)`	null	Alternative
`statuses`	JSON	Optional
`statuses (anyOf 1)`	array	Alternative	The pin status of the issue panel, with one entry per requested project.
`statuses (anyOf 1)[]`	Model	Each item	Expand Get issue panel pin status for projects — response body — statuses array item
`statuses (anyOf 2)`	null	Alternative

Referenced models: Get issue panel pin status for projects — response body — statuses array item

Get issue panel pin status for projects — response body — statuses array item

Field	Type	Presence	Description and constraints
`$`	object	Root	The pin status of an issue panel (added by a Forge app) for a single project.
`error`	JSON	Optional
`error (anyOf 1)`	string	Alternative	The reason the pin status could not be read for the project. Null if the pin status was read successfully.
`error (anyOf 2)`	null	Alternative
`pinned`	JSON	Optional
`pinned (anyOf 1)`	boolean	Alternative	Whether the issue panel is currently pinned to the project.
`pinned (anyOf 2)`	null	Alternative
`pinnedAt`	JSON	Optional
`pinnedAt (anyOf 1)`	JSON	Alternative
`pinnedAt (anyOf 1) (anyOf 1)`	integer	Alternative	The time the issue panel was pinned to the project, in epoch milliseconds. Format: int64
`pinnedAt (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`pinnedAt (anyOf 2)`	null	Alternative
`projectIdOrKey`	JSON	Optional
`projectIdOrKey (anyOf 1)`	string	Alternative	The project ID or key supplied in the request.
`projectIdOrKey (anyOf 2)`	null	Alternative

Policy, approvals and errors

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

Report an issue with this page