Create workflow scheme

POST

/rest/api/3/workflowscheme

Creates a workflow scheme.

Permissions required: Administer Jira global permission.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/workflowscheme' \
--header 'Content-Type: application/json' \
--data-raw '{
    "defaultWorkflow": "jira",
    "description": "The description of the example workflow scheme.",
    "issueTypeMappings": {
        "10000": "scrum workflow",
        "10001": "builds workflow"
    },
    "name": "Example workflow scheme"
}'

Response Example

201 - Success

{"id":101010,"name":"Example workflow scheme","description":"The description of the example workflow scheme.","defaultWorkflow":"jira","issueTypeMappings":{"10000":"scrum workflow","10001":"builds workflow"},"draft":false,"self":"https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"}

Request

Body Params application/json

Details about a workflow scheme.

defaultWorkflow

string

optional

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).

description

string

optional

The description of the workflow scheme.

issueTypeMappings

object

optional

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.

Additional properties

string

optional

name

string

optional

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

updateDraftIfNeeded

boolean

optional

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.

Examples

Responses

🟢201Returned if the request is successful.

application/json

Body

Details about a workflow scheme.

defaultWorkflow

string

optional

description

string

optional

The description of the workflow scheme.

draft

boolean

read-onlyoptional

Whether the workflow scheme is a draft or not.

integer <int64>

read-onlyoptional

The ID of the workflow scheme.

issueTypeMappings

object

optional

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.

Additional properties

string

optional

issueTypes

object

read-onlyoptional

The issue types available in Jira.

Additional properties

object (IssueTypeDetails)

optional

Details about an issue type.

lastModified

string

read-onlyoptional

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.

lastModifiedUser

object

read-onlyoptional

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

name

string

optional

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

read-onlyoptional

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.

originalIssueTypeMappings

object

read-onlyoptional

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.

Additional properties

string

read-onlyoptional

self

string <uri>

read-onlyoptional

updateDraftIfNeeded

boolean

optional

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.

🟠400Returned if the request is invalid.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user does not have the necessary permission.

Modified at 2023-07-13 03:27:27

Get all workflow schemes

Get workflow scheme