Class WorkflowSchemeDraftsService

This resource represents draft workflow schemes. Use it to manage drafts of workflow schemes.

A workflow scheme maps issue types to workflows. A workflow scheme can be associated with one or more projects, which enables the projects to use the workflow-issue type mappings.

Active workflow schemes (workflow schemes that are used by projects) cannot be edited. Editing an active workflow scheme creates a draft copy of the scheme. The draft workflow scheme can then be edited and published (replacing the active scheme).

See Configuring workflow schemes for more information.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts

Hierarchy

CommonHttpService
- WorkflowSchemeDraftsService

Index

Constructors

constructor

Methods

createWorkflowSchemeDraftFromParent deleteDraftDefaultWorkflow deleteDraftWorkflowMapping deleteWorkflowSchemeDraft deleteWorkflowSchemeDraftIssueType getDraftDefaultWorkflow getDraftWorkflow getWorkflowSchemeDraft getWorkflowSchemeDraftIssueType publishDraftWorkflowScheme setWorkflowSchemeDraftIssueType updateDraftDefaultWorkflow updateDraftWorkflowMapping updateWorkflowSchemeDraft initialize

Constructors

constructor

new WorkflowSchemeDraftsService(getClientInstance): WorkflowSchemeDraftsService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns WorkflowSchemeDraftsService
Inherited from CommonHttpService.constructor

Methods

createWorkflowSchemeDraftFromParent

createWorkflowSchemeDraftFromParent(params): Promise<WorkflowScheme>

Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme.

Permissions required: Administer Jira global permission.

Parameters

params: {
id: number;
}
- id: number
  The ID of the active workflow scheme that the draft is created from.

Returns Promise<WorkflowScheme>

Returned if the request is successful.

example:

{
  "defaultWorkflow": "scrum workflow",
  "description": "The description of the example workflow scheme.",
  "draft": true,
  "id": 17218781,
  "issueTypeMappings": {
    "10000": "jira",
    "10001": "jira"
  },
  "lastModified": "Today 6:38 PM",
  "lastModifiedUser": {
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "active": true,
    "applicationRoles": {
      "items": [],
      "size": 1
    },
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
    },
    "displayName": "Mia Krystof",
    "emailAddress": "mia@example.com",
    "groups": {
      "items": [],
      "size": 3
    },
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
    "timeZone": "Australia/Sydney"
  },
  "name": "Example workflow scheme",
  "originalDefaultWorkflow": "jira",
  "originalIssueTypeMappings": {
    "10001": "builds workflow"
  },
  "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
}

Path

POST /rest/api/3/workflowscheme/{id}/createdraft @scopes-current manage:jira-configuration @scopes-beta read:group:jira, read:issue-security-level:jira, read:project-role:jira, read:screen:jira, read:status:jira, read:user:jira, read:workflow-scheme:jira, read:workflow:jira, write:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:issue-type:jira, read:project-category:jira, read:project:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts#api-rest-api-3-workflowscheme-id-createdraft-post

deleteDraftDefaultWorkflow

deleteDraftDefaultWorkflow(params): Promise<WorkflowScheme>

Resets the default workflow for a workflow scheme's draft. That is, the default workflow is set to Jira's system workflow (the jira workflow).

Permissions required: Administer Jira global permission.

Parameters

params: {
id: number;
}
- id: number
  The ID of the workflow scheme that the draft belongs to.

Returns Promise<WorkflowScheme>

Returned if the request is successful.

example:

{
  "defaultWorkflow": "scrum workflow",
  "description": "The description of the example workflow scheme.",
  "draft": true,
  "id": 17218781,
  "issueTypeMappings": {
    "10000": "jira",
    "10001": "jira"
  },
  "lastModified": "Today 6:38 PM",
  "lastModifiedUser": {
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "active": true,
    "applicationRoles": {
      "items": [],
      "size": 1
    },
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
    },
    "displayName": "Mia Krystof",
    "emailAddress": "mia@example.com",
    "groups": {
      "items": [],
      "size": 3
    },
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
    "timeZone": "Australia/Sydney"
  },
  "name": "Example workflow scheme",
  "originalDefaultWorkflow": "jira",
  "originalIssueTypeMappings": {
    "10001": "builds workflow"
  },
  "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
}

