Sign in

v4

OpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Workflow schemes

Update default workflow

Sets the default workflow for a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

put/rest/api/3/workflowscheme/{id}/default

Path parameters

idinteger required

The ID of the workflow scheme.

Request body

updateDraftIfNeededboolean

Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to false.

workflowstring required

The name of the workflow to set as the default workflow.

Response

Returned if the request is successful.

defaultWorkflowstring

The name of the default workflow for the workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira. If defaultWorkflow is not specified when creating a workflow scheme, it is set to Jira Workflow (jira).

descriptionstring

The description of the workflow scheme.

draftboolean

Whether the workflow scheme is a draft or not.

idinteger

The ID of the workflow scheme.

issueTypeMappingsobject

The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.

issueTypesobject

The issue types available in Jira.

lastModifiedstring

The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.

namestring

The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.

originalDefaultWorkflowstring

For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira.

originalIssueTypeMappingsobject

For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.

selfstring uri
updateDraftIfNeededboolean

Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works:

  • Update an active workflow scheme with updateDraftIfNeeded set to true: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.
  • Update an active workflow scheme with updateDraftIfNeeded set to false: An error is returned, as active workflow schemes cannot be updated.
  • Update an inactive workflow scheme with updateDraftIfNeeded set to true: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.

Defaults to false.