Atlassian: Get project issue type hierarchy

Atlassian projects.getHierarchy: arguments, response, policy and SDK examples.

Operation atlassian.gethierarchy

Provider route: GET /{cloudId}/rest/api/3/project/{projectId}/hierarchy. 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["projects"]["getHierarchy"]>[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.projects.getHierarchy(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.projects.get_hierarchy(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.projectId`	integer	Required within parent	Format: int64

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 project issue type hierarchy — response body

Referenced models: Get project issue type hierarchy — response body

Schemas

Get project issue type hierarchy — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	The hierarchy of issue types within a project.
`hierarchy`	JSON	Optional
`hierarchy (anyOf 1)`	array	Alternative	Details of an issue type hierarchy level. Read only: true
`hierarchy (anyOf 1)[]`	Model	Each item	Expand Get project issue type hierarchy — response body — hierarchy Details of an issue type hierarchy level item
`hierarchy (anyOf 2)`	null	Alternative
`projectId`	JSON	Optional
`projectId (anyOf 1)`	JSON	Alternative
`projectId (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the project. Format: int64 Read only: true
`projectId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`projectId (anyOf 2)`	null	Alternative

Referenced models: Get project issue type hierarchy — response body — hierarchy Details of an issue type hierarchy level item

Get project issue type hierarchy — response body — hierarchy Details of an issue type hierarchy level item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of an issue type hierarchy level.
`entityId`	JSON	Optional
`entityId (anyOf 1)`	string	Alternative	The ID of the issue type hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). Format: uuid Read only: true
`entityId (anyOf 2)`	null	Alternative
`issueTypes`	JSON	Optional
`issueTypes (anyOf 1)`	array	Alternative	The list of issue types in the hierarchy level. Read only: true
`issueTypes (anyOf 1)[]`	Model	Each item	Expand Get project issue type hierarchy — response body — hierarchy Details of an issue type hierarchy level item issue Types The list of issue types in the hierarchy level item
`issueTypes (anyOf 2)`	null	Alternative
`level`	JSON	Optional
`level (anyOf 1)`	JSON	Alternative
`level (anyOf 1) (anyOf 1)`	integer	Alternative	The level of the issue type hierarchy level. Format: int32 Read only: true
`level (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`level (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the issue type hierarchy level. Read only: true
`name (anyOf 2)`	null	Alternative

Referenced models: Get project issue type hierarchy — response body — hierarchy Details of an issue type hierarchy level item issue Types The list of issue types in the hierarchy level item

Get project issue type hierarchy — response body — hierarchy Details of an issue type hierarchy level item issue Types The list of issue types in the hierarchy level item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of an issue type.
`avatarId`	JSON	Optional
`avatarId (anyOf 1)`	JSON	Alternative
`avatarId (anyOf 1) (anyOf 1)`	integer	Alternative	The avatar of the issue type. Format: int64 Read only: true
`avatarId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`avatarId (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	JSON	Alternative
`id (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the issue type. Format: int64 Read only: true
`id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the issue type. Read only: true
`name (anyOf 2)`	null	Alternative

Policy, approvals and errors

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