provider Workflows POST /rest/api/3/workflows/preview
@utdk/jira /rest/api/3/workflows/preview
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](#permissions) required:** * At least one of the *Administer projects* and *View (read-only) workflow* project permissions

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

readworkflowpreviews
POST/rest/api/3/workflows/preview
Returns a requested workflow within a given project. The response provides a read-only preview of the workflow, omitting full configuration details. **[Permissions](#permissions) required:** * At least one of the *Administer projects* and *View (read-only) workflow* project permissions

Input

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

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.

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

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

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.readworkflowpreviews()