Class Workflows

Index

Constructors

Methods

createWorkflow createWorkflows deleteInactiveWorkflow getProjectUsagesForWorkflow getWorkflowProjectIssueTypeUsages getWorkflowSchemeUsagesForWorkflow getWorkflowsPaginated readWorkflows searchWorkflows updateWorkflows validateCreateWorkflows validateUpdateWorkflows workflowCapabilities

Constructors

constructor

new Workflows(client: Client): Version3.Workflows
Parameters
- client: Client
Returns Version3.Workflows
- Defined in src/version3/workflows.ts:9

Methods

createWorkflow

createWorkflow<T = Version3Models.WorkflowId>(
parameters: Version3Parameters.CreateWorkflow,
callback: Callback<T>,
): Promise<void>
Creates a workflow. You can define transition rules using the shapes detailed in the following sections. If no transitional rules are specified the default system transition rules are used. Note: This only applies to company-managed scoped workflows. Use bulk create workflows to create both team and company-managed scoped workflows.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.WorkflowId
Parameters
- parameters: Version3Parameters.CreateWorkflow
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:21
createWorkflow<T = Version3Models.WorkflowId>(
parameters: Version3Parameters.CreateWorkflow,
callback?: undefined,
): Promise<T>
Creates a workflow. You can define transition rules using the shapes detailed in the following sections. If no transitional rules are specified the default system transition rules are used. Note: This only applies to company-managed scoped workflows. Use bulk create workflows to create both team and company-managed scoped workflows.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.WorkflowId
Parameters
- parameters: Version3Parameters.CreateWorkflow
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:35

createWorkflows

createWorkflows<T = Version3Models.WorkflowCreate>(
parameters: Version3Parameters.CreateWorkflows,
callback: Callback<T>,
): Promise<void>
Create workflows and related statuses.

Permissions required:
- Administer Jira project permission to create all, including global-scoped, workflows
- Administer projects project permissions to create project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowCreate
Parameters
- parameters: Version3Parameters.CreateWorkflows
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:328
createWorkflows<T = Version3Models.WorkflowCreate>(
parameters: Version3Parameters.CreateWorkflows,
callback?: undefined,
): Promise<T>
Create workflows and related statuses.

Permissions required:
- Administer Jira project permission to create all, including global-scoped, workflows
- Administer projects project permissions to create project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowCreate
Parameters
- parameters: Version3Parameters.CreateWorkflows
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:340

deleteInactiveWorkflow

deleteInactiveWorkflow<T = void>(
parameters: string | Version3Parameters.DeleteInactiveWorkflow,
callback: Callback<T>,
): Promise<void>
Deletes a workflow.

The workflow cannot be deleted if it is:
- An active workflow.
- A system workflow.
- Associated with any workflow scheme.
- Associated with any draft workflow scheme.
Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: string | Version3Parameters.DeleteInactiveWorkflow
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:116

getProjectUsagesForWorkflow

getProjectUsagesForWorkflow<T = WorkflowProjectUsage>(
parameters: Version3Parameters.GetProjectUsagesForWorkflow,
callback: Callback<T>,
): Promise<void>
Returns a page of projects using a given workflow.
Type Parameters
- T = WorkflowProjectUsage
Parameters
- parameters: Version3Parameters.GetProjectUsagesForWorkflow
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:174
getProjectUsagesForWorkflow<T = WorkflowProjectUsage>(
parameters: Version3Parameters.GetProjectUsagesForWorkflow,
callback?: undefined,
): Promise<T>
Returns a page of projects using a given workflow.
Type Parameters
- T = WorkflowProjectUsage
Parameters
- parameters: Version3Parameters.GetProjectUsagesForWorkflow
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:179

getWorkflowProjectIssueTypeUsages

getWorkflowProjectIssueTypeUsages<T = WorkflowProjectIssueTypeUsage>(
parameters: Version3Parameters.GetWorkflowProjectIssueTypeUsages,
callback: Callback<T>,
): Promise<void>
Returns a page of issue types using a given workflow within a project.
Type Parameters
- T = WorkflowProjectIssueTypeUsage
Parameters
- parameters: Version3Parameters.GetWorkflowProjectIssueTypeUsages
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:148
getWorkflowProjectIssueTypeUsages<T = WorkflowProjectIssueTypeUsage>(
parameters: Version3Parameters.GetWorkflowProjectIssueTypeUsages,
callback?: undefined,
): Promise<T>
Returns a page of issue types using a given workflow within a project.
Type Parameters
- T = WorkflowProjectIssueTypeUsage
Parameters
- parameters: Version3Parameters.GetWorkflowProjectIssueTypeUsages
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:153

