Atlassian: Get plan

Atlassian plans.getPlan: arguments, response, policy and SDK examples.

Operation atlassian.getplan

Provider route: GET /{cloudId}/rest/api/3/plans/plan/{planId}. 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["plans"]["getPlan"]>[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.plans.getPlan(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.plans.get_plan(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.planId`	integer	Required within parent	Format: int64
`query`	object	Optional	Additional keys: not allowed
`query.useGroupId`	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 plan — response body

Referenced models: Get plan — response body

Schemas

5 more schemas are linked from the tables above, on the schema pages.

Get plan — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`crossProjectReleases`	JSON	Optional
`crossProjectReleases (anyOf 1)`	array	Alternative	The cross-project releases included in the plan.
`crossProjectReleases (anyOf 1)[]`	Model	Each item	Expand Get plan — response body — cross Project Releases The cross-project releases included in the plan item
`crossProjectReleases (anyOf 2)`	null	Alternative
`customFields`	JSON	Optional
`customFields (anyOf 1)`	array	Alternative	The custom fields for the plan.
`customFields (anyOf 1)[]`	Model	Each item	Expand Get plan — response body — custom Fields The custom fields for the plan item
`customFields (anyOf 2)`	null	Alternative
`exclusionRules`	JSON	Optional
`exclusionRules (anyOf 1)`	Model	Alternative	Expand Get plan — response body — exclusion Rules issue Ids, issue Type Ids, number Of Days To Show Completed Issues, release Ids, work Status Category Ids, work Status Ids The exclusion rules for the plan.
`exclusionRules (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	JSON	Alternative
`id (anyOf 1) (anyOf 1)`	integer	Alternative	The plan ID. Format: int64
`id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id (anyOf 2)`	null	Alternative
`issueSources`	JSON	Optional
`issueSources (anyOf 1)`	array	Alternative	The issue sources included in the plan.
`issueSources (anyOf 1)[]`	Model	Each item	Expand Get plan — response body — issue Sources The issue sources included in the plan item
`issueSources (anyOf 2)`	null	Alternative
`lastSaved`	JSON	Optional
`lastSaved (anyOf 1)`	string	Alternative	The date when the plan was last saved in UTC.
`lastSaved (anyOf 2)`	null	Alternative
`leadAccountId`	JSON	Optional
`leadAccountId (anyOf 1)`	string	Alternative	The account ID of the plan lead.
`leadAccountId (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The plan name.
`name (anyOf 2)`	null	Alternative
`permissions`	JSON	Optional
`permissions (anyOf 1)`	array	Alternative	The permissions for the plan.
`permissions (anyOf 1)[]`	Model	Each item	Expand Get plan — response body — permissions The permissions for the plan item
`permissions (anyOf 2)`	null	Alternative
`scheduling`	JSON	Optional
`scheduling (anyOf 1)`	Model	Alternative	Expand Get plan — response body — scheduling dependencies, end Date, estimation, inferred Dates, start Date The scheduling settings for the plan.
`scheduling (anyOf 2)`	null	Alternative
`status`	JSON	Optional
`status (anyOf 1)`	string	Alternative	The plan status. This is "Active", "Trashed" or "Archived". Known values: Active, Trashed, Archived
`status (anyOf 2)`	null	Alternative

Referenced models: Get plan — response body — cross Project Releases The cross-project releases included in the plan item, Get plan — response body — custom Fields The custom fields for the plan item, Get plan — response body — exclusion Rules issue Ids, issue Type Ids, number Of Days To Show Completed Issues, release Ids, work Status Category Ids, work Status Ids, Get plan — response body — issue Sources The issue sources included in the plan item, Get plan — response body — permissions The permissions for the plan item, Get plan — response body — scheduling dependencies, end Date, estimation, inferred Dates, start Date

Get plan — response body — cross Project Releases The cross-project releases included in the plan item

Field	Type	Presence	Description and constraints
`$`	object	Root
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The cross-project release name.
`name (anyOf 2)`	null	Alternative
`releaseIds`	JSON	Optional
`releaseIds (anyOf 1)`	array	Alternative	The IDs of the releases included in the cross-project release. Unique items: true
`releaseIds (anyOf 1)[]`	JSON	Each item
`releaseIds (anyOf 1)[] (anyOf 1)`	integer	Alternative	Format: int64
`releaseIds (anyOf 1)[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`releaseIds (anyOf 2)`	null	Alternative

Get plan — response body — custom Fields The custom fields for the plan item

Field	Type	Presence	Description and constraints
`$`	object	Root
`customFieldId`	JSON	Optional
`customFieldId (anyOf 1)`	JSON	Alternative
`customFieldId (anyOf 1) (anyOf 1)`	integer	Alternative	The custom field ID. Format: int64
`customFieldId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`customFieldId (anyOf 2)`	null	Alternative
`filter`	JSON	Optional
`filter (anyOf 1)`	boolean	Alternative	Allows filtering issues based on their values for the custom field.
`filter (anyOf 2)`	null	Alternative

Get plan — response body — exclusion Rules issue Ids, issue Type Ids, number Of Days To Show Completed Issues, release Ids, work Status Category Ids, work Status Ids

Field	Type	Presence	Description and constraints
`$`	object	Root
`issueIds`	JSON	Optional
`issueIds (anyOf 1)`	array	Alternative	The IDs of the issues excluded from the plan. Unique items: true
`issueIds (anyOf 1)[]`	JSON	Each item
`issueIds (anyOf 1)[] (anyOf 1)`	integer	Alternative	Format: int64
`issueIds (anyOf 1)[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`issueIds (anyOf 2)`	null	Alternative
`issueTypeIds`	JSON	Optional
`issueTypeIds (anyOf 1)`	array	Alternative	The IDs of the issue types excluded from the plan. Unique items: true
`issueTypeIds (anyOf 1)[]`	JSON	Each item
`issueTypeIds (anyOf 1)[] (anyOf 1)`	integer	Alternative	Format: int64
`issueTypeIds (anyOf 1)[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`issueTypeIds (anyOf 2)`	null	Alternative
`numberOfDaysToShowCompletedIssues`	JSON	Optional
`numberOfDaysToShowCompletedIssues (anyOf 1)`	JSON	Alternative
`numberOfDaysToShowCompletedIssues (anyOf 1) (anyOf 1)`	integer	Alternative	Issues completed this number of days ago are excluded from the plan. Format: int32
`numberOfDaysToShowCompletedIssues (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`numberOfDaysToShowCompletedIssues (anyOf 2)`	null	Alternative
`releaseIds`	JSON	Optional
`releaseIds (anyOf 1)`	array	Alternative	The IDs of the releases excluded from the plan. Unique items: true
`releaseIds (anyOf 1)[]`	JSON	Each item
`releaseIds (anyOf 1)[] (anyOf 1)`	integer	Alternative	Format: int64
`releaseIds (anyOf 1)[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`releaseIds (anyOf 2)`	null	Alternative
`workStatusCategoryIds`	JSON	Optional
`workStatusCategoryIds (anyOf 1)`	array	Alternative	The IDs of the work status categories excluded from the plan. Unique items: true
`workStatusCategoryIds (anyOf 1)[]`	JSON	Each item
`workStatusCategoryIds (anyOf 1)[] (anyOf 1)`	integer	Alternative	Format: int64
`workStatusCategoryIds (anyOf 1)[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`workStatusCategoryIds (anyOf 2)`	null	Alternative
`workStatusIds`	JSON	Optional
`workStatusIds (anyOf 1)`	array	Alternative	The IDs of the work statuses excluded from the plan. Unique items: true
`workStatusIds (anyOf 1)[]`	JSON	Each item
`workStatusIds (anyOf 1)[] (anyOf 1)`	integer	Alternative	Format: int64
`workStatusIds (anyOf 1)[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`workStatusIds (anyOf 2)`	null	Alternative

Policy, approvals and errors

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

Report an issue with this page