Interface WorkflowDefinition

Hierarchy

WorkflowDefinitionProps
DefaultElements<WorkflowDefinitionProps>
WorkflowDefinitionApi
- WorkflowDefinition

Index

Properties

Methods

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>

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

toPlainObject

toPlainObject(): WorkflowDefinitionProps

Inherited from DefaultElements.toPlainObject
- Defined in common-types.ts:131
Returns WorkflowDefinitionProps

update

update(): Promise<WorkflowDefinition>

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