POST /rest/api/2/workflowscheme/project/switch

Switches a workflow scheme for a project.

Workflow schemes can only be assigned to classic projects.

Calculating required mappings: If statuses from the current workflow scheme won't exist in the target workflow scheme, you must provide mappingsByIssueTypeOverride to specify how issues with those statuses should be migrated. Use the required workflow scheme mappings API to determine which statuses and issue types require mappings.

Permissions required: Administer Jira global permission.

Servers

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 No

The ID of the project to switch the workflow scheme for

targetSchemeId String No

The ID of the target workflow scheme to switch to

mappingsByIssueTypeOverride[] Array No

The mappings for migrating issues from old statuses to new statuses when switching from one workflow scheme to another. This field is required if any statuses in the current project's workflows would no longer exist in the target workflow scheme. Each mapping defines how to update issues from an old status to the corresponding new status in the issue’s new workflow.

mappingsByIssueTypeOverride[].statusMappings[] Array No
mappingsByIssueTypeOverride[].statusMappings[].newStatusId String No
mappingsByIssueTypeOverride[].statusMappings[].oldStatusId String No
mappingsByIssueTypeOverride[].issueTypeId String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.