Path

DELETE /rest/api/3/workflowscheme/{id}/draft/default @scopes-current manage:jira-configuration @scopes-beta delete:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira, read:workflow-scheme:jira, read:workflow:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts#api-rest-api-3-workflowscheme-id-draft-default-delete

deleteDraftWorkflowMapping

deleteDraftWorkflowMapping(params): Promise<void>
Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  id: number;
  workflowName: string;
  }
  - id: number
    The ID of the workflow scheme that the draft belongs to.
  - workflowName: string
    The name of the workflow.
Returns Promise<void>
Path
DELETE /rest/api/3/workflowscheme/{id}/draft/workflow @scopes-current manage:jira-configuration @scopes-beta delete:workflow-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts#api-rest-api-3-workflowscheme-id-draft-workflow-delete

deleteWorkflowSchemeDraft

deleteWorkflowSchemeDraft(params): Promise<void>
Deletes a draft workflow scheme.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the active workflow scheme that the draft was created from.
Returns Promise<void>
Path
DELETE /rest/api/3/workflowscheme/{id}/draft @scopes-current manage:jira-configuration @scopes-beta delete:workflow-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts#api-rest-api-3-workflowscheme-id-draft-delete

deleteWorkflowSchemeDraftIssueType

deleteWorkflowSchemeDraftIssueType(params): Promise<WorkflowScheme>

Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft.

Permissions required: Administer Jira global permission.

Parameters

params: {
id: number;
issueType: string;
}
- id: number
  The ID of the workflow scheme that the draft belongs to.
- issueType: string
  The ID of the issue type.

Returns Promise<WorkflowScheme>

Returned if the request is successful.

example:

{
  "defaultWorkflow": "scrum workflow",
  "description": "The description of the example workflow scheme.",
  "draft": true,
  "id": 17218781,
  "issueTypeMappings": {
    "10000": "jira",
    "10001": "jira"
  },
  "lastModified": "Today 6:38 PM",
  "lastModifiedUser": {
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "active": true,
    "applicationRoles": {
      "items": [],
      "size": 1
    },
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
    },
    "displayName": "Mia Krystof",
    "emailAddress": "mia@example.com",
    "groups": {
      "items": [],
      "size": 3
    },
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
    "timeZone": "Australia/Sydney"
  },
  "name": "Example workflow scheme",
  "originalDefaultWorkflow": "jira",
  "originalIssueTypeMappings": {
    "10001": "builds workflow"
  },
  "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
}

Path

DELETE /rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType} @scopes-current manage:jira-configuration @scopes-beta delete:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira, read:workflow-scheme:jira, read:workflow:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts#api-rest-api-3-workflowscheme-id-draft-issuetype-issuetype-delete

getDraftDefaultWorkflow

getDraftDefaultWorkflow(params): Promise<DefaultWorkflow>
Returns the default workflow for a workflow scheme's draft. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  id: number;
  }
  - id: number
    The ID of the workflow scheme that the draft belongs to.
Returns Promise<DefaultWorkflow>
Returned if the request is successful.

example:
```
{
  "workflow": "jira"
}
```
Path
GET /rest/api/3/workflowscheme/{id}/draft/default @scopes-current manage:jira-configuration @scopes-beta read:workflow-scheme:jira, read:workflow:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts#api-rest-api-3-workflowscheme-id-draft-default-get

getDraftWorkflow

getDraftWorkflow(params): Promise<IssueTypesWorkflowMapping>
Returns the workflow-issue type mappings for a workflow scheme's draft.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  id: number;
  workflowName?: string;
  }
  - id: number
    The ID of the workflow scheme that the draft belongs to.
  - OptionalworkflowName?: string
    The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.
