Atlassian: Get issue limit report

← Issues operations · Get started

Operation atlassian.getissuelimitreport

Provider route: GET /{cloudId}/rest/api/3/issue/limit/report. 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["issues"]["getIssueLimitReport"]>[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.issues.getIssueLimitReport(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.issues.get_issue_limit_report(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}$
query	object	Optional	Additional keys: not allowed
query.isReturningKeys	boolean	Optional	Default: false

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 limit report — response body

Referenced models: Get issue limit report — response body

Schemas

Get issue limit report — response body

Field	Type	Presence	Description and constraints
$	object	Root
entitiesBreachingLimit	JSON	Optional
entitiesBreachingLimit (anyOf 1)	object	Alternative	For each field, the ids of the individual entities breaching the limit, grouped by the id or key of the issue they belong to. Fields that hold a single value, such as description and environment, map to an empty list because the issue itself identifies the breaching content Additional keys: see wildcard field
entitiesBreachingLimit (anyOf 1).*	object	Additional keys	Additional keys: see wildcard field
entitiesBreachingLimit (anyOf 1).*.*	array	Additional keys
entitiesBreachingLimit (anyOf 1).*.*[]	JSON	Each item
entitiesBreachingLimit (anyOf 1).*.*[] (anyOf 1)	integer	Alternative	Format: int64
entitiesBreachingLimit (anyOf 1).*.*[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
entitiesBreachingLimit (anyOf 2)	null	Alternative
issuesApproachingLimit	JSON	Optional
issuesApproachingLimit (anyOf 1)	object	Alternative	A list of ids of issues approaching the limit and their field count Additional keys: see wildcard field
issuesApproachingLimit (anyOf 1).*	object	Additional keys	Additional keys: see wildcard field
issuesApproachingLimit (anyOf 1).*.*	JSON	Additional keys
issuesApproachingLimit (anyOf 1).*.* (anyOf 1)	integer	Alternative	Format: int64
issuesApproachingLimit (anyOf 1).*.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issuesApproachingLimit (anyOf 2)	null	Alternative
issuesBreachingLimit	JSON	Optional
issuesBreachingLimit (anyOf 1)	object	Alternative	A list of ids of issues breaching the limit and their field count Additional keys: see wildcard field
issuesBreachingLimit (anyOf 1).*	object	Additional keys	Additional keys: see wildcard field
issuesBreachingLimit (anyOf 1).*.*	JSON	Additional keys
issuesBreachingLimit (anyOf 1).*.* (anyOf 1)	integer	Alternative	Format: int64
issuesBreachingLimit (anyOf 1).*.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issuesBreachingLimit (anyOf 2)	null	Alternative
limits	JSON	Optional
limits (anyOf 1)	object	Alternative	The fields and their defined limits Additional keys: see wildcard field
limits (anyOf 1).*	JSON	Additional keys
limits (anyOf 1).* (anyOf 1)	integer	Alternative	Format: int32
limits (anyOf 1).* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
limits (anyOf 2)	null	Alternative

Policy, approvals and errors

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

Official provider source