Atlassian: Get available workflow capabilities

Atlassian workflows.workflowCapabilities: arguments, response, policy and SDK examples.

Operation atlassian.workflowcapabilities

Provider route: GET /{cloudId}/rest/api/3/workflows/capabilities. 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["workflows"]["workflowCapabilities"]>[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.workflows.workflowCapabilities(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.workflows.workflow_capabilities(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.workflowId`	string	Optional
`query.projectId`	string	Optional
`query.issueTypeId`	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 workflow capabilities — response body

Referenced models: Get available workflow capabilities — response body

Schemas

Get available workflow capabilities — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`connectRules`	JSON	Optional
`connectRules (anyOf 1)`	array	Alternative	The Connect provided ecosystem rules available.
`connectRules (anyOf 1)[]`	Model	Each item	Expand Get available workflow capabilities — response body — connect Rules The Connect provided ecosystem rules available item
`connectRules (anyOf 2)`	null	Alternative
`editorScope`	JSON	Optional
`editorScope (anyOf 1)`	string	Alternative	The scope of the workflow capabilities. `GLOBAL` for company-managed projects and `PROJECT` for team-managed projects. Known values: PROJECT, GLOBAL
`editorScope (anyOf 2)`	null	Alternative
`forgeRules`	JSON	Optional
`forgeRules (anyOf 1)`	array	Alternative	The Forge provided ecosystem rules available.
`forgeRules (anyOf 1)[]`	Model	Each item	Expand Get available workflow capabilities — response body — forge Rules The Forge provided ecosystem rules available item
`forgeRules (anyOf 2)`	null	Alternative
`projectTypes`	JSON	Optional
`projectTypes (anyOf 1)`	array	Alternative	The types of projects that this capability set is available for.
`projectTypes (anyOf 1)[]`	string	Each item	Known values: software, service_desk, product_discovery, business, unknown
`projectTypes (anyOf 2)`	null	Alternative
`systemRules`	JSON	Optional
`systemRules (anyOf 1)`	array	Alternative	The Atlassian provided system rules available.
`systemRules (anyOf 1)[]`	Model	Each item	Expand Get available workflow capabilities — response body — system Rules The Atlassian provided system rules available item
`systemRules (anyOf 2)`	null	Alternative
`triggerRules`	JSON	Optional
`triggerRules (anyOf 1)`	array	Alternative	The trigger rules available.
`triggerRules (anyOf 1)[]`	Model	Each item	Expand Get available workflow capabilities — response body — trigger Rules The trigger rules available item
`triggerRules (anyOf 2)`	null	Alternative

Referenced models: Get available workflow capabilities — response body — connect Rules The Connect provided ecosystem rules available item, Get available workflow capabilities — response body — forge Rules The Forge provided ecosystem rules available item, Get available workflow capabilities — response body — system Rules The Atlassian provided system rules available item, Get available workflow capabilities — response body — trigger Rules The trigger rules available item

Get available workflow capabilities — response body — connect Rules The Connect provided ecosystem rules available item

Field	Type	Presence	Description and constraints
`$`	object	Root	The Connect provided ecosystem rules available.
`addonKey`	JSON	Optional
`addonKey (anyOf 1)`	string	Alternative	The add-on providing the rule.
`addonKey (anyOf 2)`	null	Alternative
`createUrl`	JSON	Optional
`createUrl (anyOf 1)`	string	Alternative	The URL creation path segment defined in the Connect module.
`createUrl (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The rule description.
`description (anyOf 2)`	null	Alternative
`editUrl`	JSON	Optional
`editUrl (anyOf 1)`	string	Alternative	The URL edit path segment defined in the Connect module.
`editUrl (anyOf 2)`	null	Alternative
`moduleKey`	JSON	Optional
`moduleKey (anyOf 1)`	string	Alternative	The module providing the rule.
`moduleKey (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The rule name.
`name (anyOf 2)`	null	Alternative
`ruleKey`	JSON	Optional
`ruleKey (anyOf 1)`	string	Alternative	The rule key.
`ruleKey (anyOf 2)`	null	Alternative
`ruleType`	JSON	Optional
`ruleType (anyOf 1)`	string	Alternative	The rule type. Known values: Condition, Validator, Function, Screen
`ruleType (anyOf 2)`	null	Alternative
`viewUrl`	JSON	Optional
`viewUrl (anyOf 1)`	string	Alternative	The URL view path segment defined in the Connect module.
`viewUrl (anyOf 2)`	null	Alternative

Get available workflow capabilities — response body — forge Rules The Forge provided ecosystem rules available item

Field	Type	Presence	Description and constraints
`$`	object	Root	The Forge provided ecosystem rules available.
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The rule description.
`description (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The unique ARI of the forge rule type.
`id (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The rule name.
`name (anyOf 2)`	null	Alternative
`ruleKey`	JSON	Optional
`ruleKey (anyOf 1)`	string	Alternative	The rule key.
`ruleKey (anyOf 2)`	null	Alternative
`ruleType`	JSON	Optional
`ruleType (anyOf 1)`	string	Alternative	The rule type. Known values: Condition, Validator, Function, Screen
`ruleType (anyOf 2)`	null	Alternative

Get available workflow capabilities — response body — system Rules The Atlassian provided system rules available item

Field	Type	Presence	Description and constraints
`$`	object	Root	The Atlassian provided system rules available.
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The rule description.
`description (anyOf 2)`	null	Alternative
`incompatibleRuleKeys`	JSON	Optional
`incompatibleRuleKeys (anyOf 1)`	array	Alternative	List of rules that conflict with this one.
`incompatibleRuleKeys (anyOf 1)[]`	string	Each item	List of rules that conflict with this one.
`incompatibleRuleKeys (anyOf 2)`	null	Alternative
`isAvailableForInitialTransition`	JSON	Optional
`isAvailableForInitialTransition (anyOf 1)`	boolean	Alternative	Whether the rule can be added added to an initial transition.
`isAvailableForInitialTransition (anyOf 2)`	null	Alternative
`isVisible`	JSON	Optional
`isVisible (anyOf 1)`	boolean	Alternative	Whether the rule is visible.
`isVisible (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The rule name.
`name (anyOf 2)`	null	Alternative
`ruleKey`	JSON	Optional
`ruleKey (anyOf 1)`	string	Alternative	The rule key.
`ruleKey (anyOf 2)`	null	Alternative
`ruleType`	JSON	Optional
`ruleType (anyOf 1)`	string	Alternative	The rule type. Known values: Condition, Validator, Function, Screen
`ruleType (anyOf 2)`	null	Alternative

Get available workflow capabilities — response body — trigger Rules The trigger rules available item

Field	Type	Presence	Description and constraints
`$`	object	Root	The trigger rules available.
`availableTypes`	JSON	Optional
`availableTypes (anyOf 1)`	array	Alternative	The list of available trigger types.
`availableTypes (anyOf 1)[]`	Model	Each item	Expand Get available workflow capabilities — response body — trigger Rules The trigger rules available item available Types The list of available trigger types item
`availableTypes (anyOf 2)`	null	Alternative
`ruleKey`	JSON	Optional
`ruleKey (anyOf 1)`	string	Alternative	The rule key of the rule.
`ruleKey (anyOf 2)`	null	Alternative

Referenced models: Get available workflow capabilities — response body — trigger Rules The trigger rules available item available Types The list of available trigger types item

Get available workflow capabilities — response body — trigger Rules The trigger rules available item available Types The list of available trigger types item

Field	Type	Presence	Description and constraints
`$`	object	Root	The list of available trigger types.
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the trigger rule.
`description (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the trigger rule.
`name (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The type identifier of trigger rule.
`type (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.workflowcapabilities. Catalog operation: workflowcapabilities. 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: ["manage:jira-configuration"]

Official provider source

Report an issue with this page