POST /rest/api/2/workflowscheme

Creates a workflow scheme.

Permissions required: Administer Jira global permission.

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
`draft`	Boolean	No	Whether the workflow scheme is a draft or not.
`id`	Integer	No	The ID of the workflow scheme.
`lastModified`	String	No	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.
`defaultWorkflow`	String	No	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).
`updateDraftIfNeeded`	Boolean	No	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`.
`name`	String	No	The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.
`originalDefaultWorkflow`	String	No	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.
`description`	String	No	The description of the workflow scheme.
`self`	String	No
`issueTypeMappings`	Object	No	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.
`issueTypes`	Object	No	The issue types available in Jira.
`issueTypes.name`	Object	No	Details about an issue type.
`issueTypes.name.id`	String	No	The ID of the issue type.
`issueTypes.name.name`	String	No	The name of the issue type.
`issueTypes.name.description`	String	No	The description of the issue type.
`issueTypes.name.self`	String	No	The URL of these issue type details.
`issueTypes.name.subtask`	Boolean	No	Whether this issue type is used to create subtasks.
`issueTypes.name.iconUrl`	String	No	The URL of the issue type's avatar.
`issueTypes.name.entityId`	String	No	Unique ID for next-gen projects.
`issueTypes.name.hierarchyLevel`	Integer	No	Hierarchy level of the issue type.
`issueTypes.name.avatarId`	Integer	No	The ID of the issue type's avatar.
`originalIssueTypeMappings`	Object	No	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.

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.