Class WorkflowSchemeDrafts

Index

Constructors

Methods

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

Constructors

constructor

new WorkflowSchemeDrafts(client: Client): Version3.WorkflowSchemeDrafts
Parameters
- client: Client
Returns Version3.WorkflowSchemeDrafts
- Defined in src/version3/workflowSchemeDrafts.ts:8

Methods

createWorkflowSchemeDraftFromParent

createWorkflowSchemeDraftFromParent<T = Version3Models.WorkflowScheme>(
    parameters:
        | string
        | Version3Parameters.CreateWorkflowSchemeDraftFromParent,
    callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version3Models.WorkflowScheme
Parameters
- parameters: string | Version3Parameters.CreateWorkflowSchemeDraftFromParent
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowSchemeDrafts.ts:17
createWorkflowSchemeDraftFromParent<T = Version3Models.WorkflowScheme>(
    parameters:
        | string
        | Version3Parameters.CreateWorkflowSchemeDraftFromParent,
    callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version3Models.WorkflowScheme
Parameters
- parameters: string | Version3Parameters.CreateWorkflowSchemeDraftFromParent
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowSchemeDrafts.ts:28

deleteDraftDefaultWorkflow

deleteDraftDefaultWorkflow<T = Version3Models.WorkflowScheme>(
parameters: string | Version3Parameters.DeleteDraftDefaultWorkflow,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version3Models.WorkflowScheme
Parameters
- parameters: string | Version3Parameters.DeleteDraftDefaultWorkflow
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowSchemeDrafts.ts:250
deleteDraftDefaultWorkflow<T = Version3Models.WorkflowScheme>(
parameters: string | Version3Parameters.DeleteDraftDefaultWorkflow,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version3Models.WorkflowScheme
Parameters
- parameters: string | Version3Parameters.DeleteDraftDefaultWorkflow
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowSchemeDrafts.ts:261

deleteDraftWorkflowMapping

deleteDraftWorkflowMapping<T = unknown>(
parameters: Version3Parameters.DeleteDraftWorkflowMapping,
callback: Callback<T>,
): Promise<void>
Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.DeleteDraftWorkflowMapping
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowSchemeDrafts.ts:516
deleteDraftWorkflowMapping<T = unknown>(
parameters: Version3Parameters.DeleteDraftWorkflowMapping,
callback?: undefined,
): Promise<T>
Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.DeleteDraftWorkflowMapping
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowSchemeDrafts.ts:526

deleteWorkflowSchemeDraft

deleteWorkflowSchemeDraft<T = void>(
parameters: string | Version3Parameters.DeleteWorkflowSchemeDraft,
callback: Callback<T>,
): Promise<void>
Deletes a draft workflow scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: string | Version3Parameters.DeleteWorkflowSchemeDraft
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowSchemeDrafts.ts:141
deleteWorkflowSchemeDraft<T = void>(
parameters: string | Version3Parameters.DeleteWorkflowSchemeDraft,
callback?: undefined,
): Promise<T>
Deletes a draft workflow scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: string | Version3Parameters.DeleteWorkflowSchemeDraft
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowSchemeDrafts.ts:151

deleteWorkflowSchemeDraftIssueType

deleteWorkflowSchemeDraftIssueType<T = Version3Models.WorkflowScheme>(
parameters: Version3Parameters.DeleteWorkflowSchemeDraftIssueType,
callback: Callback<T>,
): Promise<void>
Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.WorkflowScheme
Parameters
- parameters: Version3Parameters.DeleteWorkflowSchemeDraftIssueType
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowSchemeDrafts.ts:350
deleteWorkflowSchemeDraftIssueType<T = Version3Models.WorkflowScheme>(
parameters: Version3Parameters.DeleteWorkflowSchemeDraftIssueType,
callback?: undefined,
): Promise<T>
Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.WorkflowScheme
Parameters
- parameters: Version3Parameters.DeleteWorkflowSchemeDraftIssueType
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowSchemeDrafts.ts:360

getDraftDefaultWorkflow

getDraftDefaultWorkflow<T = Version3Models.DefaultWorkflow>(
parameters: string | Version3Parameters.GetDraftDefaultWorkflow,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version3Models.DefaultWorkflow
Parameters
- parameters: string | Version3Parameters.GetDraftDefaultWorkflow
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowSchemeDrafts.ts:177
getDraftDefaultWorkflow<T = Version3Models.DefaultWorkflow>(
parameters: string | Version3Parameters.GetDraftDefaultWorkflow,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version3Models.DefaultWorkflow
Parameters
- parameters: string | Version3Parameters.GetDraftDefaultWorkflow
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowSchemeDrafts.ts:189

getDraftWorkflow

getDraftWorkflow<T = Version3Models.IssueTypesWorkflowMapping>(
parameters: Version3Parameters.GetDraftWorkflow,
callback: Callback<T>,
): Promise<void>
Returns the workflow-issue type mappings for a workflow scheme's draft.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.IssueTypesWorkflowMapping
Parameters
- parameters: Version3Parameters.GetDraftWorkflow
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowSchemeDrafts.ts:438
getDraftWorkflow<T = Version3Models.IssueTypesWorkflowMapping>(
parameters: Version3Parameters.GetDraftWorkflow,
callback?: undefined,
): Promise<T>
Returns the workflow-issue type mappings for a workflow scheme's draft.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.IssueTypesWorkflowMapping
Parameters
- parameters: Version3Parameters.GetDraftWorkflow
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowSchemeDrafts.ts:448

getWorkflowSchemeDraft

getWorkflowSchemeDraft<T = Version3Models.WorkflowScheme>(
parameters: string | Version3Parameters.GetWorkflowSchemeDraft,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version3Models.WorkflowScheme
Parameters
- parameters: string | Version3Parameters.GetWorkflowSchemeDraft
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowSchemeDrafts.ts:59
getWorkflowSchemeDraft<T = Version3Models.WorkflowScheme>(
parameters: string | Version3Parameters.GetWorkflowSchemeDraft,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version3Models.WorkflowScheme
Parameters
- parameters: string | Version3Parameters.GetWorkflowSchemeDraft
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowSchemeDrafts.ts:76

getWorkflowSchemeDraftIssueType

getWorkflowSchemeDraftIssueType<T = Version3Models.IssueTypeWorkflowMapping>(
parameters: Version3Parameters.GetWorkflowSchemeDraftIssueType,
callback: Callback<T>,
): Promise<void>
Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.IssueTypeWorkflowMapping
Parameters
- parameters: Version3Parameters.GetWorkflowSchemeDraftIssueType
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowSchemeDrafts.ts:285
getWorkflowSchemeDraftIssueType<T = Version3Models.IssueTypeWorkflowMapping>(
parameters: Version3Parameters.GetWorkflowSchemeDraftIssueType,
callback?: undefined,
): Promise<T>
Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.IssueTypeWorkflowMapping
Parameters
- parameters: Version3Parameters.GetWorkflowSchemeDraftIssueType
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowSchemeDrafts.ts:295

publishDraftWorkflowScheme

publishDraftWorkflowScheme<T = void>(
parameters: string | Version3Parameters.PublishDraftWorkflowScheme,
callback: Callback<T>,
): 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.
Type Parameters
- T = void
Parameters
- parameters: string | Version3Parameters.PublishDraftWorkflowScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowSchemeDrafts.ts:390
publishDraftWorkflowScheme<T = void>(
parameters: string | Version3Parameters.PublishDraftWorkflowScheme,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = void
Parameters
- parameters: string | Version3Parameters.PublishDraftWorkflowScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowSchemeDrafts.ts:408

setWorkflowSchemeDraftIssueType

setWorkflowSchemeDraftIssueType<T = Version3Models.WorkflowScheme>(
parameters: Version3Parameters.SetWorkflowSchemeDraftIssueType,
callback: Callback<T>,
): Promise<void>
Sets the workflow for an issue type in a workflow scheme's draft.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.WorkflowScheme
Parameters
- parameters: Version3Parameters.SetWorkflowSchemeDraftIssueType
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowSchemeDrafts.ts:317
setWorkflowSchemeDraftIssueType<T = Version3Models.WorkflowScheme>(
parameters: Version3Parameters.SetWorkflowSchemeDraftIssueType,
callback?: undefined,
): Promise<T>
Sets the workflow for an issue type in a workflow scheme's draft.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.WorkflowScheme
Parameters
- parameters: Version3Parameters.SetWorkflowSchemeDraftIssueType
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowSchemeDrafts.ts:327

updateDraftDefaultWorkflow

updateDraftDefaultWorkflow<T = Version3Models.WorkflowScheme>(
parameters: Version3Parameters.UpdateDraftDefaultWorkflow,
callback: Callback<T>,
): Promise<void>
Sets the default workflow for a workflow scheme's draft.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.WorkflowScheme
Parameters
- parameters: Version3Parameters.UpdateDraftDefaultWorkflow
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowSchemeDrafts.ts:213
updateDraftDefaultWorkflow<T = Version3Models.WorkflowScheme>(
parameters: Version3Parameters.UpdateDraftDefaultWorkflow,
callback?: undefined,
): Promise<T>
Sets the default workflow for a workflow scheme's draft.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.WorkflowScheme
Parameters
- parameters: Version3Parameters.UpdateDraftDefaultWorkflow
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowSchemeDrafts.ts:223

updateDraftWorkflowMapping

updateDraftWorkflowMapping<T = Version3Models.WorkflowScheme>(
parameters: Version3Parameters.UpdateDraftWorkflowMapping,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version3Models.WorkflowScheme
Parameters
- parameters: Version3Parameters.UpdateDraftWorkflowMapping
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowSchemeDrafts.ts:474
updateDraftWorkflowMapping<T = Version3Models.WorkflowScheme>(
parameters: Version3Parameters.UpdateDraftWorkflowMapping,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version3Models.WorkflowScheme
Parameters
- parameters: Version3Parameters.UpdateDraftWorkflowMapping
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowSchemeDrafts.ts:485

updateWorkflowSchemeDraft

updateWorkflowSchemeDraft<T = Version3Models.WorkflowScheme>(
parameters: Version3Parameters.UpdateWorkflowSchemeDraft,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version3Models.WorkflowScheme
Parameters
- parameters: Version3Parameters.UpdateWorkflowSchemeDraft
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowSchemeDrafts.ts:101
updateWorkflowSchemeDraft<T = Version3Models.WorkflowScheme>(
parameters: Version3Parameters.UpdateWorkflowSchemeDraft,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version3Models.WorkflowScheme
Parameters
- parameters: Version3Parameters.UpdateWorkflowSchemeDraft
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowSchemeDrafts.ts:112

Class WorkflowSchemeDrafts

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.WorkflowSchemeDrafts

Methods

createWorkflowSchemeDraftFromParent

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteDraftDefaultWorkflow

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteDraftWorkflowMapping

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteWorkflowSchemeDraft

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteWorkflowSchemeDraftIssueType

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getDraftDefaultWorkflow

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getDraftWorkflow

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getWorkflowSchemeDraft

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getWorkflowSchemeDraftIssueType

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

publishDraftWorkflowScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

setWorkflowSchemeDraftIssueType