Atlassian: Update workflow scheme

← Workflow schemes operations · Get started

Operation atlassian.updateschemes

Provider route: POST /{cloudId}/rest/api/3/workflowscheme/update. 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["workflowSchemes"]["updateSchemes"]>[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.workflowSchemes.updateSchemes(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.workflow_schemes.update_schemes(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}$
body	Model	Required within parent	Expand Update workflow scheme — request body — body

Referenced models: Update workflow scheme — 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

Update workflow scheme — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	The update workflow scheme payload. Additional keys: allowed
defaultWorkflowId	string	Optional	The ID of the workflow for issue types without having a mapping defined in this workflow scheme. Only used in global-scoped workflow schemes. If the `defaultWorkflowId` isn't specified, this is set to *Jira Workflow (jira)*.
description	string	Required within parent	The new description for this workflow scheme.
id	string	Required within parent	The ID of this workflow scheme.
name	string	Required within parent	The new name for this workflow scheme.
statusMappingsByIssueTypeOverride	array	Optional	Overrides, for the selected issue types, any status mappings provided in `statusMappingsByWorkflows`. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`.
statusMappingsByIssueTypeOverride[]	Model	Each item	Expand Switch workflow scheme for project — request body — body mappings By Issue Type Override item
statusMappingsByWorkflows	array	Optional	The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`.
statusMappingsByWorkflows[]	Model	Each item	Expand Update workflow scheme — request body — body status Mappings By Workflows item
version	Model	Required within parent	Expand Update workflow scheme — request body — body version
workflowsForIssueTypes	array	Optional	Mappings from workflows to issue types.
workflowsForIssueTypes[]	Model	Each item	Expand Update workflow scheme — request body — body workflows For Issue Types item

Referenced models: Update workflow scheme — request body — body version, Switch workflow scheme for project — request body — body mappings By Issue Type Override item, Update workflow scheme — request body — body status Mappings By Workflows item, Update workflow scheme — request body — body workflows For Issue Types item

Update workflow scheme — request body — body version

Field	Type	Presence	Description and constraints
$	object	Root	The current version details of this workflow scheme. Additional keys: not allowed
id	string	Optional	The version UUID.
versionNumber	integer	Optional	The version number. Format: int64

Switch workflow scheme for project — request body — body mappings By Issue Type Override item

Field	Type	Presence	Description and constraints
$	object	Root	The mappings for migrating issues from old statuses to new statuses when switching from one workflow scheme to another. This field is required if any statuses in the current project's workflows would no longer exist in the target workflow scheme. Each mapping defines how to update issues from an old status to the corresponding new status in the issue’s new workflow. Additional keys: not allowed
issueTypeId	string	Optional
statusMappings	array	Optional
statusMappings[]	Model	Each item	Expand Update workflow scheme — request body — body status Mappings By Workflows item status Mappings item

Referenced models: Update workflow scheme — request body — body status Mappings By Workflows item status Mappings item

Update workflow scheme — request body — body status Mappings By Workflows item

Field	Type	Presence	Description and constraints
$	object	Root	The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`. Additional keys: not allowed
newWorkflowId	string	Required within parent	The ID of the new workflow.
oldWorkflowId	string	Required within parent	The ID of the old workflow.
statusMappings	array	Required within parent	The list of status mappings.
statusMappings[]	Model	Each item	Expand Update workflow scheme — request body — body status Mappings By Workflows item status Mappings item

Referenced models: Update workflow scheme — request body — body status Mappings By Workflows item status Mappings item

Update workflow scheme — request body — body workflows For Issue Types item

Field	Type	Presence	Description and constraints
$	object	Root	The explicit association between issue types and a workflow in a workflow scheme. Additional keys: not allowed
issueTypeIds	array	Required within parent	The issue types assigned to the workflow. Unique items: true
issueTypeIds[]	string	Each item	The issue types assigned to the workflow.
workflowId	string	Required within parent	The ID of the workflow.

Update workflow scheme — request body — body status Mappings By Workflows item status Mappings item

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
newStatusId	string	Optional
oldStatusId	string	Optional

Policy, approvals and errors

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