Atlassian: Validate create workflows

Atlassian workflows.validateCreateWorkflows: arguments, response, policy and SDK examples.

Operation atlassian.validatecreateworkflows

Provider route: POST /{cloudId}/rest/api/3/workflows/create/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"]["validateCreateWorkflows"]>[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.validateCreateWorkflows(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_create_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 create workflows — request body — body

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`payload`	Model	Required within parent	Expand Bulk create 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 create 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 create workflows — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	The create workflows payload. Additional keys: not allowed
`scope`	Model	Optional	Expand Bulk create workflows — request body — body scope
`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 create. Maximum: 20
`workflows[]`	Model	Each item	Expand Bulk create workflows — request body — body workflows item

Referenced models: Bulk create workflows — request body — body workflows item, Bulk create workflows — request body — body scope, Bulk create workflows — request body — body statuses 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

Bulk create workflows — request body — body workflows item

Field	Type	Presence	Description and constraints
`$`	object	Root	The details of the workflows to create. Maximum: 20 Additional keys: not allowed
`description`	string	Optional	The description of the workflow to create.
`loopedTransitionContainerLayout`	Model	Optional	Expand Bulk create workflows — request body — body workflows item start Point Layout
`name`	string	Required within parent	The name of the workflow to create.
`startPointLayout`	Model	Optional	Expand Bulk create workflows — request body — body workflows item start Point Layout
`statuses`	array	Required within parent	The statuses associated with this workflow.
`statuses[]`	Model	Each item	Expand Bulk create workflows — request body — body workflows item statuses item
`transitions`	array	Required within parent	The transitions of this workflow.
`transitions[]`	Model	Each item	Expand Bulk create workflows — request body — body workflows item transitions item

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

Bulk create workflows — request body — body scope

Field	Type	Presence	Description and constraints
`$`	object	Root	The scope of the workflow. Additional keys: not allowed
`project`	Model	Optional	Expand Bulk create statuses — request body — body scope project
`type`	string	Optional	The scope of the workflow. `GLOBAL` for company-managed projects and `PROJECT` for team-managed projects. One of: PROJECT, GLOBAL

Referenced models: Bulk create statuses — request body — body scope project

Bulk create statuses — request body — body scope project

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	object	Alternative	Project ID details. Additional keys: not allowed
`$ (anyOf 1).id`	string	Required within parent	The ID of the project.
`$ (anyOf 2)`	null	Alternative

Policy, approvals and errors

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