The details of a workflow.

interface CreateWorkflow {
    description?: string;
    name: string;
    statuses: Version2.Version2Models.CreateWorkflowStatusDetails[];
    transitions: Version2.Version2Models.CreateWorkflowTransitionDetails[];
}

Hierarchy (view full)

Properties

description?: string

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

name: string

The name of the workflow. The name must be unique. The maximum length is 255 characters. Characters can be separated by a whitespace but the name cannot start or end with a whitespace.

The statuses of the workflow. Any status that does not include a transition is added to the workflow without a transition.

The transitions of the workflow. For the request to be valid, these transitions must:

Include one initial transition. not use the same name for a global and directed transition. have a unique name for each global transition. have a unique 'to' status for each global transition. have unique names for each transition from a status. not have a 'from' status on initial and global transitions. have a 'from' status on directed transitions.

All the transition statuses must be included in `statuses`.