Atlassian: Get bulk editable fields

← Issue bulk operations operations · Get started

Operation atlassian.getbulkeditablefields

Provider route: GET /{cloudId}/rest/api/3/bulk/issues/fields. 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["issueBulkOperations"]["getBulkEditableFields"]>[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.issueBulkOperations.getBulkEditableFields(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.issue_bulk_operations.get_bulk_editable_fields(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	Required within parent	Additional keys: not allowed
query.issueIdsOrKeys	string	Required within parent
query.searchText	string	Optional
query.endingBefore	string	Optional
query.startingAfter	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 bulk editable fields — response body

Referenced models: Get bulk editable fields — response body

Schemas

Get bulk editable fields — response body

Field	Type	Presence	Description and constraints
$	object	Root	Bulk Edit Get Fields Response.
endingBefore	JSON	Optional
endingBefore (anyOf 1)	string	Alternative	The end cursor for use in pagination. Read only: true
endingBefore (anyOf 2)	null	Alternative
fields	JSON	Optional
fields (anyOf 1)	array	Alternative	List of all the fields Read only: true
fields (anyOf 1)[]	Model	Each item	Expand Get bulk editable fields — response body — fields List of all the fields item
fields (anyOf 2)	null	Alternative
startingAfter	JSON	Optional
startingAfter (anyOf 1)	string	Alternative	The start cursor for use in pagination. Read only: true
startingAfter (anyOf 2)	null	Alternative

Referenced models: Get bulk editable fields — response body — fields List of all the fields item

Get bulk editable fields — response body — fields List of all the fields item

Field	Type	Presence	Description and constraints
$	object	Root
description	JSON	Optional
description (anyOf 1)	string	Alternative	Description of the field.
description (anyOf 2)	null	Alternative
fieldOptions	JSON	Optional
fieldOptions (anyOf 1)	array	Alternative	A list of options related to the field, applicable in contexts where multiple selections are allowed.
fieldOptions (anyOf 1)[]	Model	Each item	Expand Get user — response body — groups callback, items, max-results, paging Callback, size callback object
fieldOptions (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The unique ID of the field.
id (anyOf 2)	null	Alternative
isRequired	JSON	Optional
isRequired (anyOf 1)	boolean	Alternative	Indicates whether the field is mandatory for the operation.
isRequired (anyOf 2)	null	Alternative
multiSelectFieldOptions	JSON	Optional
multiSelectFieldOptions (anyOf 1)	array	Alternative	Specifies supported actions (like add, replace, remove) on multi-select fields via an enum.
multiSelectFieldOptions (anyOf 1)[]	string	Each item	Known values: ADD, REMOVE, REPLACE, REMOVE_ALL
multiSelectFieldOptions (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The display name of the field.
name (anyOf 2)	null	Alternative
searchUrl	JSON	Optional
searchUrl (anyOf 1)	string	Alternative	A URL to fetch additional data for the field
searchUrl (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The type of the field.
type (anyOf 2)	null	Alternative
unavailableMessage	JSON	Optional
unavailableMessage (anyOf 1)	string	Alternative	A message indicating why the field is unavailable for editing.
unavailableMessage (anyOf 2)	null	Alternative

Referenced models: Get user — response body — groups callback, items, max-results, paging Callback, size callback object

Get user — response body — groups callback, items, max-results, paging Callback, size callback object

Field	Type	Presence	Description and constraints
$	object	Root

Policy, approvals and errors

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