POST /rest/api/2/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 required:
- At least one of the Administer projects and View (read-only) workflow project permissions
Servers
- https://your-domain.atlassian.net
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
projectId |
String | Yes |
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 | No |
The list of workflow IDs to be returned. At most 25 workflow IDs can be specified. |
workflowNames[] |
Array | No |
The list of workflow names to be returned. At most 25 workflow names can be specified. |
issueTypeIds[] |
Array | No |
The list of issue type IDs. At most 25 issue type IDs can be specified. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.