Interface WorkflowDefinition

Hierarchy

WorkflowDefinitionProps
DefaultElements<WorkflowDefinitionProps>
WorkflowDefinitionApi
- WorkflowDefinition

Index

Properties

appliesTo? description? flowType? name startOnEntityCreation? steps sys

Methods

delete toPlainObject update

Properties

`Optional` appliesTo

appliesTo?: WorkflowDefinitionValidationLink[]

`Optional` description

description?: string

`Optional` flowType

flowType?: "no_restriction" | "strict_neighbor"

name

name: string

`Optional` startOnEntityCreation

startOnEntityCreation?: boolean

steps

steps: WorkflowStepProps[]

sys

sys: WorkflowDefinitionSysProps

Methods

delete

delete(): Promise<void>
Returns Promise<void>
Inherited from WorkflowDefinitionApi.delete
- Defined in lib/entities/workflow-definition.ts:140

toPlainObject

toPlainObject(): WorkflowDefinitionProps
Returns WorkflowDefinitionProps
Inherited from DefaultElements.toPlainObject
- Defined in lib/common-types.ts:131

update

update(): Promise<WorkflowDefinition>
Returns Promise<WorkflowDefinition>
Inherited from WorkflowDefinitionApi.update
- Defined in lib/entities/workflow-definition.ts:139