Workflows

Preview workflow

Returns a requested workflow within a given project. The response provides a read-only preview of the workflow, omitting full configuration details.

Permissions required:

  • At least one of the Administer projects and View (read-only) workflow project permissions
post/rest/api/2/workflows/preview

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/workflows/preview
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: manage:jira-configuration)

Request body

issueTypeIdsstring[]

The list of issue type IDs. At most 25 issue type IDs can be specified.

projectIdstring required

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.

workflowIdsstring[]

The list of workflow IDs to be returned. At most 25 workflow IDs can be specified.

workflowNamesstring[]

The list of workflow names to be returned. At most 25 workflow names can be specified.

Response

Returned if the request is successful.

Changes

No recorded changes to this operation across all 26 revisions of this API.