Atlassian: Get edit issue metadata

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

Operation atlassian.geteditissuemeta

Provider route: GET /{cloudId}/rest/api/3/issue/{issueIdOrKey}/editmeta. 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"]["getEditIssueMeta"]>[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.getEditIssueMeta(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_edit_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}$
`path.issueIdOrKey`	string	Required within parent
`query`	object	Optional	Additional keys: not allowed
`query.overrideScreenSecurity`	boolean	Optional	Default: false
`query.overrideEditableFlag`	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 edit issue metadata — response body

Referenced models: Get edit issue metadata — response body

Schemas

Get edit issue metadata — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A list of editable field details.
`fields`	JSON	Optional
`fields (anyOf 1)`	object	Alternative	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

Referenced models: Get edit issue metadata — response body — fields object value

Get edit issue metadata — response body — fields object value

Field	Type	Presence	Description and constraints
`$`	object	Root	The metadata describing an issue field.
`allowedValues`	JSON	Optional
`allowedValues (anyOf 1)`	array	Alternative	The list of values allowed in the field. Read only: true
`allowedValues (anyOf 1)[]`	JSON	Each item	Read only: true
`allowedValues (anyOf 2)`	null	Alternative
`autoCompleteUrl`	JSON	Optional
`autoCompleteUrl (anyOf 1)`	string	Alternative	The URL that can be used to automatically complete the field. Read only: true
`autoCompleteUrl (anyOf 2)`	null	Alternative
`configuration`	JSON	Optional
`configuration (anyOf 1)`	object	Alternative	The configuration properties. Read only: true Additional keys: see wildcard field
`configuration (anyOf 1).*`	JSON	Additional keys	Read only: true
`configuration (anyOf 2)`	null	Alternative
`defaultValue`	JSON	Optional
`defaultValue (anyOf 1)`	JSON	Alternative	The default value of the field. Read only: true
`defaultValue (anyOf 2)`	null	Alternative
`hasDefaultValue`	JSON	Optional
`hasDefaultValue (anyOf 1)`	boolean	Alternative	Whether the field has a default value. Read only: true
`hasDefaultValue (anyOf 2)`	null	Alternative
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	The key of the field. Read only: true
`key (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the field. Read only: true
`name (anyOf 2)`	null	Alternative
`operations`	JSON	Optional
`operations (anyOf 1)`	array	Alternative	The list of operations that can be performed on the field. Read only: true
`operations (anyOf 1)[]`	string	Each item	Read only: true
`operations (anyOf 2)`	null	Alternative
`required`	JSON	Optional
`required (anyOf 1)`	boolean	Alternative	Whether the field is required. Read only: true
`required (anyOf 2)`	null	Alternative
`schema`	JSON	Optional
`schema (anyOf 1)`	Model	Alternative	Expand Create custom field — response body — schema The schema of a field The data type of the field. Read only: true
`schema (anyOf 2)`	null	Alternative

Referenced models: Create custom field — response body — schema The schema of a field

Create custom field — response body — schema The schema of a field

Field	Type	Presence	Description and constraints
`$`	object	Root	The schema of a field.
`configuration`	JSON	Optional
`configuration (anyOf 1)`	object	Alternative	If the field is a custom field, the configuration of the field. Read only: true Additional keys: see wildcard field
`configuration (anyOf 1).*`	JSON	Additional keys	Read only: true
`configuration (anyOf 2)`	null	Alternative
`custom`	JSON	Optional
`custom (anyOf 1)`	string	Alternative	If the field is a custom field, the URI of the field. Read only: true
`custom (anyOf 2)`	null	Alternative
`customId`	JSON	Optional
`customId (anyOf 1)`	JSON	Alternative
`customId (anyOf 1) (anyOf 1)`	integer	Alternative	If the field is a custom field, the custom ID of the field. Format: int64 Read only: true
`customId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`customId (anyOf 2)`	null	Alternative
`items`	JSON	Optional
`items (anyOf 1)`	string	Alternative	When the data type is an array, the name of the field items within the array. Read only: true
`items (anyOf 2)`	null	Alternative
`system`	JSON	Optional
`system (anyOf 1)`	string	Alternative	If the field is a system field, the name of the field. Read only: true
`system (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The data type of the field. Read only: true
`type (anyOf 2)`	null	Alternative

Policy, approvals and errors

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