Atlassian: Get draft workflow scheme

Atlassian workflowSchemeDrafts.getWorkflowSchemeDraft: arguments, response, policy and SDK examples.

← Workflow scheme drafts operations · Get started

Operation atlassian.getworkflowschemedraft

Provider route: GET /{cloudId}/rest/api/3/workflowscheme/{id}/draft. 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["workflowSchemeDrafts"]["getWorkflowSchemeDraft"]>[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.workflowSchemeDrafts.getWorkflowSchemeDraft(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_scheme_drafts.get_workflow_scheme_draft(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.id`	integer	Required within parent	Format: int64

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 scheme — response body

Referenced models: Get workflow scheme — response body

Schemas

8 more schemas are linked from the tables above, on the schema pages.

Get workflow scheme — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about a workflow scheme.
`defaultWorkflow`	JSON	Optional
`defaultWorkflow (anyOf 1)`	string	Alternative	The name of the default workflow for the workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira. If `defaultWorkflow` is not specified when creating a workflow scheme, it is set to Jira Workflow (jira).
`defaultWorkflow (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the workflow scheme.
`description (anyOf 2)`	null	Alternative
`draft`	JSON	Optional
`draft (anyOf 1)`	boolean	Alternative	Whether the workflow scheme is a draft or not. Read only: true
`draft (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	JSON	Alternative
`id (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the workflow scheme. Format: int64 Read only: true
`id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id (anyOf 2)`	null	Alternative
`issueTypeMappings`	JSON	Optional
`issueTypeMappings (anyOf 1)`	object	Alternative	The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme. Additional keys: see wildcard field
`issueTypeMappings (anyOf 1).*`	string	Additional keys
`issueTypeMappings (anyOf 2)`	null	Alternative
`issueTypes`	JSON	Optional
`issueTypes (anyOf 1)`	object	Alternative	The issue types available in Jira. Read only: true Additional keys: see wildcard field
`issueTypes (anyOf 1).*`	Model	Additional keys	Expand Get issue type — response body
`issueTypes (anyOf 2)`	null	Alternative
`lastModified`	JSON	Optional
`lastModified (anyOf 1)`	string	Alternative	The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows. Read only: true
`lastModified (anyOf 2)`	null	Alternative
`lastModifiedUser`	JSON	Optional
`lastModifiedUser (anyOf 1)`	Model	Alternative	Expand Get user — response body The user that last modified the draft workflow scheme. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows. Read only: true
`lastModifiedUser (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.
`name (anyOf 2)`	null	Alternative
`originalDefaultWorkflow`	JSON	Optional
`originalDefaultWorkflow (anyOf 1)`	string	Alternative	For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira. Read only: true
`originalDefaultWorkflow (anyOf 2)`	null	Alternative
`originalIssueTypeMappings`	JSON	Optional
`originalIssueTypeMappings (anyOf 1)`	object	Alternative	For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme. Read only: true Additional keys: see wildcard field
`originalIssueTypeMappings (anyOf 1).*`	string	Additional keys	Read only: true
`originalIssueTypeMappings (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	Format: uri Read only: true
`self (anyOf 2)`	null	Alternative
`updateDraftIfNeeded`	JSON	Optional
`updateDraftIfNeeded (anyOf 1)`	boolean	Alternative	Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works: * Update an active workflow scheme with `updateDraftIfNeeded` set to `true`: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created. * Update an active workflow scheme with `updateDraftIfNeeded` set to `false`: An error is returned, as active workflow schemes cannot be updated. * Update an inactive workflow scheme with `updateDraftIfNeeded` set to `true`: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update. Defaults to `false`.
`updateDraftIfNeeded (anyOf 2)`	null	Alternative

Referenced models: Get issue type — response body, Get user — response body

Get issue type — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about an issue type.
`avatarId`	JSON	Optional
`avatarId (anyOf 1)`	JSON	Alternative
`avatarId (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the issue type's avatar. Format: int64 Read only: true
`avatarId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`avatarId (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the issue type. Read only: true
`description (anyOf 2)`	null	Alternative
`entityId`	JSON	Optional
`entityId (anyOf 1)`	string	Alternative	Unique ID for next-gen projects. Format: uuid Read only: true
`entityId (anyOf 2)`	null	Alternative
`hierarchyLevel`	JSON	Optional
`hierarchyLevel (anyOf 1)`	JSON	Alternative
`hierarchyLevel (anyOf 1) (anyOf 1)`	integer	Alternative	Hierarchy level of the issue type. Format: int32 Read only: true
`hierarchyLevel (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`hierarchyLevel (anyOf 2)`	null	Alternative
`iconUrl`	JSON	Optional
`iconUrl (anyOf 1)`	string	Alternative	The URL of the issue type's avatar. Read only: true
`iconUrl (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the issue type. Read only: true
`id (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the issue type. Read only: true
`name (anyOf 2)`	null	Alternative
`scope`	JSON	Optional
`scope (anyOf 1)`	Model	Alternative	Expand Get status — response body — scope project, type Details of the next-gen projects the issue type is available in. Read only: true
`scope (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of these issue type details. Read only: true
`self (anyOf 2)`	null	Alternative
`subtask`	JSON	Optional
`subtask (anyOf 1)`	boolean	Alternative	Whether this issue type is used to create subtasks. Read only: true
`subtask (anyOf 2)`	null	Alternative

Referenced models: Get status — response body — scope project, type

Get status — response body — scope project, type

Field	Type	Presence	Description and constraints
`$`	object	Root	The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). Additional keys: allowed
`project`	JSON	Optional
`project (anyOf 1)`	Model	Alternative	Expand Get issue type screen scheme projects — response body — values The list of items item The project the item has scope in. Read only: true
`project (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The type of scope. Known values: PROJECT, TEMPLATE Read only: true
`type (anyOf 2)`	null	Alternative

Referenced models: Get issue type screen scheme projects — response body — values The list of items item

Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48

Field	Type	Presence	Description and constraints
`$`	object	Root
`16x16`	JSON	Optional
`16x16 (anyOf 1)`	string	Alternative	The URL of the item's 16x16 pixel avatar. Format: uri
`16x16 (anyOf 2)`	null	Alternative
`24x24`	JSON	Optional
`24x24 (anyOf 1)`	string	Alternative	The URL of the item's 24x24 pixel avatar. Format: uri
`24x24 (anyOf 2)`	null	Alternative
`32x32`	JSON	Optional
`32x32 (anyOf 1)`	string	Alternative	The URL of the item's 32x32 pixel avatar. Format: uri
`32x32 (anyOf 2)`	null	Alternative
`48x48`	JSON	Optional
`48x48 (anyOf 1)`	string	Alternative	The URL of the item's 48x48 pixel avatar. Format: uri
`48x48 (anyOf 2)`	null	Alternative

Policy, approvals and errors

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