Atlassian: Get create issue metadata

Atlassian issues.getCreateIssueMeta: arguments, response, policy and SDK examples.

Operation atlassian.getcreateissuemeta

Provider route: GET /{cloudId}/rest/api/3/issue/createmeta. 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"]["getCreateIssueMeta"]>[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.getCreateIssueMeta(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_create_issue_meta(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.projectIds`	array	Optional
`query.projectIds[]`	string	Each item
`query.projectKeys`	array	Optional
`query.projectKeys[]`	string	Each item
`query.issuetypeIds`	array	Optional
`query.issuetypeIds[]`	string	Each item
`query.issuetypeNames`	array	Optional
`query.issuetypeNames[]`	string	Each item
`query.expand`	string	Optional

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 create issue metadata — response body

Referenced models: Get create issue metadata — response body

Schemas

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

Get create issue metadata — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	The wrapper for the issue creation metadata for a list of projects.
`expand`	JSON	Optional
`expand (anyOf 1)`	string	Alternative	Expand options that include additional project details in the response. Read only: true
`expand (anyOf 2)`	null	Alternative
`projects`	JSON	Optional
`projects (anyOf 1)`	array	Alternative	List of projects and their issue creation metadata. Read only: true
`projects (anyOf 1)[]`	Model	Each item	Expand Get create issue metadata — response body — projects List of projects and their issue creation metadata item
`projects (anyOf 2)`	null	Alternative

Referenced models: Get create issue metadata — response body — projects List of projects and their issue creation metadata item

Get create issue metadata — response body — projects List of projects and their issue creation metadata item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of the issue creation metadata for a project.
`avatarUrls`	JSON	Optional
`avatarUrls (anyOf 1)`	Model	Alternative	Expand Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48 List of the project's avatars, returning the avatar size and associated URL. Read only: true
`avatarUrls (anyOf 2)`	null	Alternative
`expand`	JSON	Optional
`expand (anyOf 1)`	string	Alternative	Expand options that include additional project issue create metadata details in the response. Read only: true
`expand (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the project. Read only: true
`id (anyOf 2)`	null	Alternative
`issuetypes`	JSON	Optional
`issuetypes (anyOf 1)`	array	Alternative	List of the issue types supported by the project. Read only: true
`issuetypes (anyOf 1)[]`	Model	Each item	Expand Get create metadata issue types for a project — response body — create Meta Issue Type array item
`issuetypes (anyOf 2)`	null	Alternative
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	The key of the project. Read only: true
`key (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the project. Read only: true
`name (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the project. Read only: true
`self (anyOf 2)`	null	Alternative

Referenced models: Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48, Get create metadata issue types for a project — response body — create Meta Issue Type array item

Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48

Field	Type	Presence	Description and constraints
`$`	object	Root
`16x16`	JSON	Optional
`16x16 (anyOf 1)`	string	Alternative	The URL of the item's 16x16 pixel avatar. Format: uri
`16x16 (anyOf 2)`	null	Alternative
`24x24`	JSON	Optional
`24x24 (anyOf 1)`	string	Alternative	The URL of the item's 24x24 pixel avatar. Format: uri
`24x24 (anyOf 2)`	null	Alternative
`32x32`	JSON	Optional
`32x32 (anyOf 1)`	string	Alternative	The URL of the item's 32x32 pixel avatar. Format: uri
`32x32 (anyOf 2)`	null	Alternative
`48x48`	JSON	Optional
`48x48 (anyOf 1)`	string	Alternative	The URL of the item's 48x48 pixel avatar. Format: uri
`48x48 (anyOf 2)`	null	Alternative

Get create metadata issue types for a project — response body — create Meta Issue Type array item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of the issue creation metadata for an issue type.
`avatarId`	JSON	Optional
`avatarId (anyOf 1)`	JSON	Alternative
`avatarId (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the issue type's avatar. 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
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the issue type. Read only: true
`description (anyOf 2)`	null	Alternative
`entityId`	JSON	Optional
`entityId (anyOf 1)`	string	Alternative	Unique ID for next-gen projects. Format: uuid Read only: true
`entityId (anyOf 2)`	null	Alternative
`expand`	JSON	Optional
`expand (anyOf 1)`	string	Alternative	Expand options that include additional issue type metadata details in the response. Read only: true
`expand (anyOf 2)`	null	Alternative
`fields`	JSON	Optional
`fields (anyOf 1)`	object	Alternative	List of the fields available when creating an issue for the issue type. Read only: true Additional keys: see wildcard field
`fields (anyOf 1).*`	Model	Additional keys	Expand Get edit issue metadata — response body — fields object value
`fields (anyOf 2)`	null	Alternative
`hierarchyLevel`	JSON	Optional
`hierarchyLevel (anyOf 1)`	JSON	Alternative
`hierarchyLevel (anyOf 1) (anyOf 1)`	integer	Alternative	Hierarchy level of the issue type. Format: int32 Read only: true
`hierarchyLevel (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`hierarchyLevel (anyOf 2)`	null	Alternative
`iconUrl`	JSON	Optional
`iconUrl (anyOf 1)`	string	Alternative	The URL of the issue type's avatar. Read only: true
`iconUrl (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the issue type. Read only: true
`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
`scope`	JSON	Optional
`scope (anyOf 1)`	Model	Alternative	Expand Get status — response body — scope project, type Details of the next-gen projects the issue type is available in. Read only: true
`scope (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of these issue type details. Read only: true
`self (anyOf 2)`	null	Alternative
`subtask`	JSON	Optional
`subtask (anyOf 1)`	boolean	Alternative	Whether this issue type is used to create subtasks. Read only: true
`subtask (anyOf 2)`	null	Alternative

Referenced models: Get edit issue metadata — response body — fields object value, Get status — response body — scope project, type

Get status — response body — scope project, type

Field	Type	Presence	Description and constraints
`$`	object	Root	The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). Additional keys: allowed
`project`	JSON	Optional
`project (anyOf 1)`	Model	Alternative	Expand Get issue type screen scheme projects — response body — values The list of items item The project the item has scope in. Read only: true
`project (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The type of scope. Known values: PROJECT, TEMPLATE Read only: true
`type (anyOf 2)`	null	Alternative

Referenced models: Get issue type screen scheme projects — response body — values The list of items item

Policy, approvals and errors

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