Atlassian: Get workflow schemes which are using a given workflow

← Workflows operations · Get started

Operation atlassian.getworkflowschemeusagesforworkflow

Provider route: GET /{cloudId}/rest/api/3/workflow/{workflowId}/workflowSchemes. 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"]["getWorkflowSchemeUsagesForWorkflow"]>[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.getWorkflowSchemeUsagesForWorkflow(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.get_workflow_scheme_usages_for_workflow(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.workflowId	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.nextPageToken	string	Optional
query.maxResults	integer	Optional	Default: 50 Format: int32

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 workflow schemes which are using a given workflow — response body

Referenced models: Get workflow schemes which are using a given workflow — response body

Schemas

Get workflow schemes which are using a given workflow — response body

Field	Type	Presence	Description and constraints
$	object	Root	Workflow schemes using the workflow.
workflowId	JSON	Optional
workflowId (anyOf 1)	string	Alternative	The workflow ID.
workflowId (anyOf 2)	null	Alternative
workflowSchemes	JSON	Optional
workflowSchemes (anyOf 1)	Model	Alternative	Expand Get workflow schemes which are using a given workflow — response body — workflow Schemes A page of workflow schemes
workflowSchemes (anyOf 2)	null	Alternative

Referenced models: Get workflow schemes which are using a given workflow — response body — workflow Schemes A page of workflow schemes

Get workflow schemes which are using a given workflow — response body — workflow Schemes A page of workflow schemes

Field	Type	Presence	Description and constraints
$	object	Root	A page of workflow schemes.
nextPageToken	JSON	Optional
nextPageToken (anyOf 1)	string	Alternative	Token for the next page of issue type usages.
nextPageToken (anyOf 2)	null	Alternative
values	JSON	Optional
values (anyOf 1)	array	Alternative	The list of workflow schemes.
values (anyOf 1)[]	Model	Each item	Expand Get workflow schemes which are using a given workflow — response body — workflow Schemes A page of workflow schemes values The list of workflow schemes item
values (anyOf 2)	null	Alternative

Referenced models: Get workflow schemes which are using a given workflow — response body — workflow Schemes A page of workflow schemes values The list of workflow schemes item

Get workflow schemes which are using a given workflow — response body — workflow Schemes A page of workflow schemes values The list of workflow schemes item

Field	Type	Presence	Description and constraints
$	object	Root	The worflow scheme.
id	JSON	Optional
id (anyOf 1)	string	Alternative	The workflow scheme ID.
id (anyOf 2)	null	Alternative

Policy, approvals and errors

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