Returns Promise<IssueTypesWorkflowMapping>
Returned if the request is successful.

example:
```
{
  "defaultMapping": false,
  "issueTypes": [
    "10000",
    "10001"
  ],
  "workflow": "jira"
}
```
Path
GET /rest/api/3/workflowscheme/{id}/draft/workflow @scopes-current manage:jira-configuration @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:issue-type:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts#api-rest-api-3-workflowscheme-id-draft-workflow-get

getWorkflowSchemeDraft

getWorkflowSchemeDraft(params): Promise<WorkflowScheme>

Returns the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is modified, then the changes in the draft are copied back to the active workflow scheme. See Configuring workflow schemes for more information. Note that:

Only active workflow schemes can have draft workflow schemes.
An active workflow scheme can only have one draft workflow scheme.

Permissions required: Administer Jira global permission.

Parameters

params: {
id: number;
}
- id: number
  The ID of the active workflow scheme that the draft was created from.

Returns Promise<WorkflowScheme>

Returned if the request is successful.

example:

{
  "defaultWorkflow": "scrum workflow",
  "description": "The description of the example workflow scheme.",
  "draft": true,
  "id": 17218781,
  "issueTypeMappings": {
    "10000": "jira",
    "10001": "jira"
  },
  "lastModified": "Today 6:38 PM",
  "lastModifiedUser": {
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "active": true,
    "applicationRoles": {
      "items": [],
      "size": 1
    },
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
    },
    "displayName": "Mia Krystof",
    "emailAddress": "mia@example.com",
    "groups": {
      "items": [],
      "size": 3
    },
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
    "timeZone": "Australia/Sydney"
  },
  "name": "Example workflow scheme",
  "originalDefaultWorkflow": "jira",
  "originalIssueTypeMappings": {
    "10001": "builds workflow"
  },
  "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
}

Path

GET /rest/api/3/workflowscheme/{id}/draft @scopes-current manage:jira-configuration @scopes-beta read:group:jira, read:issue-security-level:jira, read:project-role:jira, read:screen:jira, read:status:jira, read:user:jira, read:workflow-scheme:jira, read:workflow:jira, read:application-role:jira, read:avatar:jira, read:issue-type:jira, read:project-category:jira, read:project:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts#api-rest-api-3-workflowscheme-id-draft-get

getWorkflowSchemeDraftIssueType

getWorkflowSchemeDraftIssueType(params): Promise<IssueTypeWorkflowMapping>
Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  id: number;
  issueType: string;
  }
  - id: number
    The ID of the workflow scheme that the draft belongs to.
  - issueType: string
    The ID of the issue type.
Returns Promise<IssueTypeWorkflowMapping>
Returned if the request is successful.

example:
```
{
  "issueType": "10000",
  "workflow": "jira"
}
```
Path
GET /rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType} @scopes-current manage:jira-configuration @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:issue-type:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts#api-rest-api-3-workflowscheme-id-draft-issuetype-issuetype-get

publishDraftWorkflowScheme

publishDraftWorkflowScheme(params): Promise<void>
Publishes a draft workflow scheme.

Where the draft workflow includes new workflow statuses for an issue type, mappings are provided to update issues with the original workflow status to the new workflow status.

This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain updates.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      id: number;
      publishDraftWorkflowScheme: PublishDraftWorkflowScheme;
      validateOnly?: boolean;
  }
  - id: number
    The ID of the workflow scheme that the draft belongs to.
  - publishDraftWorkflowScheme: PublishDraftWorkflowScheme
    Details of the status mappings.
    
    Example
  - OptionalvalidateOnly?: boolean
    Whether the request only performs a validation.
Returns Promise<void>
Path
POST /rest/api/3/workflowscheme/{id}/draft/publish @scopes-current manage:jira-configuration @scopes-beta write:workflow-scheme:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts#api-rest-api-3-workflowscheme-id-draft-publish-post

setWorkflowSchemeDraftIssueType

setWorkflowSchemeDraftIssueType(params): Promise<WorkflowScheme>

