Atlassian: Preview workflow
Atlassian workflows.readWorkflowPreviews: arguments, response, policy and SDK examples.
← Workflows operations · Get started
Operation atlassian.readworkflowpreviews
Provider route: POST /{cloudId}/rest/api/3/workflows/preview. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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"]["readWorkflowPreviews"]>[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.readWorkflowPreviews(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.read_workflow_previews(arguments) result = await call.wait() return result.body_json()| 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 Preview workflow — request body — body |
Referenced models: Preview workflow — request body — body
Response
Section titled “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 Preview workflow — response body |
Referenced models: Preview workflow — response body
Schemas
Section titled “Schemas”11 more schemas are linked from the tables above, on the schema pages.
Preview workflow — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The preview workflow response containing workflows and statuses. |
statuses | JSON | Optional | |
statuses (anyOf 1) | array | Alternative | The list of statuses referenced by the workflows. |
statuses (anyOf 1)[] | Model | Each item | Expand Preview workflow — response body — statuses The list of statuses referenced by the workflows item |
statuses (anyOf 2) | null | Alternative | |
workflows | JSON | Optional | |
workflows (anyOf 1) | array | Alternative | The list of workflows. The workflows are returned in the same order as specified in the request. |
workflows (anyOf 1)[] | Model | Each item | Expand Preview workflow — response body — workflows array item |
workflows (anyOf 2) | null | Alternative |
Referenced models: Preview workflow — response body — statuses The list of statuses referenced by the workflows item, Preview workflow — response body — workflows array item
Preview workflow — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The details of the preview workflow request. Additional keys: not allowed |
issueTypeIds | array | Optional | The list of issue type IDs. At most 25 issue type IDs can be specified. Maximum items: 25 Minimum items: 0 |
issueTypeIds[] | string | Each item | The list of issue type IDs. At most 25 issue type IDs can be specified. |
projectId | string | Required within parent | The projectId parameter is required and will be used for permission checks. In addition, you must supply at least one of the following lookup terms: *workflowNames*, *workflowIds*, or *issueTypeIds*. The specified workflows must be associated with the given project. |
workflowIds | array | Optional | The list of workflow IDs to be returned. At most 25 workflow IDs can be specified. Maximum items: 25 Minimum items: 0 |
workflowIds[] | string | Each item | The list of workflow IDs to be returned. At most 25 workflow IDs can be specified. |
workflowNames | array | Optional | The list of workflow names to be returned. At most 25 workflow names can be specified. Maximum items: 25 Minimum items: 0 |
workflowNames[] | string | Each item | The list of workflow names to be returned. At most 25 workflow names can be specified. |
Preview workflow — response body — statuses The list of statuses referenced by the workflows item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a status. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the status. |
description (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 | |
rawName | JSON | Optional | |
rawName (anyOf 1) | string | Alternative | The raw name of the status. |
rawName (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 | |
statusCategory | JSON | Optional | |
statusCategory (anyOf 1) | string | Alternative | The category of the status. Known values: TODO, IN_PROGRESS, DONE |
statusCategory (anyOf 2) | null | Alternative | |
statusReference | JSON | Optional | |
statusReference (anyOf 1) | string | Alternative | The reference of the status. Unique within this response but not guaranteed to be stable across requests. |
statusReference (anyOf 2) | null | Alternative |
Referenced models: Bulk get workflow schemes — response body — item scope The scope of the workflow
Preview workflow — response body — workflows array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a workflow. |
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 | |
loopedTransitionContainerLayout | JSON | Optional | |
loopedTransitionContainerLayout (anyOf 1) | Model | Alternative | Expand Preview workflow — response body — workflows array item start Point Layout Layout coordinates for workflow elements |
loopedTransitionContainerLayout (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the workflow. |
name (anyOf 2) | null | Alternative | |
queryContext | JSON | Optional | |
queryContext (anyOf 1) | array | Alternative | The project and issue type context for this workflow query. |
queryContext (anyOf 1)[] | Model | Each item | Expand Preview workflow — response body — workflows array item query Context array item |
queryContext (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 | |
startPointLayout | JSON | Optional | |
startPointLayout (anyOf 1) | Model | Alternative | Expand Preview workflow — response body — workflows array item start Point Layout Layout coordinates for workflow elements |
startPointLayout (anyOf 2) | null | Alternative | |
statuses | JSON | Optional | |
statuses (anyOf 1) | array | Alternative | The statuses referenced in this workflow. |
statuses (anyOf 1)[] | Model | Each item | Expand Preview workflow — response body — workflows array item statuses The statuses referenced in this workflow item |
statuses (anyOf 2) | null | Alternative | |
transitions | JSON | Optional | |
transitions (anyOf 1) | array | Alternative | The transitions of the workflow. |
transitions (anyOf 1)[] | Model | Each item | Expand Preview workflow — response body — workflows array item transitions The transitions of the workflow item |
transitions (anyOf 2) | null | Alternative | |
version | JSON | Optional | |
version (anyOf 1) | Model | Alternative | Expand Preview workflow — response body — workflows array item version The version details of the workflow |
version (anyOf 2) | null | Alternative |
Referenced models: Preview workflow — response body — workflows array item query Context array item, Preview workflow — response body — workflows array item transitions The transitions of the workflow item, Preview workflow — response body — workflows array item version The version details of the workflow, Preview workflow — response body — workflows array item start Point Layout Layout coordinates for workflow elements, Bulk get workflow schemes — response body — item scope The scope of the workflow, Preview workflow — response body — workflows array item statuses The statuses referenced in this workflow item
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
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: atlassian.readworkflowpreviews. Catalog operation: readworkflowpreviews. 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"]