Atlassian: Bulk set issue property

← Issue properties operations · Get started

Operation atlassian.bulksetissueproperty

Provider route: PUT /{cloudId}/rest/api/3/issue/properties/{propertyKey}. 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["issueProperties"]["bulkSetIssueProperty"]>[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.issueProperties.bulkSetIssueProperty(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_properties.bulk_set_issue_property(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.propertyKey	string	Required within parent
body	Model	Required within parent	Expand Bulk set issue property — request body — body

Referenced models: Bulk set issue property — request body — body

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
$	JSON	Root

Schemas

Bulk set issue property — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Bulk issue property update request details. Additional keys: not allowed
expression	string	Optional	EXPERIMENTAL. The Jira expression to calculate the value of the property. The value of the expression must be an object that can be converted to JSON, such as a number, boolean, string, list, or map. The context variables available to the expression are `issue` and `user`. Issues for which the expression returns a value whose JSON representation is longer than 32768 characters are ignored.
filter	Model	Optional	Expand Bulk set issue property — request body — body filter The bulk operation filter.
value	JSON	Optional	The value of the property. The value must be a [valid](https://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.

Referenced models: Bulk set issue property — request body — body filter

Bulk set issue property — request body — body filter

Field	Type	Presence	Description and constraints
$	object	Root	Bulk operation filter details. Additional keys: not allowed
currentValue	JSON	Optional	The value of properties to perform the bulk operation on.
entityIds	array	Optional	List of issues to perform the bulk operation on. Unique items: true
entityIds[]	integer	Each item	Format: int64
hasProperty	boolean	Optional	Whether the bulk operation occurs only when the property is present on or absent from an issue.

Policy, approvals and errors

SDK function policy ID: atlassian.bulksetissueproperty. Catalog operation: bulksetissueproperty. 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: ["write:jira-work"]

Official provider source