Jira.js - Jira Cloud API library
    Preparing search index...

    Interface WorkflowScheme

    Details about a workflow scheme.

    interface WorkflowScheme {
        defaultWorkflow?: string;
        description?: string;
        draft?: boolean;
        id?: number;
        issueTypeMappings?: {};
        issueTypes?: {};
        lastModified?: string;
        lastModifiedUser?: Version2Models.User;
        name?: string;
        originalDefaultWorkflow?: string;
        originalIssueTypeMappings?: {};
        self?: string;
        updateDraftIfNeeded?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    defaultWorkflow? description? draft? id? issueTypeMappings? issueTypes? lastModified? lastModifiedUser? name? originalDefaultWorkflow? originalIssueTypeMappings? self? updateDraftIfNeeded?

    Properties

    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).

    description?: string

    The description of the workflow scheme.

    draft?: boolean

    Whether the workflow scheme is a draft or not.

    id?: number

    The ID of the workflow scheme.

    issueTypeMappings?: {}

    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.

    issueTypes?: {}

    The issue types available in Jira.

    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.

    lastModifiedUser?: Version2Models.User
    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.

    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.

    originalIssueTypeMappings?: {}

    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.

    self?: string
    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`.

    Settings

    Member Visibility

    On This Page

    Properties