Interface StatusPayload

The payload for creating a status

interface StatusPayload {
    description?: string;
    name?: string;
    onConflict?: "USE" | "NEW" | "FAIL";
    pcri?: ProjectCreateResourceIdentifier;
    statusCategory?: "TODO" | "IN_PROGRESS" | "DONE";
}

Properties

description? name? onConflict? pcri? statusCategory?

Properties

Optionaldescription

description?: string

The description of the status

Optionalname

name?: string

The name of the status

OptionalonConflict

onConflict?: "USE" | "NEW" | "FAIL"

The conflict strategy for the status already exists. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters; NEW - Create a new entity

Optionalpcri

pcri?: ProjectCreateResourceIdentifier

Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:\[entityType\]:\[type\]:\[entityId\] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either id - The ID of an entity that already exists in the target site, or ref - A unique reference to an entity that is being created entityId - entity identifier, if type is id - must be an existing entity ID that exists in the Jira site, if ref - must be unique across all entities in the scope of this project template creation

Example

pcri:permissionScheme:id:10001

OptionalstatusCategory

statusCategory?: "TODO" | "IN_PROGRESS" | "DONE"

The status category of the status. The value is case-sensitive.

Settings

Member Visibility

On This Page

Properties