- Announcement banner
- Issue custom field values (apps)
- Issue custom field configuration (apps)
- Jira settings
- Application roles
- Issue attachments
- Audit records
- Avatars
- Issue comments
- Issue comment properties
- Project components
- Time tracking
- Issue custom field options
- Dashboards
- Get all dashboards
- Create dashboard
- Get available gadgets
- Search for dashboards
- Get gadgets
- Add gadget to dashboard
- Update gadget on dashboard
- Remove gadget from dashboard
- Get dashboard item property keys
- Get dashboard item property
- Set dashboard item property
- Delete dashboard item property
- Get dashboard
- Update dashboard
- Delete dashboard
- Copy dashboard
- Issues
- Jira expressions
- Issue fields
- Issue custom field contexts
- Get custom field contexts
- Create custom field context
- Get custom field contexts default values
- Set custom field contexts default values
- Get issue types for custom field context
- Get custom field contexts for projects and issue types
- Get project mappings for custom field context
- Update custom field context
- Delete custom field context
- Add issue types to context
- Remove issue types from context
- Assign custom field context to projects
- Remove custom field context from projects
- Screens
- Issue custom field options (apps)
- Issue field configurations
- Get all field configurations
- Create field configuration
- Update field configuration
- Delete field configuration
- Get field configuration items
- Update field configuration items
- Get all field configuration schemes
- Create field configuration scheme
- Get field configuration issue type items
- Get field configuration schemes for projects
- Assign field configuration scheme to project
- Update field configuration scheme
- Delete field configuration scheme
- Assign issue types to field configurations
- Remove issue types from field configuration scheme
- Filters
- Filter sharing
- Groups
- Group and user picker
- License metrics
- Issue search
- Issue properties
- Issue watchers
- Issue remote links
- Issue votes
- Issue worklogs
- Issue worklog properties
- Issue links
- Issue link types
- Issue security schemes
- Get issue security schemes
- Create issue security scheme
- Get issue security levels
- Set default issue security levels
- Get issue security level members
- Get projects using issue security schemes
- Associate security scheme to project
- Search issue security schemes
- Get issue security scheme
- Update issue security scheme
- Delete issue security scheme
- Add issue security levels
- Update issue security level
- Remove issue security level
- Add issue security level members
- Remove member from issue security level
- Issue security level
- Issue types
- Issue type properties
- Issue type schemes
- Issue type screen schemes
- Get issue type screen schemes
- Create issue type screen scheme
- Get issue type screen scheme items
- Get issue type screen schemes for projects
- Assign issue type screen scheme to project
- Update issue type screen scheme
- Delete issue type screen scheme
- Append mappings to issue type screen scheme
- Update issue type screen scheme default screen scheme
- Remove mappings from issue type screen scheme
- Get issue type screen scheme projects
- JQL
- JQL functions (apps)
- Labels
- Permissions
- Myself
- Issue notification schemes
- Permission schemes
- Issue priorities
- Projects
- Project types
- Project avatars
- Project features
- Project properties
- Project roles
- Project role actors
- Project versions
- Project email
- Project permission schemes
- Project categories
- Project key and name validation
- Issue resolutions
- Screen tabs
- Screen tab fields
- Screen schemes
- Server info
- Issue navigator settings
- Workflow statuses
- Workflow status categories
- Status
- Tasks
- UI modifications (apps)
- Users
- User search
- User properties
- Webhooks
- Workflows
- Workflow transition rules
- Workflow transition properties
- Workflow schemes
- Get all workflow schemes
- Create workflow scheme
- Get workflow scheme
- Update workflow scheme
- Delete workflow scheme
- Get default workflow
- Update default workflow
- Delete default workflow
- Get workflow for issue type in workflow scheme
- Set workflow for issue type in workflow scheme
- Delete workflow for issue type in workflow scheme
- Get issue types for workflows in workflow scheme
- Set issue types for workflow in workflow scheme
- Delete issue types for workflow in workflow scheme
- Workflow scheme project associations
- Workflow scheme drafts
- Create draft workflow schemePOST
- Get draft workflow schemeGET
- Update draft workflow schemePUT
- Delete draft workflow schemeDELETE
- Get draft default workflowGET
- Update draft default workflowPUT
- Delete draft default workflowDELETE
- Get workflow for issue type in draft workflow schemeGET
- Set workflow for issue type in draft workflow schemePUT
- Delete workflow for issue type in draft workflow schemeDELETE
- Publish draft workflow schemePOST
- Get issue types for workflows in draft workflow schemeGET
- Set issue types for workflow in workflow schemePUT
- Delete issue types for workflow in draft workflow schemeDELETE
- App properties
- Dynamic modules
- App migration
Create draft workflow scheme
POST
/rest/api/3/workflowscheme/{id}/createdraft
Workflow scheme drafts
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/workflowscheme//createdraft'
Response Response Example
201 - Success
{
"id": 17218781,
"name": "Example workflow scheme",
"description": "The description of the example workflow scheme.",
"defaultWorkflow": "scrum workflow",
"issueTypeMappings": {
"10000": "jira",
"10001": "jira"
},
"originalDefaultWorkflow": "jira",
"originalIssueTypeMappings": {
"10001": "builds workflow"
},
"draft": true,
"lastModifiedUser": {
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"key": "",
"accountId": "5b10a2844c20165700ede21g",
"accountType": "atlassian",
"name": "",
"emailAddress": "mia@example.com",
"avatarUrls": {
"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48",
"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32"
},
"displayName": "Mia Krystof",
"active": true,
"timeZone": "Australia/Sydney",
"groups": {
"size": 3,
"items": []
},
"applicationRoles": {
"size": 1,
"items": []
}
},
"lastModified": "Today 6:38 PM",
"self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
}
Request
Path Params
id
integerÂ
required
Responses
🟢201Returned if the request is successful.
application/json
Body
Details about a workflow scheme.
defaultWorkflow
stringÂ
optional
defaultWorkflow
is not specified when creating a workflow scheme, it is set to Jira Workflow (jira).description
stringÂ
optional
draft
booleanÂ
read-onlyoptional
id
integer <int64>
read-onlyoptional
issueTypeMappings
objectÂ
optional
Additional properties
stringÂ
optional
issueTypes
objectÂ
read-onlyoptional
Additional properties
object (IssueTypeDetails)Â
optional
lastModified
stringÂ
read-onlyoptional
lastModifiedUser
objectÂ
read-onlyoptional
name
stringÂ
optional
originalDefaultWorkflow
stringÂ
read-onlyoptional
originalIssueTypeMappings
objectÂ
read-onlyoptional
Additional properties
stringÂ
read-onlyoptional
self
string <uri>
read-onlyoptional
updateDraftIfNeeded
booleanÂ
optional
updateDraftIfNeeded
set to true
: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.updateDraftIfNeeded
set to false
: An error is returned, as active workflow schemes cannot be updated.updateDraftIfNeeded
set to true
: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.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