Atlassian: Get available transitions

Atlassian issueBulkOperations.getAvailableTransitions: arguments, response, policy and SDK examples.

← Issue bulk operations operations · Get started

Operation atlassian.getavailabletransitions

Provider route: GET /{cloudId}/rest/api/3/bulk/issues/transition. 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"]["getAvailableTransitions"]>[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.getAvailableTransitions(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_available_transitions(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.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 available transitions — response body

Referenced models: Get available transitions — response body

Schemas

Get available transitions — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Bulk Transition Get Available Transitions Response.
`availableTransitions`	JSON	Optional
`availableTransitions (anyOf 1)`	array	Alternative	List of available transitions for bulk transition operation for requested issues grouped by workflow Read only: true
`availableTransitions (anyOf 1)[]`	Model	Each item	Expand Get available transitions — response body — available Transitions array item
`availableTransitions (anyOf 2)`	null	Alternative
`endingBefore`	JSON	Optional
`endingBefore (anyOf 1)`	string	Alternative	The end cursor for use in pagination. Read only: true
`endingBefore (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 available transitions — response body — available Transitions array item

Get available transitions — response body — available Transitions array item

Field	Type	Presence	Description and constraints
`$`	object	Root
`isTransitionsFiltered`	JSON	Optional
`isTransitionsFiltered (anyOf 1)`	boolean	Alternative	Indicates whether all the transitions of this workflow are available in the transitions list or not. Read only: true
`isTransitionsFiltered (anyOf 2)`	null	Alternative
`issues`	JSON	Optional
`issues (anyOf 1)`	array	Alternative	List of issue keys from the request which are associated with this workflow. Read only: true
`issues (anyOf 1)[]`	string	Each item	Read only: true
`issues (anyOf 2)`	null	Alternative
`transitions`	JSON	Optional
`transitions (anyOf 1)`	array	Alternative	List of transitions available for issues from the request which are associated with this workflow. This list includes only those transitions that are common across the issues in this workflow and do not involve any additional field updates. Read only: true
`transitions (anyOf 1)[]`	Model	Each item	Expand Get available transitions — response body — available Transitions array item transitions array item
`transitions (anyOf 2)`	null	Alternative

Referenced models: Get available transitions — response body — available Transitions array item transitions array item

Get available transitions — response body — available Transitions array item transitions array item

Field	Type	Presence	Description and constraints
`$`	object	Root
`to`	JSON	Optional
`to (anyOf 1)`	Model	Alternative	Expand Get available transitions — response body — available Transitions array item transitions array item to status Id, status Name The issue status change of the transition. Read only: true
`to (anyOf 2)`	null	Alternative
`transitionId`	JSON	Optional
`transitionId (anyOf 1)`	JSON	Alternative
`transitionId (anyOf 1) (anyOf 1)`	integer	Alternative	The unique ID of the transition. Format: int32 Read only: true
`transitionId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`transitionId (anyOf 2)`	null	Alternative
`transitionName`	JSON	Optional
`transitionName (anyOf 1)`	string	Alternative	The name of the transition. Read only: true
`transitionName (anyOf 2)`	null	Alternative

Referenced models: Get available transitions — response body — available Transitions array item transitions array item to status Id, status Name

Get available transitions — response body — available Transitions array item transitions array item to status Id, status Name

Field	Type	Presence	Description and constraints
`$`	object	Root
`statusId`	JSON	Optional
`statusId (anyOf 1)`	JSON	Alternative
`statusId (anyOf 1) (anyOf 1)`	integer	Alternative	The unique ID of the status. Format: int32 Read only: true
`statusId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`statusId (anyOf 2)`	null	Alternative
`statusName`	JSON	Optional
`statusName (anyOf 1)`	string	Alternative	The name of the status. Read only: true
`statusName (anyOf 2)`	null	Alternative

Policy, approvals and errors

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