Class WorkflowSchemes

Index

Constructors

Properties

Methods

createWorkflowScheme deleteDefaultWorkflow deleteWorkflowMapping deleteWorkflowScheme deleteWorkflowSchemeIssueType getAllWorkflowSchemes getDefaultWorkflow getWorkflow getWorkflowScheme getWorkflowSchemeIssueType setWorkflowSchemeIssueType updateDefaultWorkflow updateWorkflowMapping updateWorkflowScheme

Constructors

constructor

new WorkflowSchemes(client): Version2.WorkflowSchemes
Parameters
- client: Client
Returns Version2.WorkflowSchemes
- Defined in src/version2/workflowSchemes.ts:8

Properties

`Private` client

client: Client

Methods

createWorkflowScheme

createWorkflowScheme<T>(parameters, callback): Promise<void>
Creates a workflow scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.WorkflowScheme
Parameters
- parameters: Version2.Version2Parameters.CreateWorkflowScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/workflowSchemes.ts:54
createWorkflowScheme<T>(parameters, callback?): Promise<T>
Creates a workflow scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.WorkflowScheme
Parameters
- parameters: Version2.Version2Parameters.CreateWorkflowScheme
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version2/workflowSchemes.ts:64

deleteDefaultWorkflow

deleteDefaultWorkflow<T>(parameters, callback): Promise<void>
Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow (the jira workflow).

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.WorkflowScheme
Parameters
- parameters: string | Version2.Version2Parameters.DeleteDefaultWorkflow
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/workflowSchemes.ts:307
deleteDefaultWorkflow<T>(parameters, callback?): Promise<T>
Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow (the jira workflow).

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.WorkflowScheme
Parameters
- parameters: string | Version2.Version2Parameters.DeleteDefaultWorkflow
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version2/workflowSchemes.ts:322

deleteWorkflowMapping

deleteWorkflowMapping<T>(parameters, callback): Promise<void>
Deletes the workflow-issue type mapping for a workflow in a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: string | Version2.Version2Parameters.DeleteWorkflowMapping
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/workflowSchemes.ts:561
deleteWorkflowMapping<T>(parameters, callback?): Promise<T>
Deletes the workflow-issue type mapping for a workflow in a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: string | Version2.Version2Parameters.DeleteWorkflowMapping
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version2/workflowSchemes.ts:575

deleteWorkflowScheme

deleteWorkflowScheme<T>(parameters, callback): Promise<void>
Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project).

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: string | Version2.Version2Parameters.DeleteWorkflowScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/workflowSchemes.ts:182
deleteWorkflowScheme<T>(parameters, callback?): Promise<T>
Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project).

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: string | Version2.Version2Parameters.DeleteWorkflowScheme
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version2/workflowSchemes.ts:193

deleteWorkflowSchemeIssueType

deleteWorkflowSchemeIssueType<T>(parameters, callback): Promise<void>
Deletes the issue type-workflow mapping for an issue type in a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.WorkflowScheme
Parameters
- parameters: Version2.Version2Parameters.DeleteWorkflowSchemeIssueType
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/workflowSchemes.ts:429
deleteWorkflowSchemeIssueType<T>(parameters, callback?): Promise<T>
Deletes the issue type-workflow mapping for an issue type in a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.WorkflowScheme
Parameters
- parameters: Version2.Version2Parameters.DeleteWorkflowSchemeIssueType
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version2/workflowSchemes.ts:443

getAllWorkflowSchemes

getAllWorkflowSchemes<T>(parameters, callback): Promise<void>
Returns a paginated list of all workflow schemes, not including draft workflow schemes.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.PageWorkflowScheme
Parameters
- parameters: undefined | Version2.Version2Parameters.GetAllWorkflowSchemes
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/workflowSchemes.ts:17
getAllWorkflowSchemes<T>(parameters?, callback?): Promise<T>
Returns a paginated list of all workflow schemes, not including draft workflow schemes.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.PageWorkflowScheme
Parameters
- Optional parameters: Version2.Version2Parameters.GetAllWorkflowSchemes
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version2/workflowSchemes.ts:28

getDefaultWorkflow

getDefaultWorkflow<T>(parameters, callback): Promise<void>
Returns the default workflow for a workflow scheme. 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 = Version2.Version2Models.DefaultWorkflow
Parameters
- parameters: string | Version2.Version2Parameters.GetDefaultWorkflow
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/workflowSchemes.ts:219
getDefaultWorkflow<T>(parameters, callback?): Promise<T>
Returns the default workflow for a workflow scheme. 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 = Version2.Version2Models.DefaultWorkflow
Parameters
- parameters: string | Version2.Version2Parameters.GetDefaultWorkflow
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version2/workflowSchemes.ts:231

