Options
All
  • Public
  • Public/Protected
  • All
Menu

The details of a workflow.

Hierarchy

  • CreateWorkflowDetails

Index

Properties

Optional description

description: string

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

name

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.

statuses

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

transitions

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.

Legend

  • Namespace
  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class
  • Class with type parameter
  • Enumeration

Generated using TypeDoc