Interface CreatePrioritySchemeDetails

Details of a new priority scheme

interface CreatePrioritySchemeDetails {
    defaultPriorityId: number;
    description?: string;
    mappings?: PriorityMapping;
    name: string;
    priorityIds: number[];
    projectIds?: number[];
}

Properties

defaultPriorityId description? mappings? name priorityIds projectIds?

Properties

defaultPriorityId

defaultPriorityId: number

The ID of the default priority for the priority scheme.

Optionaldescription

description?: string

The description of the priority scheme.

Optionalmappings

mappings?: PriorityMapping

Instructions to migrate the priorities of issues.

in mappings are used to migrate the priorities of issues to priorities used within the priority scheme.

out mappings are used to migrate the priorities of issues to priorities not used within the priority scheme.

  • When priorities are added to the new priority scheme, no mapping needs to be provided as the new priorities are not used by any issues.

  • When priorities are removed from the new priority scheme, no mapping needs to be provided as the removed priorities are not used by any issues.

  • When projects are added to the priority scheme, the priorities of issues in those projects might need to be migrated to new priorities used by the priority scheme. This can occur when the current scheme does not use all the priorities in the project(s)' priority scheme(s).

    • An in mapping must be provided for each of these priorities.

  • When projects are removed from the priority scheme, no mapping needs to be provided as the removed projects are not using the priorities of the new priority scheme.

For more information on in and out mappings, see the child properties documentation for the PriorityMapping object below.

name

name: string

The name of the priority scheme. Must be unique.

priorityIds

priorityIds: number[]

The IDs of priorities in the scheme.

OptionalprojectIds

projectIds?: number[]

The IDs of projects that will use the priority scheme.

Settings

Member Visibility

On This Page

Properties