getWorkflow

getWorkflow<T>(parameters, callback): Promise<void>
Returns the workflow-issue type mappings for a workflow scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.IssueTypesWorkflowMapping
Parameters
- parameters: string | Version2.Version2Parameters.GetWorkflow
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/workflowSchemes.ts:468
getWorkflow<T>(parameters, callback?): Promise<T>
Returns the workflow-issue type mappings for a workflow scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.IssueTypesWorkflowMapping
Parameters
- parameters: string | Version2.Version2Parameters.GetWorkflow
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version2/workflowSchemes.ts:478

getWorkflowScheme

getWorkflowScheme<T>(parameters, callback): Promise<void>
Returns a workflow scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.WorkflowScheme
Parameters
- parameters: string | Version2.Version2Parameters.GetWorkflowScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/workflowSchemes.ts:101
getWorkflowScheme<T>(parameters, callback?): Promise<T>
Returns a workflow scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.WorkflowScheme
Parameters
- parameters: string | Version2.Version2Parameters.GetWorkflowScheme
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version2/workflowSchemes.ts:111

getWorkflowSchemeIssueType

getWorkflowSchemeIssueType<T>(parameters, callback): Promise<void>
Returns the issue type-workflow mapping for an issue type in a workflow scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.IssueTypeWorkflowMapping
Parameters
- parameters: Version2.Version2Parameters.GetWorkflowSchemeIssueType
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/workflowSchemes.ts:349
getWorkflowSchemeIssueType<T>(parameters, callback?): Promise<T>
Returns the issue type-workflow mapping for an issue type in a workflow scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.IssueTypeWorkflowMapping
Parameters
- parameters: Version2.Version2Parameters.GetWorkflowSchemeIssueType
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version2/workflowSchemes.ts:359

setWorkflowSchemeIssueType

setWorkflowSchemeIssueType<T>(parameters, callback): Promise<void>
Sets the workflow for an issue type in a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.WorkflowScheme
Parameters
- parameters: Version2.Version2Parameters.SetWorkflowSchemeIssueType
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/workflowSchemes.ts:388
setWorkflowSchemeIssueType<T>(parameters, callback?): Promise<T>
Sets the workflow for an issue type in a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.WorkflowScheme
Parameters
- parameters: Version2.Version2Parameters.SetWorkflowSchemeIssueType
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version2/workflowSchemes.ts:402

updateDefaultWorkflow

updateDefaultWorkflow<T>(parameters, callback): Promise<void>
Sets the default workflow for a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.WorkflowScheme
Parameters
- parameters: Version2.Version2Parameters.UpdateDefaultWorkflow
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/workflowSchemes.ts:262
updateDefaultWorkflow<T>(parameters, callback?): Promise<T>
Sets the default workflow for a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.WorkflowScheme
Parameters
- parameters: Version2.Version2Parameters.UpdateDefaultWorkflow
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version2/workflowSchemes.ts:276

updateWorkflowMapping

updateWorkflowMapping<T>(parameters, callback): Promise<void>
Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.WorkflowScheme
Parameters
- parameters: Version2.Version2Parameters.UpdateWorkflowMapping
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/workflowSchemes.ts:511
updateWorkflowMapping<T>(parameters, callback?): Promise<T>
Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.WorkflowScheme
Parameters
- parameters: Version2.Version2Parameters.UpdateWorkflowMapping
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version2/workflowSchemes.ts:526

updateWorkflowScheme

updateWorkflowScheme<T>(parameters, callback): Promise<void>
Updates a company-manged project workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active (that is, being used by at least one project), then a draft workflow scheme is created or updated instead, provided that updateDraftIfNeeded is set to true.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.WorkflowScheme
Parameters
- parameters: Version2.Version2Parameters.UpdateWorkflowScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/workflowSchemes.ts:140
updateWorkflowScheme<T>(parameters, callback?): Promise<T>
Updates a company-manged project workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active (that is, being used by at least one project), then a draft workflow scheme is created or updated instead, provided that updateDraftIfNeeded is set to true.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version2.Version2Models.WorkflowScheme
Parameters
- parameters: Version2.Version2Parameters.UpdateWorkflowScheme
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version2/workflowSchemes.ts:152

Class WorkflowSchemes

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Version2.WorkflowSchemes

Properties

Private client

Methods

createWorkflowScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteDefaultWorkflow

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteWorkflowMapping

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteWorkflowScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteWorkflowSchemeIssueType

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAllWorkflowSchemes

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getDefaultWorkflow

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getWorkflow

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getWorkflowScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getWorkflowSchemeIssueType

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

`Private` client