Interface CreateWorkflowTransitionDetails

The details of a workflow transition.

interface CreateWorkflowTransitionDetails {
    description?: string;
    from?: string[];
    name: string;
    properties?: {
        [key: string]: string;
    };
    rules?: CreateWorkflowTransitionRulesDetails;
    screen?: CreateWorkflowTransitionScreenDetails;
    to: string;
    type: "global" | "initial" | "directed";
}

Properties

description? from? name properties? rules? screen? to type

Properties

Optionaldescription

description?: string

The description of the transition. The maximum length is 1000 characters.

Optionalfrom

from?: string[]

The statuses the transition can start from.

name

name: string

The name of the transition. The maximum length is 60 characters.

Optionalproperties

properties?: {
    [key: string]: string;
}

The properties of the transition.

Optionalrules

rules?: CreateWorkflowTransitionRulesDetails

The rules of the transition.

Optionalscreen

screen?: CreateWorkflowTransitionScreenDetails

The screen of the transition.

to

to: string

The status the transition goes to.

type

type: "global" | "initial" | "directed"

The type of the transition.

Settings

Member Visibility

On This Page

Properties