Atlassian: Bulk get workflow schemes

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

← Workflow schemes operations · Get started

Operation atlassian.readworkflowschemes

Provider route: POST /{cloudId}/rest/api/3/workflowscheme/read. 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"]["readWorkflowSchemes"]>[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.readWorkflowSchemes(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.read_workflow_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 Bulk get workflow schemes — request body — body

Referenced models: Bulk get workflow schemes — 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
`$`	array	Root
`$[]`	Model	Each item	Expand Bulk get workflow schemes — response body — item

Referenced models: Bulk get workflow schemes — response body — item

Schemas

Bulk get workflow schemes — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root
`defaultWorkflow`	JSON	Optional
`defaultWorkflow (anyOf 1)`	Model	Alternative	Expand Bulk get workflow schemes — response body — item default Workflow Workflow metadata and usage detail
`defaultWorkflow (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	JSON	Alternative
`description (anyOf 1) (anyOf 1)`	string	Alternative	The description of the workflow scheme.
`description (anyOf 1) (anyOf 2)`	null	Alternative
`description (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the workflow scheme.
`id (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the workflow scheme.
`name (anyOf 2)`	null	Alternative
`scope`	JSON	Optional
`scope (anyOf 1)`	Model	Alternative	Expand Bulk get workflow schemes — response body — item scope The scope of the workflow
`scope (anyOf 2)`	null	Alternative
`taskId`	JSON	Optional
`taskId (anyOf 1)`	JSON	Alternative
`taskId (anyOf 1) (anyOf 1)`	string	Alternative	Indicates if there's an [asynchronous task](#async-operations) for this workflow scheme.
`taskId (anyOf 1) (anyOf 2)`	null	Alternative
`taskId (anyOf 2)`	null	Alternative
`version`	JSON	Optional
`version (anyOf 1)`	Model	Alternative	Expand Bulk get workflow schemes — response body — item version id, version Number
`version (anyOf 2)`	null	Alternative
`workflowsForIssueTypes`	JSON	Optional
`workflowsForIssueTypes (anyOf 1)`	array	Alternative	Mappings from workflows to issue types.
`workflowsForIssueTypes (anyOf 1)[]`	Model	Each item	Expand Bulk get workflow schemes — response body — item workflows For Issue Types Mappings from workflows to issue types item
`workflowsForIssueTypes (anyOf 2)`	null	Alternative

Referenced models: Bulk get workflow schemes — response body — item version id, version Number, Bulk get workflow schemes — response body — item workflows For Issue Types Mappings from workflows to issue types item, Bulk get workflow schemes — response body — item default Workflow Workflow metadata and usage detail, Bulk get workflow schemes — response body — item scope The scope of the workflow

Bulk get workflow schemes — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	The workflow scheme read request body. Additional keys: not allowed
`projectIds`	JSON	Optional
`projectIds (anyOf 1)`	array	Alternative	The list of project IDs to query.
`projectIds (anyOf 1)[]`	JSON	Each item
`projectIds (anyOf 1)[] (anyOf 1)`	string	Alternative	The list of project IDs to query.
`projectIds (anyOf 1)[] (anyOf 2)`	null	Alternative
`projectIds (anyOf 2)`	null	Alternative
`workflowSchemeIds`	JSON	Optional
`workflowSchemeIds (anyOf 1)`	array	Alternative	The list of workflow scheme IDs to query.
`workflowSchemeIds (anyOf 1)[]`	JSON	Each item
`workflowSchemeIds (anyOf 1)[] (anyOf 1)`	string	Alternative	The list of workflow scheme IDs to query.
`workflowSchemeIds (anyOf 1)[] (anyOf 2)`	null	Alternative
`workflowSchemeIds (anyOf 2)`	null	Alternative

Bulk get workflow schemes — response body — item version id, version Number

Field	Type	Presence	Description and constraints
`$`	object	Root	The current version details of this workflow scheme.
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The version UUID.
`id (anyOf 2)`	null	Alternative
`versionNumber`	JSON	Optional
`versionNumber (anyOf 1)`	JSON	Alternative
`versionNumber (anyOf 1) (anyOf 1)`	integer	Alternative	The version number. Format: int64
`versionNumber (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`versionNumber (anyOf 2)`	null	Alternative

Bulk get workflow schemes — response body — item workflows For Issue Types Mappings from workflows to issue types item

Field	Type	Presence	Description and constraints
`$`	object	Root	The workflow metadata and issue type IDs which use this workflow.
`issueTypeIds`	JSON	Optional
`issueTypeIds (anyOf 1)`	array	Alternative	The list of issue type IDs for the mapping.
`issueTypeIds (anyOf 1)[]`	string	Each item	The list of issue type IDs for the mapping.
`issueTypeIds (anyOf 2)`	null	Alternative
`workflow`	JSON	Optional
`workflow (anyOf 1)`	Model	Alternative	Expand Bulk get workflow schemes — response body — item default Workflow Workflow metadata and usage detail
`workflow (anyOf 2)`	null	Alternative

Referenced models: Bulk get workflow schemes — response body — item default Workflow Workflow metadata and usage detail

Bulk get workflow schemes — response body — item default Workflow Workflow metadata and usage detail

Field	Type	Presence	Description and constraints
`$`	object	Root	Workflow metadata and usage detail.
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the workflow.
`description (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the workflow.
`id (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the workflow.
`name (anyOf 2)`	null	Alternative
`version`	JSON	Optional
`version (anyOf 1)`	Model	Alternative	Expand Bulk get workflow schemes — response body — item version id, version Number
`version (anyOf 2)`	null	Alternative

Referenced models: Bulk get workflow schemes — response body — item version id, version Number

Bulk get workflow schemes — response body — item scope The scope of the workflow

Field	Type	Presence	Description and constraints
`$`	object	Root	The scope of the workflow.
`project`	JSON	Optional
`project (anyOf 1)`	Model	Alternative	Expand Bulk get statuses — response body — item scope The scope of the status project value
`project (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The scope of the workflow. `GLOBAL` for company-managed projects and `PROJECT` for team-managed projects. Known values: PROJECT, GLOBAL
`type (anyOf 2)`	null	Alternative

Referenced models: Bulk get statuses — response body — item scope The scope of the status project value

Bulk get statuses — response body — item scope The scope of the status project value

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	object	Alternative	Project ID details.
`$ (anyOf 1).id`	JSON	Optional
`$ (anyOf 1).id (anyOf 1)`	string	Alternative	The ID of the project.
`$ (anyOf 1).id (anyOf 2)`	null	Alternative
`$ (anyOf 2)`	null	Alternative

Policy, approvals and errors

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