Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace formInstance

Index

Functions

Functions

cloneInstance

  • cloneInstance(formInstanceId: string, withAttachments?: boolean): Promise<FormInstanceInfo>

  • Parameters

    • formInstanceId: string
    • Optional withAttachments: boolean

    Returns Promise<FormInstanceInfo>

create

  • create(formDefinitionId: string, expiresAt?: Date, useExistingDraft?: boolean, initialValues?: Record<string, unknown>, customFormDefinition?: { schema: unknown }): Promise<CreateFormInstanceResult>

  • Parameters

    • formDefinitionId: string
    • Optional expiresAt: Date
    • Optional useExistingDraft: boolean
    • Optional initialValues: Record<string, unknown>
    • Optional customFormDefinition: { schema: unknown }
      • schema: unknown

    Returns Promise<CreateFormInstanceResult>

deleteInstance

  • deleteInstance(id: string): Promise<any>

  • Parameters

    • id: string

    Returns Promise<any>

getInstanceInfo

  • Parameters

    • formInstanceId: string

    Returns Promise<FormInstanceInfo>

getInstanceUri

  • getInstanceUri(id: string): Promise<string>

  • Parameters

    • id: string

    Returns Promise<string>

getStageInfo

  • Parameters

    • id: string

    Returns Promise<StageInfo>

getStageInstanceUri

  • getStageInstanceUri(stageInstanceId: string): Promise<string>

  • Parameters

    • stageInstanceId: string

    Returns Promise<string>

listUserInstances

listUserStages

Generated using TypeDoc