Sets the workflow for an issue type in a workflow scheme's draft.

Permissions required: Administer Jira global permission.

Parameters

params: {
    id: number;
    issueType: string;
    issueTypeWorkflowMapping: IssueTypeWorkflowMapping;
}
- id: number
  The ID of the workflow scheme that the draft belongs to.
- issueType: string
  The ID of the issue type.
- issueTypeWorkflowMapping: IssueTypeWorkflowMapping
  The issue type-project mapping.
  
  Example

Returns Promise<WorkflowScheme>

Returned if the request is successful.

example:

{
  "defaultWorkflow": "scrum workflow",
  "description": "The description of the example workflow scheme.",
  "draft": true,
  "id": 17218781,
  "issueTypeMappings": {
    "10000": "jira",
    "10001": "jira"
  },
  "lastModified": "Today 6:38 PM",
  "lastModifiedUser": {
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "active": true,
    "applicationRoles": {
      "items": [],
      "size": 1
    },
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
    },
    "displayName": "Mia Krystof",
    "emailAddress": "mia@example.com",
    "groups": {
      "items": [],
      "size": 3
    },
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
    "timeZone": "Australia/Sydney"
  },
  "name": "Example workflow scheme",
  "originalDefaultWorkflow": "jira",
  "originalIssueTypeMappings": {
    "10001": "builds workflow"
  },
  "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
}

Path

PUT /rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType} @scopes-current manage:jira-configuration @scopes-beta write:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts#api-rest-api-3-workflowscheme-id-draft-issuetype-issuetype-put

updateDraftDefaultWorkflow

updateDraftDefaultWorkflow(params): Promise<WorkflowScheme>

Sets the default workflow for a workflow scheme's draft.

Permissions required: Administer Jira global permission.

Parameters

params: {
defaultWorkflow: DefaultWorkflow;
id: number;
}
- defaultWorkflow: DefaultWorkflow
  The object for the new default workflow.
  
  Example
- id: number
  The ID of the workflow scheme that the draft belongs to.

Returns Promise<WorkflowScheme>

Returned if the request is successful.

example:

{
  "defaultWorkflow": "scrum workflow",
  "description": "The description of the example workflow scheme.",
  "draft": true,
  "id": 17218781,
  "issueTypeMappings": {
    "10000": "jira",
    "10001": "jira"
  },
  "lastModified": "Today 6:38 PM",
  "lastModifiedUser": {
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "active": true,
    "applicationRoles": {
      "items": [],
      "size": 1
    },
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
    },
    "displayName": "Mia Krystof",
    "emailAddress": "mia@example.com",
    "groups": {
      "items": [],
      "size": 3
    },
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
    "timeZone": "Australia/Sydney"
  },
  "name": "Example workflow scheme",
  "originalDefaultWorkflow": "jira",
  "originalIssueTypeMappings": {
    "10001": "builds workflow"
  },
  "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
}

Path

PUT /rest/api/3/workflowscheme/{id}/draft/default @scopes-current manage:jira-configuration @scopes-beta write:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts#api-rest-api-3-workflowscheme-id-draft-default-put

updateDraftWorkflowMapping

updateDraftWorkflowMapping(params): Promise<WorkflowScheme>
Sets the issue types for a workflow in a workflow scheme's draft. The workflow can also be set as the default workflow for the draft workflow scheme. Unmapped issues types are mapped to the default workflow.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      id: number;
      issueTypesWorkflowMapping: IssueTypesWorkflowMapping;
      workflowName: string;
  }
  - id: number
    The ID of the workflow scheme that the draft belongs to.
  - issueTypesWorkflowMapping: IssueTypesWorkflowMapping
    Example
  - workflowName: string
    The name of the workflow.
Returns Promise<WorkflowScheme>
Returned if the request is successful.

