Interface WorkflowSchemePayload

The payload for creating a workflow scheme. See https://www.atlassian.com/software/jira/guides/workflows/overview\#what-is-a-jira-workflow-scheme

interface WorkflowSchemePayload {
    defaultWorkflow?: ProjectCreateResourceIdentifier;
    description?: string;
    explicitMappings?: {
        [key: string]: ProjectCreateResourceIdentifier;
    };
    name?: string;
    pcri?: ProjectCreateResourceIdentifier;
}

Properties

defaultWorkflow? description? explicitMappings? name? pcri?

Properties

OptionaldefaultWorkflow

defaultWorkflow?: 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

Optionaldescription

description?: string

The description of the workflow scheme

OptionalexplicitMappings

explicitMappings?: {
    [key: string]: ProjectCreateResourceIdentifier;
}

Association between issuetypes and workflows

Type declaration

  • [key: string]: 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

Optionalname

name?: string

The name of the workflow scheme

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

Settings

Member Visibility

On This Page

Properties