Atlassian: Validate update workflows

← Workflows operations · Get started

Operation atlassian.validateupdateworkflows

Provider route: POST /{cloudId}/rest/api/3/workflows/update/validation. 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"]["validateUpdateWorkflows"]>[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.validateUpdateWorkflows(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.validate_update_workflows(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 Validate update workflows — request body — body

Referenced models: Validate update workflows — 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 Validate create workflows — response body

Referenced models: Validate create workflows — response body

Schemas

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

Validate create workflows — response body

Field	Type	Presence	Description and constraints
$	object	Root
errors	JSON	Optional
errors (anyOf 1)	array	Alternative	The list of validation errors.
errors (anyOf 1)[]	Model	Each item	Expand Validate create workflows — response body — errors The list of validation errors item
errors (anyOf 2)	null	Alternative

Referenced models: Validate create workflows — response body — errors The list of validation errors item

Validate update workflows — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
payload	Model	Required within parent	Expand Bulk update workflows — request body — body
validationOptions	Model	Optional	Expand Validate create workflows — request body — body validation Options

Referenced models: Validate create workflows — request body — body validation Options, Bulk update workflows — request body — body

Validate create workflows — response body — errors The list of validation errors item

Field	Type	Presence	Description and constraints
$	object	Root	The details about a workflow validation error.
additionalDetails	JSON	Optional
additionalDetails (anyOf 1)	string	Alternative	Additional details about the validation error.
additionalDetails (anyOf 2)	null	Alternative
code	JSON	Optional
code (anyOf 1)	string	Alternative	An error code.
code (anyOf 2)	null	Alternative
elementReference	JSON	Optional
elementReference (anyOf 1)	Model	Alternative	Expand Validate create workflows — response body — errors The list of validation errors item element Reference property Key, rule Id, status Mapping Reference, status Reference, transition Id
elementReference (anyOf 2)	null	Alternative
level	JSON	Optional
level (anyOf 1)	string	Alternative	The validation error level. Known values: WARNING, ERROR
level (anyOf 2)	null	Alternative
message	JSON	Optional
message (anyOf 1)	string	Alternative	An error message.
message (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The type of element the error or warning references. Known values: RULE, STATUS, STATUS_LAYOUT, STATUS_PROPERTY, WORKFLOW, TRANSITION, TRANSITION_PROPERTY, SCOPE, STATUS_MAPPING, TRIGGER
type (anyOf 2)	null	Alternative

Referenced models: Validate create workflows — response body — errors The list of validation errors item element Reference property Key, rule Id, status Mapping Reference, status Reference, transition Id

Validate create workflows — request body — body validation Options

Field	Type	Presence	Description and constraints
$	object	Root	The level of validation to return from the API. If no values are provided, the default would return `WARNING` and `ERROR` level validation results. Additional keys: not allowed
levels	array	Optional	Maximum items: 2
levels[]	string	Each item	One of: WARNING, ERROR

Bulk update workflows — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	The update workflows payload. Additional keys: not allowed
statuses	array	Optional	The statuses to associate with the workflows. Maximum: 1000
statuses[]	Model	Each item	Expand Bulk create workflows — request body — body statuses item
workflows	array	Optional	The details of the workflows to update. Maximum: 20
workflows[]	Model	Each item	Expand Bulk update workflows — request body — body workflows item

Referenced models: Bulk create workflows — request body — body statuses item, Bulk update workflows — request body — body workflows item

Validate create workflows — response body — errors The list of validation errors item element Reference property Key, rule Id, status Mapping Reference, status Reference, transition Id

Field	Type	Presence	Description and constraints
$	object	Root	A reference to the location of the error. This will be null if the error does not refer to a specific element.
propertyKey	JSON	Optional
propertyKey (anyOf 1)	string	Alternative	A property key.
propertyKey (anyOf 2)	null	Alternative
ruleId	JSON	Optional
ruleId (anyOf 1)	string	Alternative	A rule ID.
ruleId (anyOf 2)	null	Alternative
statusMappingReference	JSON	Optional
statusMappingReference (anyOf 1)	Model	Alternative	Expand Validate create workflows — response body — errors The list of validation errors item element Reference property Key, rule Id, status Mapping Reference, status Reference, transition Id status Mapping Reference issue Type Id, project Id
statusMappingReference (anyOf 2)	null	Alternative
statusReference	JSON	Optional
statusReference (anyOf 1)	string	Alternative	A status reference.
statusReference (anyOf 2)	null	Alternative
transitionId	JSON	Optional
transitionId (anyOf 1)	string	Alternative	A transition ID.
transitionId (anyOf 2)	null	Alternative

Referenced models: Validate create workflows — response body — errors The list of validation errors item element Reference property Key, rule Id, status Mapping Reference, status Reference, transition Id status Mapping Reference issue Type Id, project Id

Bulk create workflows — request body — body statuses item

Field	Type	Presence	Description and constraints
$	object	Root	Details of the status being updated. Maximum: 1000 Additional keys: allowed
description	string	Optional	The description of the status.
id	string	Optional	The ID of the status. When reusing an existing status, this field should be provided.
name	string	Required within parent	The name of the status.
statusCategory	string	Required within parent	The category of the status. One of: TODO, IN_PROGRESS, DONE
statusReference	string	Required within parent	The reference of the status. If adding a new status to a team-managed workflow, this must be a UUID (for company-managed a UUID is not needed).

Validate create workflows — response body — errors The list of validation errors item element Reference property Key, rule Id, status Mapping Reference, status Reference, transition Id status Mapping Reference issue Type Id, project Id

Field	Type	Presence	Description and constraints
$	object	Root	A project and issueType ID pair that identifies a status mapping.
issueTypeId	JSON	Optional
issueTypeId (anyOf 1)	string	Alternative	The ID of the issue type.
issueTypeId (anyOf 2)	null	Alternative
projectId	JSON	Optional
projectId (anyOf 1)	string	Alternative	The ID of the project.
projectId (anyOf 2)	null	Alternative

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

Bulk create workflows — request body — body workflows item statuses item

Field	Type	Presence	Description and constraints
$	object	Root	The statuses associated with this workflow. Additional keys: allowed
approvalConfiguration	Model	Optional	Expand Bulk create workflows — request body — body workflows item statuses item approval Configuration
layout	Model	Optional	Expand Bulk create workflows — request body — body workflows item start Point Layout
properties	object	Required within parent	The properties for this status layout. Additional keys: see wildcard field
properties.*	string	Additional keys	The properties for this status layout.
statusReference	string	Required within parent	A unique ID which the status will use to refer to this layout configuration.

Referenced models: Bulk create workflows — request body — body workflows item statuses item approval Configuration, Bulk create workflows — request body — body workflows item start Point Layout

Policy, approvals and errors

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