PUT /rest/api/2/workflowscheme/{id}/workflow
Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow.
Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded
to true
in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira.
Permissions required: Administer Jira global permission.
Servers
- https://your-domain.atlassian.net
Path parameters
Name | Type | Required | Description |
---|---|---|---|
id |
Integer | Yes |
The ID of the workflow scheme. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
workflowName |
String | Yes |
The name of the workflow. |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
updateDraftIfNeeded |
Boolean | No |
Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to |
defaultMapping |
Boolean | No |
Whether the workflow is the default workflow for the workflow scheme. |
issueTypes[] |
Array | No |
The list of issue type IDs. |
workflow |
String | No |
The name of the workflow. Optional if updating the workflow-issue types mapping. |
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.