WorkflowScheme | jira-rest-sdk

Details about a workflow scheme.

Hierarchy

WorkflowScheme

Index

Properties

Optional defaultWorkflow

defaultWorkflow: string

The name of the default workflow for the workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira. If defaultWorkflow is not specified when creating a workflow scheme, it is set to Jira Workflow (jira).

Optional description

description: string

The description of the workflow scheme.

Optional draft

draft: boolean

Whether the workflow scheme is a draft or not.

Optional id

id: number

The ID of the workflow scheme.

format: int64

Optional issueTypeMappings

issueTypeMappings: Record<string, string>

The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.

Optional issueTypes

issueTypes: Record<string, IssueTypeDetails>

The issue types available in Jira.

Optional lastModified

lastModified: string

The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.

Optional lastModifiedUser

lastModifiedUser: User

The user that last modified the draft workflow scheme. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.

Optional name

name: string

The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.

Optional originalDefaultWorkflow

originalDefaultWorkflow: string

For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira.

Optional originalIssueTypeMappings

originalIssueTypeMappings: Record<string, string>

For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.

Optional self

self: string

format: uri

Optional updateDraftIfNeeded

updateDraftIfNeeded: boolean

Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works:

Update an active workflow scheme with updateDraftIfNeeded set to true: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.
Update an active workflow scheme with updateDraftIfNeeded set to false: An error is returned, as active workflow schemes cannot be updated.
Update an inactive workflow scheme with updateDraftIfNeeded set to true: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update. Defaults to false.

Generated using TypeDoc