Atlassian: Get required status mappings for workflow scheme update

Atlassian workflowSchemes.getRequiredWorkflowSchemeMappings: arguments, response, policy and SDK examples.

← Workflow schemes operations · Get started

Operation atlassian.getrequiredworkflowschememappings

Provider route: POST /{cloudId}/rest/api/3/workflowscheme/update/mappings. 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"]["getRequiredWorkflowSchemeMappings"]>[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.getRequiredWorkflowSchemeMappings(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.get_required_workflow_scheme_mappings(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 Get required status mappings for workflow scheme update — request body — body

Referenced models: Get required status mappings for workflow scheme update — 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
`$`	Model	Root	Expand Get required status mappings for workflow scheme update — response body

Referenced models: Get required status mappings for workflow scheme update — response body

Schemas

Get required status mappings for workflow scheme update — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`statusMappingsByIssueTypes`	JSON	Optional
`statusMappingsByIssueTypes (anyOf 1)`	array	Alternative	The list of required status mappings by issue type. Unique items: true
`statusMappingsByIssueTypes (anyOf 1)[]`	Model	Each item	Expand Get required status mappings for workflow scheme update — response body — status Mappings By Issue Types The list of required status mappings by issue type item
`statusMappingsByIssueTypes (anyOf 2)`	null	Alternative
`statusMappingsByWorkflows`	JSON	Optional
`statusMappingsByWorkflows (anyOf 1)`	array	Alternative	The list of required status mappings by workflow. Unique items: true
`statusMappingsByWorkflows (anyOf 1)[]`	Model	Each item	Expand Get required status mappings for workflow scheme update — response body — status Mappings By Workflows The list of required status mappings by workflow item
`statusMappingsByWorkflows (anyOf 2)`	null	Alternative
`statuses`	JSON	Optional
`statuses (anyOf 1)`	array	Alternative	The details of the statuses in the associated workflows. Unique items: true
`statuses (anyOf 1)[]`	Model	Each item	Expand Get required status mappings for workflow scheme update — response body — statuses array item
`statuses (anyOf 2)`	null	Alternative
`statusesPerWorkflow`	JSON	Optional
`statusesPerWorkflow (anyOf 1)`	array	Alternative	The statuses associated with each workflow. Unique items: true
`statusesPerWorkflow (anyOf 1)[]`	Model	Each item	Expand Get required status mappings for workflow scheme update — response body — statuses Per Workflow The statuses associated with each workflow item
`statusesPerWorkflow (anyOf 2)`	null	Alternative

Referenced models: Get required status mappings for workflow scheme update — response body — status Mappings By Issue Types The list of required status mappings by issue type item, Get required status mappings for workflow scheme update — response body — status Mappings By Workflows The list of required status mappings by workflow item, Get required status mappings for workflow scheme update — response body — statuses array item, Get required status mappings for workflow scheme update — response body — statuses Per Workflow The statuses associated with each workflow item

Get required status mappings for workflow scheme update — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	The request payload to get the required mappings for updating a workflow scheme. Additional keys: not allowed
`defaultWorkflowId`	JSON	Optional
`defaultWorkflowId (anyOf 1)`	string	Alternative	The ID of the new default workflow for this workflow scheme. Only used in global-scoped workflow schemes. If it isn't specified, is set to Jira Workflow (jira).
`defaultWorkflowId (anyOf 2)`	null	Alternative
`id`	string	Required within parent	The ID of the workflow scheme.
`workflowsForIssueTypes`	array	Required within parent	The new workflow to issue type mappings for this workflow scheme.
`workflowsForIssueTypes[]`	Model	Each item	Expand Update workflow scheme — request body — body workflows For Issue Types item

Referenced models: Update workflow scheme — request body — body workflows For Issue Types item

Get required status mappings for workflow scheme update — response body — status Mappings By Issue Types The list of required status mappings by issue type item

Field	Type	Presence	Description and constraints
`$`	object	Root	The list of required status mappings by issue type.
`issueTypeId`	JSON	Optional
`issueTypeId (anyOf 1)`	string	Alternative	The ID of the issue type.
`issueTypeId (anyOf 2)`	null	Alternative
`statusIds`	JSON	Optional
`statusIds (anyOf 1)`	array	Alternative	The status IDs requiring mapping. Unique items: true
`statusIds (anyOf 1)[]`	string	Each item	The status IDs requiring mapping.
`statusIds (anyOf 2)`	null	Alternative

Get required status mappings for workflow scheme update — response body — status Mappings By Workflows The list of required status mappings by workflow item

Field	Type	Presence	Description and constraints
`$`	object	Root	The list of required status mappings by workflow.
`sourceWorkflowId`	JSON	Optional
`sourceWorkflowId (anyOf 1)`	string	Alternative	The ID of the source workflow.
`sourceWorkflowId (anyOf 2)`	null	Alternative
`statusIds`	JSON	Optional
`statusIds (anyOf 1)`	array	Alternative	The status IDs requiring mapping. Unique items: true
`statusIds (anyOf 1)[]`	string	Each item	The status IDs requiring mapping.
`statusIds (anyOf 2)`	null	Alternative
`targetWorkflowId`	JSON	Optional
`targetWorkflowId (anyOf 1)`	string	Alternative	The ID of the target workflow.
`targetWorkflowId (anyOf 2)`	null	Alternative

Get required status mappings for workflow scheme update — response body — statuses array item

Field	Type	Presence	Description and constraints
`$`	object	Root	The details of the statuses in the associated workflows.
`category`	JSON	Optional
`category (anyOf 1)`	string	Alternative	The category of the status. Known values: TODO, IN_PROGRESS, DONE
`category (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the status.
`id (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the status.
`name (anyOf 2)`	null	Alternative

Get required status mappings for workflow scheme update — response body — statuses Per Workflow The statuses associated with each workflow item

Field	Type	Presence	Description and constraints
`$`	object	Root	The statuses associated with each workflow.
`initialStatusId`	JSON	Optional
`initialStatusId (anyOf 1)`	string	Alternative	The ID of the initial status for the workflow.
`initialStatusId (anyOf 2)`	null	Alternative
`statuses`	JSON	Optional
`statuses (anyOf 1)`	array	Alternative	The status IDs associated with the workflow. Unique items: true
`statuses (anyOf 1)[]`	string	Each item	The status IDs associated with the workflow.
`statuses (anyOf 2)`	null	Alternative
`workflowId`	JSON	Optional
`workflowId (anyOf 1)`	string	Alternative	The ID of the workflow.
`workflowId (anyOf 2)`	null	Alternative

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.

Policy, approvals and errors

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