form.web

Front-end form definition

type

object

properties

  • bindings

The bindings for value subscriptions

  • description

The form description

type

string

  • initialValue

The form initial value

  • isTemplateGeneratedByOspComposer

Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.

type

string

  • moduleId

The ids of the modules that will have access to this form.

type

array

items

type

string

  • name

The form name

type

string

  • rights

The form rights

Default value is [[]]

type

array

default

items

type

string

  • schema

The form JSON schema

type

string

  • submit

The form submit mechanism

oneOf

Value

Action

Request

Mixed

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • ui

The form UI schema

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

additionalProperties

False

Value

type

object

properties

  • destination

type

string

enum

Value

default

Value

  • type

Type of submit.

Default value is [“Immediate”]

type

string

enum

Immediate, Deferred

default

Immediate

additionalProperties

False

Action

type

object

properties

  • destination

type

string

enum

Action

default

Action

  • action

Action reference

type

string

  • script

Script reference

type

string

  • type

Type of submit.

Default value is [“Immediate”]

type

string

enum

Immediate, Deferred

default

Immediate

additionalProperties

False

Request

type

object

properties

  • destination

type

string

enum

Request

default

Request

  • type

Type of submit.

Default value is [“Immediate”]

type

string

enum

Immediate, Deferred

default

Immediate

additionalProperties

False

Mixed

type

object

properties

  • destination

type

string

enum

Mixed

default

Mixed

  • action

Action reference

type

string

  • script

Script reference

type

string

  • type

Type of submit.

Default value is [“Immediate”]

type

string

enum

Immediate, Deferred

default

Immediate

additionalProperties

False