Atlassian: Search workflows

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

Operation atlassian.searchworkflows

Provider route: GET /{cloudId}/rest/api/3/workflows/search. 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"]["searchWorkflows"]>[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.searchWorkflows(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.search_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}$
`query`	object	Optional	Additional keys: not allowed
`query.startAt`	integer	Optional	Format: int64
`query.maxResults`	integer	Optional	Format: int32
`query.expand`	string	Optional
`query.queryString`	string	Optional
`query.orderBy`	string	Optional
`query.scope`	string	Optional
`query.isActive`	boolean	Optional
`query.projectId`	integer	Optional	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 Search workflows — response body

Referenced models: Search workflows — response body

Schemas

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

Search workflows — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Page of items, including workflows and related statuses.
`isLast`	JSON	Optional
`isLast (anyOf 1)`	boolean	Alternative	Whether this is the last page.
`isLast (anyOf 2)`	null	Alternative
`maxResults`	JSON	Optional
`maxResults (anyOf 1)`	JSON	Alternative
`maxResults (anyOf 1) (anyOf 1)`	integer	Alternative	The maximum number of items that could be returned. Format: int32
`maxResults (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`maxResults (anyOf 2)`	null	Alternative
`nextPage`	JSON	Optional
`nextPage (anyOf 1)`	string	Alternative	If there is another page of results, the URL of the next page.
`nextPage (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the page.
`self (anyOf 2)`	null	Alternative
`startAt`	JSON	Optional
`startAt (anyOf 1)`	JSON	Alternative
`startAt (anyOf 1) (anyOf 1)`	integer	Alternative	The index of the first item returned. Format: int64
`startAt (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`startAt (anyOf 2)`	null	Alternative
`statuses`	JSON	Optional
`statuses (anyOf 1)`	array	Alternative	List of statuses.
`statuses (anyOf 1)[]`	Model	Each item	Expand Search workflows — response body — statuses List of statuses item
`statuses (anyOf 2)`	null	Alternative
`total`	JSON	Optional
`total (anyOf 1)`	JSON	Alternative
`total (anyOf 1) (anyOf 1)`	integer	Alternative	The number of items returned. Format: int64
`total (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`total (anyOf 2)`	null	Alternative
`values`	JSON	Optional
`values (anyOf 1)`	array	Alternative	List of workflows.
`values (anyOf 1)[]`	Model	Each item	Expand Search workflows — response body — values List of workflows item
`values (anyOf 2)`	null	Alternative

Referenced models: Search workflows — response body — values List of workflows item, Search workflows — response body — statuses List of statuses item

Search workflows — response body — values List of workflows item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a workflow.
`created`	JSON	Optional
`created (anyOf 1)`	JSON	Alternative
`created (anyOf 1) (anyOf 1)`	string	Alternative	The creation date of the workflow.
`created (anyOf 1) (anyOf 2)`	null	Alternative
`created (anyOf 2)`	null	Alternative
`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
`isEditable`	JSON	Optional
`isEditable (anyOf 1)`	boolean	Alternative	Indicates if the workflow can be edited.
`isEditable (anyOf 2)`	null	Alternative
`loopedTransitionContainerLayout`	JSON	Optional
`loopedTransitionContainerLayout (anyOf 1)`	Model	Alternative	Expand Read workflow version from history — response body — workflows array item start Point Layout value
`loopedTransitionContainerLayout (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the workflow.
`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
`startPointLayout`	JSON	Optional
`startPointLayout (anyOf 1)`	Model	Alternative	Expand Read workflow version from history — response body — workflows array item start Point Layout value
`startPointLayout (anyOf 2)`	null	Alternative
`statuses`	JSON	Optional
`statuses (anyOf 1)`	array	Alternative	The statuses referenced in this workflow. Unique items: true
`statuses (anyOf 1)[]`	Model	Each item	Expand Read workflow version from history — response body — workflows array item statuses array item
`statuses (anyOf 2)`	null	Alternative
`taskId`	JSON	Optional
`taskId (anyOf 1)`	JSON	Alternative
`taskId (anyOf 1) (anyOf 1)`	string	Alternative	If there is a current [asynchronous task](#async-operations) operation for this workflow.
`taskId (anyOf 1) (anyOf 2)`	null	Alternative
`taskId (anyOf 2)`	null	Alternative
`transitions`	JSON	Optional
`transitions (anyOf 1)`	array	Alternative	The transitions of the workflow. Unique items: true
`transitions (anyOf 1)[]`	Model	Each item	Expand Read workflow version from history — response body — workflows array item transitions array item
`transitions (anyOf 2)`	null	Alternative
`updated`	JSON	Optional
`updated (anyOf 1)`	JSON	Alternative
`updated (anyOf 1) (anyOf 1)`	string	Alternative	The last edited date of the workflow.
`updated (anyOf 1) (anyOf 2)`	null	Alternative
`updated (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, Read workflow version from history — response body — workflows array item start Point Layout value, Bulk get workflow schemes — response body — item scope The scope of the workflow, Read workflow version from history — response body — workflows array item statuses array item, Read workflow version from history — response body — workflows array item transitions array item

Search workflows — response body — statuses List of statuses 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
`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.
`statusReference (anyOf 2)`	null	Alternative

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

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.searchworkflows. Catalog operation: searchworkflows. 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