getWorkflowSchemeUsagesForWorkflow

getWorkflowSchemeUsagesForWorkflow<T = WorkflowSchemeUsage>(
parameters: Version3Parameters.GetWorkflowSchemeUsagesForWorkflow,
callback: Callback<T>,
): Promise<void>
Returns a page of workflow schemes using a given workflow.
Type Parameters
- T = WorkflowSchemeUsage
Parameters
- parameters: Version3Parameters.GetWorkflowSchemeUsagesForWorkflow
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:200
getWorkflowSchemeUsagesForWorkflow<T = WorkflowSchemeUsage>(
parameters: Version3Parameters.GetWorkflowSchemeUsagesForWorkflow,
callback?: undefined,
): Promise<T>
Returns a page of workflow schemes using a given workflow.
Type Parameters
- T = WorkflowSchemeUsage
Parameters
- parameters: Version3Parameters.GetWorkflowSchemeUsagesForWorkflow
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:205

getWorkflowsPaginated

getWorkflowsPaginated<T = Version3Models.PageWorkflow>(
parameters: undefined | Version3Parameters.GetWorkflowsPaginated,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned.

This operation does not return next-gen workflows.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageWorkflow
Parameters
- parameters: undefined | Version3Parameters.GetWorkflowsPaginated
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:64
getWorkflowsPaginated<T = Version3Models.PageWorkflow>(
parameters?: Version3Parameters.GetWorkflowsPaginated,
callback?: undefined,
): Promise<T>
Returns a paginated list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned.

This operation does not return next-gen workflows.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageWorkflow
Parameters
- Optionalparameters: Version3Parameters.GetWorkflowsPaginated
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:78

readWorkflows

readWorkflows<T = Version3Models.WorkflowRead>(
parameters: undefined | Version3Parameters.ReadWorkflows,
callback: Callback<T>,
): Promise<void>
Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types.

Permissions required:
- Administer Jira global permission to access all, including project-scoped, workflows
- At least one of the Administer projects and View (read-only) workflow project permissions to access project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowRead
Parameters
- parameters: undefined | Version3Parameters.ReadWorkflows
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:235
readWorkflows<T = Version3Models.WorkflowRead>(
parameters?: Version3Parameters.ReadWorkflows,
callback?: undefined,
): Promise<T>
Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types.

Permissions required:
- Administer Jira global permission to access all, including project-scoped, workflows
- At least one of the Administer projects and View (read-only) workflow project permissions to access project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowRead
Parameters
- Optionalparameters: Version3Parameters.ReadWorkflows
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:249

searchWorkflows

searchWorkflows<T = Version3Models.WorkflowSearchResponse>(
parameters: undefined | Version3Parameters.SearchWorkflows,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of global and project workflows. If workflow names are specified in query string, details of those workflows are returned. Otherwise, all workflows are returned.

Permissions required:
- Administer Jira global permission to access all, including project-scoped, workflows
- At least one of the Administer projects and View (read-only) workflow project permissions to access project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowSearchResponse
Parameters
- parameters: undefined | Version3Parameters.SearchWorkflows
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:412
searchWorkflows<T = Version3Models.WorkflowSearchResponse>(
parameters?: Version3Parameters.SearchWorkflows,
callback?: undefined,
): Promise<T>
Returns a paginated list of global and project workflows. If workflow names are specified in query string, details of those workflows are returned. Otherwise, all workflows are returned.

Permissions required:
- Administer Jira global permission to access all, including project-scoped, workflows
- At least one of the Administer projects and View (read-only) workflow project permissions to access project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowSearchResponse
Parameters
- Optionalparameters: Version3Parameters.SearchWorkflows
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:427

updateWorkflows

updateWorkflows<T = Version3Models.WorkflowUpdate>(
parameters: Version3Parameters.UpdateWorkflows,
callback: Callback<T>,
): Promise<void>
Update workflows and related statuses.

Permissions required:
- Administer Jira project permission to create all, including global-scoped, workflows
- Administer projects project permissions to create project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowUpdate
Parameters
- parameters: Version3Parameters.UpdateWorkflows
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:460
updateWorkflows<T = Version3Models.WorkflowUpdate>(
parameters: Version3Parameters.UpdateWorkflows,
callback?: undefined,
): Promise<T>
Update workflows and related statuses.

Permissions required:
- Administer Jira project permission to create all, including global-scoped, workflows
- Administer projects project permissions to create project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowUpdate
Parameters
- parameters: Version3Parameters.UpdateWorkflows
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:472

validateCreateWorkflows

validateCreateWorkflows<T = Version3Models.WorkflowValidationErrorList>(
parameters: Version3Parameters.ValidateCreateWorkflows,
callback: Callback<T>,
): Promise<void>
Validate the payload for bulk create workflows.

Permissions required:
- Administer Jira project permission to create all, including global-scoped, workflows
- Administer projects project permissions to create project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowValidationErrorList
Parameters
- parameters: Version3Parameters.ValidateCreateWorkflows
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:369
validateCreateWorkflows<T = Version3Models.WorkflowValidationErrorList>(
parameters: Version3Parameters.ValidateCreateWorkflows,
callback?: undefined,
): Promise<T>
Validate the payload for bulk create workflows.

Permissions required:
- Administer Jira project permission to create all, including global-scoped, workflows
- Administer projects project permissions to create project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowValidationErrorList
Parameters
- parameters: Version3Parameters.ValidateCreateWorkflows
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:381

validateUpdateWorkflows

validateUpdateWorkflows<T = Version3Models.WorkflowValidationErrorList>(
parameters: Version3Parameters.ValidateUpdateWorkflows,
callback: Callback<T>,
): Promise<void>
Validate the payload for bulk update workflows.

Permissions required:
- Administer Jira project permission to create all, including global-scoped, workflows
- Administer projects project permissions to create project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowValidationErrorList
Parameters
- parameters: Version3Parameters.ValidateUpdateWorkflows
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:503
validateUpdateWorkflows<T = Version3Models.WorkflowValidationErrorList>(
parameters: Version3Parameters.ValidateUpdateWorkflows,
callback?: undefined,
): Promise<T>
Validate the payload for bulk update workflows.

Permissions required:
- Administer Jira project permission to create all, including global-scoped, workflows
- Administer projects project permissions to create project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowValidationErrorList
Parameters
- parameters: Version3Parameters.ValidateUpdateWorkflows
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:515

workflowCapabilities

workflowCapabilities<T = Version3Models.WorkflowCapabilities>(
parameters: undefined | Version3Models.WorkflowCapabilities,
callback: Callback<T>,
): Promise<void>
Get the list of workflow capabilities for a specific workflow using either the workflow ID, or the project and issue type ID pair. The response includes the scope of the workflow, defined as global/project-based, and a list of project types that the workflow is scoped to. It also includes all rules organised into their broad categories (conditions, validators, actions, triggers, screens) as well as the source location (Atlassian-provided, Connect, Forge).

Permissions required:
- Administer Jira project permission to access all, including global-scoped, workflows
- Administer projects project permissions to access project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowCapabilities
Parameters
- parameters: undefined | Version3Models.WorkflowCapabilities
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflows.ts:283
workflowCapabilities<T = Version3Models.WorkflowCapabilities>(
parameters?: Version3Models.WorkflowCapabilities,
callback?: undefined,
): Promise<T>
Get the list of workflow capabilities for a specific workflow using either the workflow ID, or the project and issue type ID pair. The response includes the scope of the workflow, defined as global/project-based, and a list of project types that the workflow is scoped to. It also includes all rules organised into their broad categories (conditions, validators, actions, triggers, screens) as well as the source location (Atlassian-provided, Connect, Forge).

Permissions required:
- Administer Jira project permission to access all, including global-scoped, workflows
- Administer projects project permissions to access project-scoped workflows
Type Parameters
- T = Version3Models.WorkflowCapabilities
Parameters
- Optionalparameters: Version3Models.WorkflowCapabilities
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflows.ts:299

Class Workflows

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.Workflows

Methods

createWorkflow

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

createWorkflows

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteInactiveWorkflow

Type Parameters

Parameters

Returns Promise<void>

getProjectUsagesForWorkflow

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getWorkflowProjectIssueTypeUsages

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getWorkflowSchemeUsagesForWorkflow

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getWorkflowsPaginated

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

readWorkflows

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

searchWorkflows

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateWorkflows

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

validateCreateWorkflows

Type Parameters

Parameters

Returns Promise<void>