example:
```
{
  "defaultWorkflow": "jira",
  "description": "The description of the example workflow scheme.",
  "draft": false,
  "id": 101010,
  "issueTypeMappings": {
    "10000": "scrum workflow",
    "10001": "builds workflow"
  },
  "name": "Example workflow scheme",
  "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
}
```
Path
PUT /rest/api/3/workflowscheme/{id}/draft/workflow @scopes-current manage:jira-configuration @scopes-beta write:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts#api-rest-api-3-workflowscheme-id-draft-workflow-put

updateWorkflowSchemeDraft

updateWorkflowSchemeDraft(params): Promise<WorkflowScheme>

Updates a draft workflow scheme. If a draft workflow scheme does not exist for the active workflow scheme, then a draft is created. Note that an active workflow scheme can only have one draft workflow scheme.

Permissions required: Administer Jira global permission.

Parameters

params: {
id: number;
workflowScheme: WorkflowScheme;
}
- id: number
  The ID of the active workflow scheme that the draft was created from.
- workflowScheme: WorkflowScheme
  Example

Returns Promise<WorkflowScheme>

Returned if the request is successful.

example:

{
  "defaultWorkflow": "scrum workflow",
  "description": "The description of the example workflow scheme.",
  "draft": true,
  "id": 17218781,
  "issueTypeMappings": {
    "10000": "jira",
    "10001": "jira"
  },
  "lastModified": "Today 6:38 PM",
  "lastModifiedUser": {
    "accountId": "5b10a2844c20165700ede21g",
    "accountType": "atlassian",
    "active": true,
    "applicationRoles": {
      "items": [],
      "size": 1
    },
    "avatarUrls": {
      "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
      "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
      "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
      "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
    },
    "displayName": "Mia Krystof",
    "emailAddress": "mia@example.com",
    "groups": {
      "items": [],
      "size": 3
    },
    "key": "",
    "name": "",
    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
    "timeZone": "Australia/Sydney"
  },
  "name": "Example workflow scheme",
  "originalDefaultWorkflow": "jira",
  "originalIssueTypeMappings": {
    "10001": "builds workflow"
  },
  "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
}

Path

PUT /rest/api/3/workflowscheme/{id}/draft @scopes-current manage:jira-configuration @scopes-beta read:group:jira, read:issue-security-level:jira, read:project-role:jira, read:screen:jira, read:status:jira, read:user:jira, read:workflow-scheme:jira, read:workflow:jira, write:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:issue-type:jira, read:project-category:jira, read:project:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts#api-rest-api-3-workflowscheme-id-draft-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class WorkflowSchemeDraftsService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns WorkflowSchemeDraftsService

Methods

createWorkflowSchemeDraftFromParent

Parameters

id: number

Returns Promise<WorkflowScheme>

Path

See

deleteDraftDefaultWorkflow

Parameters

id: number

Returns Promise<WorkflowScheme>

Path

See

deleteDraftWorkflowMapping

Parameters

id: number

workflowName: string

Returns Promise<void>

Path

See

deleteWorkflowSchemeDraft

Parameters

id: number

Returns Promise<void>

Path

See

deleteWorkflowSchemeDraftIssueType

Parameters

id: number

issueType: string

Returns Promise<WorkflowScheme>

Path

See

getDraftDefaultWorkflow

Parameters

id: number

Returns Promise<DefaultWorkflow>

Path

See

getDraftWorkflow

Parameters

id: number

OptionalworkflowName?: string

Returns Promise<IssueTypesWorkflowMapping>

Path

See

getWorkflowSchemeDraft

Parameters

id: number

Returns Promise<WorkflowScheme>

Path

See

getWorkflowSchemeDraftIssueType

Parameters

id: number

issueType: string

Returns Promise<IssueTypeWorkflowMapping>

Path

See

publishDraftWorkflowScheme

Parameters

id: number

publishDraftWorkflowScheme: PublishDraftWorkflowScheme

Example

OptionalvalidateOnly?: boolean

Returns Promise<void>

Path

See

setWorkflowSchemeDraftIssueType

`Optional`workflowName?: string

`Optional`validateOnly?: boolean

`Protected` `Static`initialize