Skip to content

Instantly share code, notes, and snippets.

@joshbooker

joshbooker/events.md

Last active May 14, 2025 02:28
Show Gist options
  • Save joshbooker/b0c646a79fe4bb062561cdc72b75a809 to your computer and use it in GitHub Desktop.
Save joshbooker/b0c646a79fe4bb062561cdc72b75a809 to your computer and use it in GitHub Desktop.
Download ZIP
Epicor Kinetic Events.json Schema Docs
Raw
events.md

The Root Schema

Title: The Root Schema
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ $schema No string No - The $schema Schema
- description No string No - The Description Schema
+ contentVersion No string No - The Contentversion Schema
+ imports No array of object No - -
+ events No array of object No - The Events Schema

1. Property $schema

Title: The $schema Schema
Type string
Required Yes
Default ""

Example:

"../MetaFx/Schemas/5.0/Events.json"
Restrictions
Must match regular expression ^(.*)$ Test

2. Property description

Title: The Description Schema
Type string
Required No

3. Property contentVersion

Title: The Contentversion Schema
Type string
Required Yes
Default ""

Example:

"5.0"
Restrictions
Must match regular expression ^(.*)$ Test

4. Property imports
Type array of object
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The Items Schema -

4.1. The Items Schema

Title: The Items Schema
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- events No object No - The Tools Schema

4.1.1. Property events

Title: The Tools Schema
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ $ref No string No - The $ref Schema
4.1.1.1. Property $ref

Title: The $ref Schema
Type string
Required Yes
Default ""

Example:

"../Shared/ViewTypes/Default/tools.json#/tools"
Restrictions
Must match regular expression ^(.*)$ Test

5. Property events

Title: The Events Schema
Type array of object
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The Events Items Schema -

5.1. The Events Items Schema

Title: The Events Items Schema
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ id No string No - The Id Schema
- description No string No - The Description Schema
- trigger No Combination No - The Trigger Schema
+ actions No array No - -

5.1.1. Property id

Title: The Id Schema
Type string
Required Yes

5.1.2. Property description

Title: The Description Schema
Type string
Required No

5.1.3. Property trigger

Title: The Trigger Schema
Type combining
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ type No enum (of string) No - The type Schema
- target No string No - The target Schema
+ hook No enum (of string) No - The hook Schema
- columns No array of string No - The columns Schema
All of(Requirement)
item 0
item 1
5.1.3.1. Property item 0
Type object
Required No
Additional properties Any type allowed
5.1.3.1.1. If (type = "DataView")
Type object
Required No
Additional properties Any type allowed
5.1.3.1.1.1. The following properties are required
  • target
5.1.3.2. Property item 1
Type object
Required No
Additional properties Any type allowed
5.1.3.2.1. If (type = "EpBinding")
Type object
Required No
Additional properties Any type allowed
5.1.3.2.1.1. The following properties are required
  • target
5.1.3.3. Property type

Title: The type Schema
Type enum (of string)
Required Yes

Must be one of:

  • "Control"
  • "Window"
  • "EpBinding"
  • "DataView"
  • "DataTable"
  • "Grid"
  • "Page"
  • "Tree"
  • "Event"
5.1.3.4. Property target

Title: The target Schema
Type string
Required No
5.1.3.5. Property hook

Title: The hook Schema
Type enum (of string)
Required Yes

Must be one of:

  • "onClick"
  • "onLoad"
  • "columnChanging"
  • "columnChanged"
  • "rowChanged"
  • "rowChanging"
  • "viewChanged"
  • "viewChanging"
  • "onEpPanelCardCollapsed"
  • "onEpPanelCardExpanded"
  • "onSearch"
  • "epOnClickAdd"
  • "onDataDropDownClick"
  • "onInit"
  • "onBlur"
  • "onClosing"
  • "onClosed"
  • "onTreeNodeExpand"
  • "onTreeNodeSelectionChange"
  • "onTreeDropItem"
  • "onTreeDragEnter"
  • "onTreeBeforeExpandAll"
  • "onBroadcastData"
  • "onItemClick"
  • "onLinkClick"
  • "before"
  • "after"
5.1.3.6. Property columns

Title: The columns Schema
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The Columns Items Schema -
5.1.3.6.1. The Columns Items Schema

Title: The Columns Items Schema
Type string
Required No

5.1.4. Property actions
Type array
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The action Schema -
5.1.4.1. The action Schema

Title: The action Schema
Type combining
Required No
Additional properties Not allowed
Defined in #/definitions/eventAction
Property Pattern Type Deprecated Definition Title/Description
+ type No enum (of string) No - The type Schema
- param No object or array of object No - The Param Schema
- value No string, boolean, number or null No - The Value Schema
- option No object No - The Option Schema
- epBinding No string No - The EpBinding Schema
- dataview No string No - The Dataview Schema
- dataTable No string No - The Datatable Schema
- onSuccess No array No In #/definitions/successResult The actionResult Schema
- onError No array No In #/definitions/errorResult The actionResult Schema
- onEmpty No array No In #/definitions/emptyResult The actionResult Schema
- condition No string No - The Condition Schema
- variable No string No - The variable Schema
- onOk No array No In #/definitions/okResult The actionResult Schema
- onCancel No array No In #/definitions/cancelResult The actionResult Schema
- onYes No array No In #/definitions/yesResult The actionResult Schema
- onNo No array No In #/definitions/noResult The actionResult Schema
- onRetry No array No In #/definitions/retryResult The actionResult Schema
- onNone No array No In #/definitions/noneResult The actionResult Schema
- onAbort No array No In #/definitions/abortResult The actionResult Schema
- onIgnore No array No In #/definitions/ignoreResult The actionResult Schema
- expression No string No - The Expression Schema
All of(Requirement)
item 0
item 1
item 2
item 3
item 4
item 5
item 6
item 7
item 8
item 9
item 10
item 11
item 12
item 13
item 14
item 15
item 16
item 17
item 18
item 19
item 20
item 21
item 22
item 23
item 24
item 25
item 26
item 27
item 28
item 29
item 30
item 31
item 32
item 33
item 34
item 35
item 36
item 37
item 38
item 39
item 40
item 41
item 42
item 43
item 44
item 45
item 46
item 47
item 48
item 49
item 50
item 51
item 52
item 53
item 54
item 55
item 56
5.1.4.1.1. Property item 0
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1. If (type = "rest-erp")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/rest-erp The Erp Rest Schema
5.1.4.1.1.1.1. Property param

Title: The Erp Rest Schema
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/rest-erp
Property Pattern Type Deprecated Definition Title/Description
+ svc No string No - The svc Schema
+ svcPath No string No - The svcPath Schema
+ requestMethod No string No - The requestMethod Schema
- erpRequestMethod No enum (of string) No - The erpRequestMethod Schema
- methodParameters No array No - The methodParameters Schema
- erpRestPostArgs No object No - The rest-erpPostArgs Schema
- erpBaqArgs No object No - -
- options No object No In #/definitions/epRestCallOptions -
- dirtyRows No array No - The dirtyRows Schema
5.1.4.1.1.1.1.1. Property svc

Title: The svc Schema
Type string
Required Yes
5.1.4.1.1.1.1.2. Property svcPath

Title: The svcPath Schema
Type string
Required Yes
5.1.4.1.1.1.1.3. Property requestMethod

Title: The requestMethod Schema
Type string
Required Yes
Default "POST"
5.1.4.1.1.1.1.4. Property erpRequestMethod

Title: The erpRequestMethod Schema
Type enum (of string)
Required No

Must be one of:

  • "GetAndFillEpDataview"
  • "PatchFromEpDataView"
  • "PostFromEpDataview"
  • "PostWithCustomMethod"
  • "UpdateAndPostDataTable"
  • "ErpPostWithDataViewProcessing"
  • "Get"
  • "Post"
  • "Put"
  • "Delete"
  • "Options"
  • "Head"
  • "Patch"
5.1.4.1.1.1.1.5. Property methodParameters

Title: The methodParameters Schema
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The params Schema -
5.1.4.1.1.1.1.5.1. The params Schema

Title: The params Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/params
Property Pattern Type Deprecated Definition Title/Description
+ field No string No - The field Schema
- operator No string No - The operator Schema
- epBinding No string No - The epBinding Schema
- value No null, boolean, object, array, number or string No - The value Schema
- model No string No - The model Schema
- interpolation No object No In #/definitions/interpolation The interpolation Schema
- rowMode No string No - The rowMode Schema
- isArray No boolean No - The isArray Schema
- onlyWhenHasChanges No boolean No - The onlyWhenHasChanges Schema
- session No string No - The session Schema
- params No array No - The params Schema
5.1.4.1.1.1.1.5.1.1. Property field

Title: The field Schema
Type string
Required Yes
5.1.4.1.1.1.1.5.1.2. Property operator

Title: The operator Schema
Type string
Required No
5.1.4.1.1.1.1.5.1.3. Property epBinding

Title: The epBinding Schema
Type string
Required No
5.1.4.1.1.1.1.5.1.4. Property value

Title: The value Schema
Type null, boolean, object, array, number or string
Required No
5.1.4.1.1.1.1.5.1.5. Property model

Title: The model Schema
Type string
Required No
5.1.4.1.1.1.1.5.1.6. Property interpolation

Title: The interpolation Schema
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/interpolation
Property Pattern Type Deprecated Definition Title/Description
+ str No string No - The str Schema
+ args No array No - The args Schema
5.1.4.1.1.1.1.5.1.6.1. Property str

Title: The str Schema
Type string
Required Yes
5.1.4.1.1.1.1.5.1.6.2. Property args

Title: The args Schema
Type array
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The Interpolation Schema -
5.1.4.1.1.1.1.5.1.6.2.1. The Interpolation Schema

Title: The Interpolation Schema
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/interpolationArgs
Property Pattern Type Deprecated Definition Title/Description
+ epBinding No string No - The module Schema
- session No string No - The session Schema
- script No string No - The script Schema
5.1.4.1.1.1.1.5.1.6.2.1.1. Property epBinding

Title: The module Schema
Type string
Required Yes
5.1.4.1.1.1.1.5.1.6.2.1.2. Property session

Title: The session Schema
Type string
Required No
5.1.4.1.1.1.1.5.1.6.2.1.3. Property script

Title: The script Schema
Type string
Required No
5.1.4.1.1.1.1.5.1.7. Property rowMode

Title: The rowMode Schema
Type string
Required No
5.1.4.1.1.1.1.5.1.8. Property isArray

Title: The isArray Schema
Type boolean
Required No
5.1.4.1.1.1.1.5.1.9. Property onlyWhenHasChanges

Title: The onlyWhenHasChanges Schema
Type boolean
Required No
5.1.4.1.1.1.1.5.1.10. Property session

Title: The session Schema
Type string
Required No
5.1.4.1.1.1.1.5.1.11. Property params

Title: The params Schema
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The params Schema -
5.1.4.1.1.1.1.5.1.11.1. The params Schema

Title: The params Schema
Type object
Required No
Additional properties Not allowed
Same definition as The params Schema
5.1.4.1.1.1.1.6. Property erpRestPostArgs

Title: The rest-erpPostArgs Schema
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- requestParamArgs No array No - The requestParamArgs Schema
- responseParamArgs No array No - The responseParamArgs Schema
- processResponse No boolean No - The processResponse Schema
- responsePath No string No - The responsePath Schema
- fillExtendedProps No object No - The fillExtendedProps Schema
5.1.4.1.1.1.1.6.1. Property requestParamArgs

Title: The requestParamArgs Schema
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
erpDataViewRequestParamArg -
5.1.4.1.1.1.1.6.1.1. erpDataViewRequestParamArg
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/erpDataViewRequestParamArg
Property Pattern Type Deprecated Definition Title/Description
- paramName No string No - The paramName Schema
- viewName No string No - The viewName Schema
- dataset No object No In #/definitions/erpDataset The dataset Schema
- methodParamModifier No string No - The methodParamModifier Schema
5.1.4.1.1.1.1.6.1.1.1. Property paramName

Title: The paramName Schema
Type string
Required No
5.1.4.1.1.1.1.6.1.1.2. Property viewName

Title: The viewName Schema
Type string
Required No
5.1.4.1.1.1.1.6.1.1.3. Property dataset

Title: The dataset Schema
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/erpDataset
Property Pattern Type Deprecated Definition Title/Description
- systemCode No string No - The systemCode Schema
+ datasetId No string No - The datasetId Schema
- serverDataset No string No - The serverDataset Schema
- tables No array No - The tables Schema
5.1.4.1.1.1.1.6.1.1.3.1. Property systemCode

Title: The systemCode Schema
Type string
Required No
5.1.4.1.1.1.1.6.1.1.3.2. Property datasetId

Title: The datasetId Schema
Type string
Required Yes
5.1.4.1.1.1.1.6.1.1.3.3. Property serverDataset

Title: The serverDataset Schema
Type string
Required No
5.1.4.1.1.1.1.6.1.1.3.4. Property tables

Title: The tables Schema
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
erpDatasetTable -
5.1.4.1.1.1.1.6.1.1.3.4.1. erpDatasetTable
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/erpDatasetTable
Property Pattern Type Deprecated Definition Title/Description
+ systemCode No string No - The systemCode Schema
+ tableId No string No - The tableId Schema
+ keys No array of string No - The keys Schema
5.1.4.1.1.1.1.6.1.1.3.4.1.1. Property systemCode

Title: The systemCode Schema
Type string
Required Yes
5.1.4.1.1.1.1.6.1.1.3.4.1.2. Property tableId

Title: The tableId Schema
Type string
Required Yes
5.1.4.1.1.1.1.6.1.1.3.4.1.3. Property keys

Title: The keys Schema
Type array of string
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
keys items -
5.1.4.1.1.1.1.6.1.1.3.4.1.3.1. keys items
Type string
Required No
5.1.4.1.1.1.1.6.1.1.4. Property methodParamModifier

Title: The methodParamModifier Schema
Type string
Required No
5.1.4.1.1.1.1.6.2. Property responseParamArgs

Title: The responseParamArgs Schema
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
erpDataViewResponseParamArg -
5.1.4.1.1.1.1.6.2.1. erpDataViewResponseParamArg
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/erpDataViewResponseParamArg
Property Pattern Type Deprecated Definition Title/Description
- paramName No string No - The paramName Schema
- viewName No string No - The viewName Schema
- dataset No object No In #/definitions/erpDataset The dataset Schema
- responsePath No string No - The responsePath Schema
- mergeBehavior No string No - The mergeBehavior Schema
5.1.4.1.1.1.1.6.2.1.1. Property paramName

Title: The paramName Schema
Type string
Required No
5.1.4.1.1.1.1.6.2.1.2. Property viewName

Title: The viewName Schema
Type string
Required No
5.1.4.1.1.1.1.6.2.1.3. Property dataset

Title: The dataset Schema
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/erpDataset
Property Pattern Type Deprecated Definition Title/Description
- systemCode No string No - The systemCode Schema
+ datasetId No string No - The datasetId Schema
- serverDataset No string No - The serverDataset Schema
- tables No array No - The tables Schema
5.1.4.1.1.1.1.6.2.1.3.1. Property systemCode

Title: The systemCode Schema
Type string
Required No
5.1.4.1.1.1.1.6.2.1.3.2. Property datasetId

Title: The datasetId Schema
Type string
Required Yes
5.1.4.1.1.1.1.6.2.1.3.3. Property serverDataset

Title: The serverDataset Schema
Type string
Required No
5.1.4.1.1.1.1.6.2.1.3.4. Property tables

Title: The tables Schema
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
erpDatasetTable -
5.1.4.1.1.1.1.6.2.1.3.4.1. erpDatasetTable
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/erpDatasetTable
Property Pattern Type Deprecated Definition Title/Description
+ systemCode No string No - The systemCode Schema
+ tableId No string No - The tableId Schema
+ keys No array of string No - The keys Schema
5.1.4.1.1.1.1.6.2.1.3.4.1.1. Property systemCode

Title: The systemCode Schema
Type string
Required Yes
5.1.4.1.1.1.1.6.2.1.3.4.1.2. Property tableId

Title: The tableId Schema
Type string
Required Yes
5.1.4.1.1.1.1.6.2.1.3.4.1.3. Property keys

Title: The keys Schema
Type array of string
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
keys items -
5.1.4.1.1.1.1.6.2.1.3.4.1.3.1. keys items
Type string
Required No
5.1.4.1.1.1.1.6.2.1.4. Property responsePath

Title: The responsePath Schema
Type string
Required No
5.1.4.1.1.1.1.6.2.1.5. Property mergeBehavior

Title: The mergeBehavior Schema
Type string
Required No
5.1.4.1.1.1.1.6.3. Property processResponse

Title: The processResponse Schema
Type boolean
Required No
5.1.4.1.1.1.1.6.4. Property responsePath

Title: The responsePath Schema
Type string
Required No
5.1.4.1.1.1.1.6.5. Property fillExtendedProps

Title: The fillExtendedProps Schema
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- useDefaultValues No boolean No - -
- paramName No string No - -
- responsePath No string No - -
5.1.4.1.1.1.1.6.5.1. Property useDefaultValues
Type boolean
Required No
5.1.4.1.1.1.1.6.5.2. Property paramName
Type string
Required No
5.1.4.1.1.1.1.6.5.3. Property responsePath
Type string
Required No
5.1.4.1.1.1.1.7. Property erpBaqArgs
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- baqId No Combination No - -
- options No object No In #/definitions/erpBaqOptions -
- data No object No - -
5.1.4.1.1.1.1.7.1. Property baqId
Type combining
Required No
One of(Option)
item 0
item 1
5.1.4.1.1.1.1.7.1.1. Property item 0
Type string
Required No
5.1.4.1.1.1.1.7.1.2. Property item 1
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
item 1 items -
5.1.4.1.1.1.1.7.1.2.1. item 1 items
Type string
Required No
5.1.4.1.1.1.1.7.2. Property options
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/erpBaqOptions
Property Pattern Type Deprecated Definition Title/Description
- top No number No - -
- executeOptions No object No - -
- virtualizations No array of object No - -
- updateOptions No object No - -
- retrieveMetaData No boolean No - -
- alias No string No - -
- populateDataView No boolean No - -
- headers No object No - -
- disableToken No boolean No - -
- raw No boolean No - -
- pathParams No array No - -
- params No object No - -
- query No Combination No - -
- showProgress No boolean No - -
- showProgressBar No boolean No - -
- progressText No string No - -
- observe No enum (of string) No - -
- output No object No - -
- responseType No enum (of string) No - -
- fnGetUrl No object No - -
5.1.4.1.1.1.1.7.2.1. Property top
Type number
Required No
5.1.4.1.1.1.1.7.2.2. Property executeOptions
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- pageNumber No number No - -
- pageSize No number No - -
- select No array of string No - -
- orderBy No array of string No - -
- groupBy No array of string No - -
- aggregate No object No - -
- where No object No In #/definitions/epDataFilterExpression -
- having No object No Same as where -
5.1.4.1.1.1.1.7.2.2.1. Property pageNumber
Type number
Required No
5.1.4.1.1.1.1.7.2.2.2. Property pageSize
Type number
Required No
5.1.4.1.1.1.1.7.2.2.3. Property select
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
select items -
5.1.4.1.1.1.1.7.2.2.3.1. select items
Type string
Required No
5.1.4.1.1.1.1.7.2.2.4. Property orderBy
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
orderBy items -
5.1.4.1.1.1.1.7.2.2.4.1. orderBy items
Type string
Required No
5.1.4.1.1.1.1.7.2.2.5. Property groupBy
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
groupBy items -
5.1.4.1.1.1.1.7.2.2.5.1. groupBy items
Type string
Required No
5.1.4.1.1.1.1.7.2.2.6. Property aggregate
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ column No string No - -
+ type No enum (of string) No - -
5.1.4.1.1.1.1.7.2.2.6.1. Property column
Type string
Required Yes
5.1.4.1.1.1.1.7.2.2.6.2. Property type
Type enum (of string)
Required Yes

Must be one of:

  • "sum"
  • "avg"
  • "min"
  • "max"
  • "count"
5.1.4.1.1.1.1.7.2.2.7. Property where
Type combining
Required No
Additional properties Any type allowed
Defined in #/definitions/epDataFilterExpression
Any of(Option)
epCriteriaExpression
EpCriteriaBuilder
item 2
5.1.4.1.1.1.1.7.2.2.7.1. Property epCriteriaExpression
Type array
Required No
Defined in #/definitions/epCriteriaExpression
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
epCriteriaElement -
5.1.4.1.1.1.1.7.2.2.7.1.1. epCriteriaElement
Type combining
Required No
Additional properties Any type allowed
Defined in #/definitions/epCriteriaElement
Any of(Option)
epCriteriaItem
EpCriteriaGroup
5.1.4.1.1.1.1.7.2.2.7.1.1.1. Property epCriteriaItem
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/epCriteriaItem
Property Pattern Type Deprecated Definition Title/Description
+ sensitiveCompare No boolean No - -
+ negate No boolean No - -
+ criteria No object No In #/definitions/epCriteria -
+ columnEpBound No boolean No - -
+ columns No array of string No - -
5.1.4.1.1.1.1.7.2.2.7.1.1.1.1. Property sensitiveCompare
Type boolean
Required Yes
5.1.4.1.1.1.1.7.2.2.7.1.1.1.2. Property negate
Type boolean
Required Yes
5.1.4.1.1.1.1.7.2.2.7.1.1.1.3. Property criteria
Type object
Required Yes
Additional properties Any type allowed
Defined in #/definitions/epCriteria
Property Pattern Type Deprecated Definition Title/Description
+ operator No string No - -
+ column No string No - -
- value No object No - -
- valueType No enum (of string) No - -
- columnEpBound No boolean No - -
5.1.4.1.1.1.1.7.2.2.7.1.1.1.3.1. Property operator
Type string
Required Yes
5.1.4.1.1.1.1.7.2.2.7.1.1.1.3.2. Property column
Type string
Required Yes
5.1.4.1.1.1.1.7.2.2.7.1.1.1.3.3. Property value
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.7.2.2.7.1.1.1.3.4. Property valueType
Type enum (of string)
Required No

Must be one of:

  • "string"
  • "number"
  • "boolean"
  • "date"
5.1.4.1.1.1.1.7.2.2.7.1.1.1.3.5. Property columnEpBound
Type boolean
Required No
5.1.4.1.1.1.1.7.2.2.7.1.1.1.4. Property columnEpBound
Type boolean
Required Yes
5.1.4.1.1.1.1.7.2.2.7.1.1.1.5. Property columns
Type array of string
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
columns items -
5.1.4.1.1.1.1.7.2.2.7.1.1.1.5.1. columns items
Type string
Required No
5.1.4.1.1.1.1.7.2.2.7.1.1.2. Property EpCriteriaGroup
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/EpCriteriaGroup
Property Pattern Type Deprecated Definition Title/Description
+ negate No boolean No - -
+ group No object No In #/definitions/IEpCriteriaGroup -
+ isNegated No boolean No - -
5.1.4.1.1.1.1.7.2.2.7.1.1.2.1. Property negate
Type boolean
Required Yes
5.1.4.1.1.1.1.7.2.2.7.1.1.2.2. Property group
Type object
Required Yes
Additional properties Any type allowed
Defined in #/definitions/IEpCriteriaGroup
Property Pattern Type Deprecated Definition Title/Description
+ operator No enum (of string) No - -
+ criteria No array No - -
5.1.4.1.1.1.1.7.2.2.7.1.1.2.2.1. Property operator
Type enum (of string)
Required Yes

Must be one of:

  • "and"
  • "or"
5.1.4.1.1.1.1.7.2.2.7.1.1.2.2.2. Property criteria
Type array
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
epCriteriaElement -
5.1.4.1.1.1.1.7.2.2.7.1.1.2.2.2.1. epCriteriaElement
Type combining
Required No
Additional properties Any type allowed
Same definition as events_items_actions_items_allOf_i0_then_param_erpBaqArgs_options_executeOptions_where_anyOf_i0_items
5.1.4.1.1.1.1.7.2.2.7.1.1.2.3. Property isNegated
Type boolean
Required Yes
5.1.4.1.1.1.1.7.2.2.7.2. Property EpCriteriaBuilder
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/EpCriteriaBuilder
Property Pattern Type Deprecated Definition Title/Description
+ criteriaColumns No array of string No - -
5.1.4.1.1.1.1.7.2.2.7.2.1. Property criteriaColumns
Type array of string
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
criteriaColumns items -
5.1.4.1.1.1.1.7.2.2.7.2.1.1. criteriaColumns items
Type string
Required No
5.1.4.1.1.1.1.7.2.2.7.3. Property item 2
Type string
Required No
5.1.4.1.1.1.1.7.2.2.8. Property having
Type combining
Required No
Additional properties Any type allowed
Same definition as where
5.1.4.1.1.1.1.7.2.3. Property virtualizations
Type array of object
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
virtualizations items -
5.1.4.1.1.1.1.7.2.3.1. virtualizations items
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ mode No enum (of string) No - -
- select No array of string No - -
- orderBy No array of string No - -
- groupBy No array of string No - -
5.1.4.1.1.1.1.7.2.3.1.1. Property mode
Type enum (of string)
Required Yes

Must be one of:

  • "recordCount"
  • "groupByDetails"
  • "pageCount"
5.1.4.1.1.1.1.7.2.3.1.2. Property select
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
select items -
5.1.4.1.1.1.1.7.2.3.1.2.1. select items
Type string
Required No
5.1.4.1.1.1.1.7.2.3.1.3. Property orderBy
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
orderBy items -
5.1.4.1.1.1.1.7.2.3.1.3.1. orderBy items
Type string
Required No
5.1.4.1.1.1.1.7.2.3.1.4. Property groupBy
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
groupBy items -
5.1.4.1.1.1.1.7.2.3.1.4.1. groupBy items
Type string
Required No
5.1.4.1.1.1.1.7.2.4. Property updateOptions
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ operation No enum (of string) No - -
- fieldName No string No - -
- fieldValue No object No - -
- actionID No string No - -
- viewName No string No - -
5.1.4.1.1.1.1.7.2.4.1. Property operation
Type enum (of string)
Required Yes

Must be one of:

  • "UpdateBaq"
  • "UpdateBaqFieldUpdate"
  • "UpdateBaqFieldValidate"
  • "UpdateBaqCustomAction"
  • "UpdateBaqGetNew"
5.1.4.1.1.1.1.7.2.4.2. Property fieldName
Type string
Required No
5.1.4.1.1.1.1.7.2.4.3. Property fieldValue
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.7.2.4.4. Property actionID
Type string
Required No
5.1.4.1.1.1.1.7.2.4.5. Property viewName
Type string
Required No
5.1.4.1.1.1.1.7.2.5. Property retrieveMetaData
Type boolean
Required No
5.1.4.1.1.1.1.7.2.6. Property alias
Type string
Required No
5.1.4.1.1.1.1.7.2.7. Property populateDataView
Type boolean
Required No
5.1.4.1.1.1.1.7.2.8. Property headers
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.7.2.9. Property disableToken
Type boolean
Required No
5.1.4.1.1.1.1.7.2.10. Property raw
Type boolean
Required No
5.1.4.1.1.1.1.7.2.11. Property pathParams
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
pathParams items -
5.1.4.1.1.1.1.7.2.11.1. pathParams items
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.7.2.12. Property params
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.7.2.13. Property query
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
5.1.4.1.1.1.1.7.2.13.1. Property item 0
Type string
Required No
5.1.4.1.1.1.1.7.2.13.2. Property item 1
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ odataObject No object No - -
5.1.4.1.1.1.1.7.2.13.2.1. Property odataObject
Type object
Required Yes
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No string No - -
- $filter No string No - -
- $top No number No - -
- $skip No number No - -
- $orderby No string No - -
- $select No string No - -
- $expand No string No - -
5.1.4.1.1.1.1.7.2.13.2.1.1. Property type
Type string
Required No
5.1.4.1.1.1.1.7.2.13.2.1.2. Property $filter
Type string
Required No
5.1.4.1.1.1.1.7.2.13.2.1.3. Property $top
Type number
Required No
5.1.4.1.1.1.1.7.2.13.2.1.4. Property $skip
Type number
Required No
5.1.4.1.1.1.1.7.2.13.2.1.5. Property $orderby
Type string
Required No
5.1.4.1.1.1.1.7.2.13.2.1.6. Property $select
Type string
Required No
5.1.4.1.1.1.1.7.2.13.2.1.7. Property $expand
Type string
Required No
5.1.4.1.1.1.1.7.2.14. Property showProgress
Type boolean
Required No
5.1.4.1.1.1.1.7.2.15. Property showProgressBar
Type boolean
Required No
5.1.4.1.1.1.1.7.2.16. Property progressText
Type string
Required No
5.1.4.1.1.1.1.7.2.17. Property observe
Type enum (of string)
Required No

Must be one of:

  • "response"
  • "body"
  • "events"
5.1.4.1.1.1.1.7.2.18. Property output
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ logEntry No object No - -
+ isValue No boolean No - -
+ response No object No - -
- errorResponse No object No - -
5.1.4.1.1.1.1.7.2.18.1. Property logEntry
Type object
Required Yes
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ url No string No - -
+ method No string No - -
- headers No object No - -
+ startTime No object No - -
+ endTime No object No - -
- dataCount No number No - -
5.1.4.1.1.1.1.7.2.18.1.1. Property url
Type string
Required Yes
5.1.4.1.1.1.1.7.2.18.1.2. Property method
Type string
Required Yes
5.1.4.1.1.1.1.7.2.18.1.3. Property headers
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.7.2.18.1.4. Property startTime
Type object
Required Yes
Additional properties Any type allowed
5.1.4.1.1.1.1.7.2.18.1.5. Property endTime
Type object
Required Yes
Additional properties Any type allowed
5.1.4.1.1.1.1.7.2.18.1.6. Property dataCount
Type number
Required No
5.1.4.1.1.1.1.7.2.18.2. Property isValue
Type boolean
Required Yes
5.1.4.1.1.1.1.7.2.18.3. Property response
Type object
Required Yes
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ headers No object No - -
+ status No number No - -
+ statusText No string No - -
+ url No string or null No - -
+ ok No boolean No - -
+ type No Combination No - -
+ body No Combination No - -
5.1.4.1.1.1.1.7.2.18.3.1. Property headers
Type object
Required Yes
Additional properties Any type allowed
5.1.4.1.1.1.1.7.2.18.3.2. Property status
Type number
Required Yes
5.1.4.1.1.1.1.7.2.18.3.3. Property statusText
Type string
Required Yes
5.1.4.1.1.1.1.7.2.18.3.4. Property url
Type string or null
Required Yes
5.1.4.1.1.1.1.7.2.18.3.5. Property ok
Type boolean
Required Yes
5.1.4.1.1.1.1.7.2.18.3.6. Property type
Type combining
Required Yes
Any of(Option)
item 0
item 1
5.1.4.1.1.1.1.7.2.18.3.6.1. Property item 0
Type enum (of integer)
Required No

Must be one of:

  • 4
5.1.4.1.1.1.1.7.2.18.3.6.2. Property item 1
Type enum (of integer)
Required No

Must be one of:

  • 2

Must be one of:

  • 4
5.1.4.1.1.1.1.7.2.18.3.7. Property body
Type combining
Required Yes
Additional properties Any type allowed
Any of(Option)
item 0
item 1
5.1.4.1.1.1.1.7.2.18.3.7.1. Property item 0
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.7.2.18.3.7.2. Property item 1
Type null
Required No
5.1.4.1.1.1.1.7.2.18.4. Property errorResponse
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ name No string No - -
+ message No string No - -
- stack No string No - -
+ headers No object No - -
+ status No number No - -
+ statusText No string No - -
+ url No string or null No - -
+ ok No boolean No - -
+ type No Combination No - -
+ error No Combination No - -
5.1.4.1.1.1.1.7.2.18.4.1. Property name
Type string
Required Yes
5.1.4.1.1.1.1.7.2.18.4.2. Property message
Type string
Required Yes
5.1.4.1.1.1.1.7.2.18.4.3. Property stack
Type string
Required No
5.1.4.1.1.1.1.7.2.18.4.4. Property headers
Type object
Required Yes
Additional properties Any type allowed
5.1.4.1.1.1.1.7.2.18.4.5. Property status
Type number
Required Yes
5.1.4.1.1.1.1.7.2.18.4.6. Property statusText
Type string
Required Yes
5.1.4.1.1.1.1.7.2.18.4.7. Property url
Type string or null
Required Yes
5.1.4.1.1.1.1.7.2.18.4.8. Property ok
Type boolean
Required Yes
5.1.4.1.1.1.1.7.2.18.4.9. Property type
Type combining
Required Yes
Additional properties Any type allowed
Any of(Option)
item 0
item 1
5.1.4.1.1.1.1.7.2.18.4.9.1. Property item 0
Type enum (of integer)
Required No

Must be one of:

  • 4
5.1.4.1.1.1.1.7.2.18.4.9.2. Property item 1
Type enum (of integer)
Required No

Must be one of:

  • 2
5.1.4.1.1.1.1.7.2.18.4.10. Property error
Type combining
Required Yes
Additional properties Any type allowed
Any of(Option)
item 0
item 1
5.1.4.1.1.1.1.7.2.18.4.10.1. Property item 0
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.7.2.18.4.10.2. Property item 1
Type null
Required No
5.1.4.1.1.1.1.7.2.19. Property responseType
Type enum (of string)
Required No

Must be one of:

  • "json"
  • "text"
  • "blob"
  • "arraybuffer"
5.1.4.1.1.1.1.7.2.20. Property fnGetUrl
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.7.3. Property data
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.8. Property options
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/epRestCallOptions
Property Pattern Type Deprecated Definition Title/Description
- headers No object No - -
- disableToken No boolean No - -
- raw No boolean No - -
- pathParams No array No - -
- params No object No - -
- query No Combination No - -
- showProgress No boolean No - -
- showProgressBar No boolean No - -
- progressText No string No - -
- rollbackOnError No boolean No - -
- observe No enum (of string) No - -
- output No object No - -
- responseType No enum (of string) No - -
- fnGetUrl No object No - -
5.1.4.1.1.1.1.8.1. Property headers
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.8.2. Property disableToken
Type boolean
Required No
5.1.4.1.1.1.1.8.3. Property raw
Type boolean
Required No
5.1.4.1.1.1.1.8.4. Property pathParams
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
pathParams items -
5.1.4.1.1.1.1.8.4.1. pathParams items
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.8.5. Property params
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.8.6. Property query
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
5.1.4.1.1.1.1.8.6.1. Property item 0
Type string
Required No
5.1.4.1.1.1.1.8.6.2. Property item 1
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ odataObject No object No - -
5.1.4.1.1.1.1.8.6.2.1. Property odataObject
Type object
Required Yes
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- type No string No - -
- $filter No string No - -
- $top No number No - -
- $skip No number No - -
- $orderby No string No - -
- $select No string No - -
- $expand No string No - -
5.1.4.1.1.1.1.8.6.2.1.1. Property type
Type string
Required No
5.1.4.1.1.1.1.8.6.2.1.2. Property $filter
Type string
Required No
5.1.4.1.1.1.1.8.6.2.1.3. Property $top
Type number
Required No
5.1.4.1.1.1.1.8.6.2.1.4. Property $skip
Type number
Required No
5.1.4.1.1.1.1.8.6.2.1.5. Property $orderby
Type string
Required No
5.1.4.1.1.1.1.8.6.2.1.6. Property $select
Type string
Required No
5.1.4.1.1.1.1.8.6.2.1.7. Property $expand
Type string
Required No
5.1.4.1.1.1.1.8.7. Property showProgress
Type boolean
Required No
5.1.4.1.1.1.1.8.8. Property showProgressBar
Type boolean
Required No
5.1.4.1.1.1.1.8.9. Property progressText
Type string
Required No
5.1.4.1.1.1.1.8.10. Property rollbackOnError
Type boolean
Required No
5.1.4.1.1.1.1.8.11. Property observe
Type enum (of string)
Required No

Must be one of:

  • "response"
  • "body"
  • "events"
5.1.4.1.1.1.1.8.12. Property output
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ logEntry No object No - -
+ isValue No boolean No - -
+ response No object No - -
- errorResponse No object No - -
5.1.4.1.1.1.1.8.12.1. Property logEntry
Type object
Required Yes
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ url No string No - -
+ method No string No - -
- headers No object No - -
+ startTime No object No - -
+ endTime No object No - -
- dataCount No number No - -
5.1.4.1.1.1.1.8.12.1.1. Property url
Type string
Required Yes
5.1.4.1.1.1.1.8.12.1.2. Property method
Type string
Required Yes
5.1.4.1.1.1.1.8.12.1.3. Property headers
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.8.12.1.4. Property startTime
Type object
Required Yes
Additional properties Any type allowed
5.1.4.1.1.1.1.8.12.1.5. Property endTime
Type object
Required Yes
Additional properties Any type allowed
5.1.4.1.1.1.1.8.12.1.6. Property dataCount
Type number
Required No
5.1.4.1.1.1.1.8.12.2. Property isValue
Type boolean
Required Yes
5.1.4.1.1.1.1.8.12.3. Property response
Type object
Required Yes
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ headers No object No - -
+ status No number No - -
+ statusText No string No - -
+ url No string or null No - -
+ ok No boolean No - -
+ type No Combination No - -
+ body No Combination No - -
5.1.4.1.1.1.1.8.12.3.1. Property headers
Type object
Required Yes
Additional properties Any type allowed
5.1.4.1.1.1.1.8.12.3.2. Property status
Type number
Required Yes
5.1.4.1.1.1.1.8.12.3.3. Property statusText
Type string
Required Yes
5.1.4.1.1.1.1.8.12.3.4. Property url
Type string or null
Required Yes
5.1.4.1.1.1.1.8.12.3.5. Property ok
Type boolean
Required Yes
5.1.4.1.1.1.1.8.12.3.6. Property type
Type combining
Required Yes
Any of(Option)
item 0
item 1
5.1.4.1.1.1.1.8.12.3.6.1. Property item 0
Type enum (of integer)
Required No

Must be one of:

  • 4
5.1.4.1.1.1.1.8.12.3.6.2. Property item 1
Type enum (of integer)
Required No

Must be one of:

  • 2

Must be one of:

  • 4
5.1.4.1.1.1.1.8.12.3.7. Property body
Type combining
Required Yes
Additional properties Any type allowed
Any of(Option)
item 0
item 1
5.1.4.1.1.1.1.8.12.3.7.1. Property item 0
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.8.12.3.7.2. Property item 1
Type null
Required No
5.1.4.1.1.1.1.8.12.4. Property errorResponse
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
+ name No string No - -
+ message No string No - -
- stack No string No - -
+ headers No object No - -
+ status No number No - -
+ statusText No string No - -
+ url No string or null No - -
+ ok No boolean No - -
+ type No Combination No - -
+ error No Combination No - -
5.1.4.1.1.1.1.8.12.4.1. Property name
Type string
Required Yes
5.1.4.1.1.1.1.8.12.4.2. Property message
Type string
Required Yes
5.1.4.1.1.1.1.8.12.4.3. Property stack
Type string
Required No
5.1.4.1.1.1.1.8.12.4.4. Property headers
Type object
Required Yes
Additional properties Any type allowed
5.1.4.1.1.1.1.8.12.4.5. Property status
Type number
Required Yes
5.1.4.1.1.1.1.8.12.4.6. Property statusText
Type string
Required Yes
5.1.4.1.1.1.1.8.12.4.7. Property url
Type string or null
Required Yes
5.1.4.1.1.1.1.8.12.4.8. Property ok
Type boolean
Required Yes
5.1.4.1.1.1.1.8.12.4.9. Property type
Type combining
Required Yes
Additional properties Any type allowed
Any of(Option)
item 0
item 1
5.1.4.1.1.1.1.8.12.4.9.1. Property item 0
Type enum (of integer)
Required No

Must be one of:

  • 4
5.1.4.1.1.1.1.8.12.4.9.2. Property item 1
Type enum (of integer)
Required No

Must be one of:

  • 2
5.1.4.1.1.1.1.8.12.4.10. Property error
Type combining
Required Yes
Additional properties Any type allowed
Any of(Option)
item 0
item 1
5.1.4.1.1.1.1.8.12.4.10.1. Property item 0
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.8.12.4.10.2. Property item 1
Type null
Required No
5.1.4.1.1.1.1.8.13. Property responseType
Type enum (of string)
Required No

Must be one of:

  • "json"
  • "text"
  • "blob"
  • "arraybuffer"
5.1.4.1.1.1.1.8.14. Property fnGetUrl
Type object
Required No
Additional properties Any type allowed
5.1.4.1.1.1.1.9. Property dirtyRows

Title: The dirtyRows Schema
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
dirtyRowsParam -
5.1.4.1.1.1.1.9.1. dirtyRowsParam
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/dirtyRowsParam
Property Pattern Type Deprecated Definition Title/Description
- view No string No - The view Schema
- condition No string No - The condition Schema
5.1.4.1.1.1.1.9.1.1. Property view

Title: The view Schema
Type string
Required No
5.1.4.1.1.1.1.9.1.2. Property condition

Title: The condition Schema
Type string
Required No
5.1.4.1.2. Property item 1
Type object
Required No
Additional properties Any type allowed
5.1.4.1.2.1. If (type = "event-next")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No - -
5.1.4.1.2.1.1. Property param
Type object
Required No
Additional properties Any type allowed
5.1.4.1.3. Property item 2
Type object
Required No
Additional properties Any type allowed
5.1.4.1.3.1. If (type = "return")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No - -
5.1.4.1.3.1.1. Property param
Type object
Required No
Additional properties Any type allowed
5.1.4.1.4. Property item 3
Type object
Required No
Additional properties Any type allowed
5.1.4.1.4.1. If (type = "return-error")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No - -
5.1.4.1.4.1.1. Property param
Type object
Required No
Additional properties Any type allowed
5.1.4.1.5. Property item 4
Type object
Required No
Additional properties Any type allowed
5.1.4.1.5.1. If (type = "row-update")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No array No - -
5.1.4.1.5.1.1. Property param
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The addRow Schema -
5.1.4.1.5.1.1.1. The addRow Schema

Title: The addRow Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/addRow
Property Pattern Type Deprecated Definition Title/Description
+ columns No array No - The columns Schema
5.1.4.1.5.1.1.1.1. Property columns

Title: The columns Schema
Type array
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The addRow Schema -
5.1.4.1.5.1.1.1.1.1. The addRow Schema

Title: The addRow Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/addColumn
Property Pattern Type Deprecated Definition Title/Description
+ epBinding No string No - The epBinding Schema
- value No object, array, boolean, string, number or null No - The value Schema
- dataType No string No - The dataType Schema
- expression No string No - JavaScript expression
5.1.4.1.5.1.1.1.1.1.1. Property epBinding

Title: The epBinding Schema
Type string
Required Yes
5.1.4.1.5.1.1.1.1.1.2. Property value

Title: The value Schema
Type object, array, boolean, string, number or null
Required No
5.1.4.1.5.1.1.1.1.1.3. Property dataType

Title: The dataType Schema
Type string
Required No
5.1.4.1.5.1.1.1.1.1.4. Property expression

Title: JavaScript expression
Type string
Required No
5.1.4.1.6. Property item 5
Type object
Required No
Additional properties Any type allowed
5.1.4.1.6.1. If (type = "row-delete")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No array No - -
5.1.4.1.6.1.1. Property param
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The row-delete Schema -
5.1.4.1.6.1.1.1. The row-delete Schema

Title: The row-delete Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/row-delete
Property Pattern Type Deprecated Definition Title/Description
+ datatview No string No - The Dataview Schema
5.1.4.1.6.1.1.1.1. Property datatview

Title: The Dataview Schema
Type string
Required Yes
5.1.4.1.7. Property item 6
Type object
Required No
Additional properties Any type allowed
5.1.4.1.7.1. If (type = "url-open")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/url-open The launchUrl Schema
5.1.4.1.7.1.1. Property param

Title: The launchUrl Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/url-open
Property Pattern Type Deprecated Definition Title/Description
+ URL No string No - The URL Schema
- title No string No - -
5.1.4.1.7.1.1.1. Property URL

Title: The URL Schema
Type string
Required Yes
5.1.4.1.7.1.1.2. Property title
Type string
Required No
5.1.4.1.8. Property item 7
Type object
Required No
Additional properties Any type allowed
5.1.4.1.8.1. If (type = "condition")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/condition The condition Schema
5.1.4.1.8.1.1. Property param

Title: The condition Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/condition
Property Pattern Type Deprecated Definition Title/Description
+ expression No string No - The expression Schema
- onSuccess No array No Same as onSuccess The actionResult Schema
- onFailure No array No Same as onError The actionResult Schema
5.1.4.1.8.1.1.1. Property expression

Title: The expression Schema
Type string
Required Yes
5.1.4.1.8.1.1.2. Property onSuccess

Title: The actionResult Schema
Type array
Required No
Same definition as onSuccess
5.1.4.1.8.1.1.3. Property onFailure

Title: The actionResult Schema
Type array
Required No
Same definition as onError
5.1.4.1.9. Property item 8
Type object
Required No
Additional properties Any type allowed
5.1.4.1.9.1. If (type = "dialog-show")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/ModelDialog The ModelDialog Schema
5.1.4.1.9.1.1. Property param

Title: The ModelDialog Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/ModelDialog
Property Pattern Type Deprecated Definition Title/Description
+ type No enum (of string) No - The expression Schema
- message No string No - The message Schema
- onYes No array No Same as onSuccess The actionResult Schema
- onNo No array No Same as onSuccess The actionResult Schema
- onOk No array No Same as onSuccess The actionResult Schema
- onCancel No array No Same as onSuccess The actionResult Schema
- view No string No - The view Schema
- childView No string No - The childView Schema
- placeholderValues No array of string No - The placeholderValues Schema
5.1.4.1.9.1.1.1. Property type

Title: The expression Schema
Type enum (of string)
Required Yes

Must be one of:

  • "yesNo"
  • "yesNoCancel"
  • "okCancel"
  • "alert"
  • "childDialog"
5.1.4.1.9.1.1.2. Property message

Title: The message Schema
Type string
Required No
5.1.4.1.9.1.1.3. Property onYes

Title: The actionResult Schema
Type array
Required No
Same definition as onSuccess
5.1.4.1.9.1.1.4. Property onNo

Title: The actionResult Schema
Type array
Required No
Same definition as onSuccess
5.1.4.1.9.1.1.5. Property onOk

Title: The actionResult Schema
Type array
Required No
Same definition as onSuccess
5.1.4.1.9.1.1.6. Property onCancel

Title: The actionResult Schema
Type array
Required No
Same definition as onSuccess
5.1.4.1.9.1.1.7. Property view

Title: The view Schema
Type string
Required No
5.1.4.1.9.1.1.8. Property childView

Title: The childView Schema
Type string
Required No
5.1.4.1.9.1.1.9. Property placeholderValues

Title: The placeholderValues Schema
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
placeholderValues items -
5.1.4.1.9.1.1.9.1. placeholderValues items
Type string
Required No
5.1.4.1.10. Property item 9
Type object
Required No
Additional properties Any type allowed
5.1.4.1.10.1. If (type = "dialog-show-system")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/SystemDialog -
5.1.4.1.10.1.1. Property param
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/SystemDialog
Property Pattern Type Deprecated Definition Title/Description
- objectKind No enum (of integer) No - -
- objectId No string No - -
- objectName No string No - -
- objectCreationDate No object No - -
- configKey No string No - -
- uiFormFullName No string No - -
+ uiFormEventType No enum (of string) No - -
- forceConfirm No boolean No - -
- dialogTitle No string No - -
- dialogMessage No string No - -
- dialogButtons No enum (of integer) No - -
- dialogStatus No enum (of string) No - -
- onSuccess No array No Same as onSuccess The actionResult Schema
- onFailure No array No Same as onError The actionResult Schema
5.1.4.1.10.1.1.1. Property objectKind
Type enum (of integer)
Required No

Must be one of:

  • 0
  • 1
  • 2
5.1.4.1.10.1.1.2. Property objectId
Type string
Required No
5.1.4.1.10.1.1.3. Property objectName
Type string
Required No
5.1.4.1.10.1.1.4. Property objectCreationDate
Type object
Required No
Additional properties Any type allowed
5.1.4.1.10.1.1.5. Property configKey
Type string
Required No
5.1.4.1.10.1.1.6. Property uiFormFullName
Type string
Required No
5.1.4.1.10.1.1.7. Property uiFormEventType
Type enum (of string)
Required Yes

Must be one of:

  • "UpdateOnRowChange"
  • "UpdateOnSaveButton"
  • "UpdateOnPrimaryKey"
  • "UpdateOnFormClose"
  • "UpdateOnNewButton"
  • "UpdateOnSaveAndNew"
  • "UpdateOnInvokeSearch"
  • "AddNewOnNewButton"
  • "AddNewOnNewFromGrid"
  • "AddNewOnPrimaryKey"
  • "DeleteOnDeleteButton"
  • "DeleteOnDeleteAddNew"
  • "DeleteAttachment"
  • "UndoOnUndoButton"
  • "UndoOnUndoAddNew"
  • "UndoOnClearButton"
  • "UndoOnClearDataChangeButton"
  • "UndoOnRefreshButton"
  • "UndoOnRefreshDataChangeButton"
  • "PrintDialog"
  • "None"
5.1.4.1.10.1.1.8. Property forceConfirm
Type boolean
Required No
5.1.4.1.10.1.1.9. Property dialogTitle
Type string
Required No
5.1.4.1.10.1.1.10. Property dialogMessage
Type string
Required No
5.1.4.1.10.1.1.11. Property dialogButtons
Type enum (of integer)
Required No

Must be one of:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
5.1.4.1.10.1.1.12. Property dialogStatus
Type enum (of string)
Required No

Must be one of:

  • "none"
  • "info"
  • "warning"
  • "error"
5.1.4.1.10.1.1.13. Property onSuccess

Title: The actionResult Schema
Type array
Required No
Same definition as onSuccess
5.1.4.1.10.1.1.14. Property onFailure

Title: The actionResult Schema
Type array
Required No
Same definition as onError
5.1.4.1.11. Property item 10
Type object
Required No
Additional properties Any type allowed
5.1.4.1.11.1. If (type = "search-show")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/search-show The search-show Schema
5.1.4.1.11.1.1. Property param

Title: The search-show Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/search-show
Property Pattern Type Deprecated Definition Title/Description
- searchOptions No object No In #/definitions/searchOptions The searchOptions Schema
5.1.4.1.11.1.1.1. Property searchOptions

Title: The searchOptions Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/searchOptions
Property Pattern Type Deprecated Definition Title/Description
- owner No string No - The owner Schema
- selectMode No enum (of string) No - The selectMode Schema
+ like No string No - The like Schema
- searchForm No string No - The searchForm Schema
- preLoadSearchFilter No Combination No - The preLoadSearchFilter Schema
- validation No object No - validation
- sortByColumn No string No - The sortByColumn Schema
- disableColumns No array of string No - The disableColumns Schema
- pageSize No number No - The pageSize Schema
- CustomArgs No array No - Custom Arguments
- AlternateSearchMethod No string No - override svcPath property
- subPanelResponse No array No - The subPanelResponse Schema
- valueIn No array No - -
- useGetRows No boolean No - Invoke getRows instead of GetList
- overrides No array No - The getRow params Schema
- returnMultipleTables No boolean No - Return Multiple Tables
- launchSearchType No string No - Default Search Type
- launchSearchName No string No - Search Name
5.1.4.1.11.1.1.1.1. Property owner

Title: The owner Schema
Type string
Required No
5.1.4.1.11.1.1.1.2. Property selectMode

Title: The selectMode Schema
Type enum (of string)
Required No

Must be one of:

  • "MultiSelect"
  • "SingleSelect"
5.1.4.1.11.1.1.1.3. Property like

Title: The like Schema
Type string
Required Yes
5.1.4.1.11.1.1.1.4. Property searchForm

Title: The searchForm Schema
Type string
Required No
5.1.4.1.11.1.1.1.5. Property preLoadSearchFilter

Title: The preLoadSearchFilter Schema
Type combining
Required No
One of(Option)
item 0
item 1
5.1.4.1.11.1.1.1.5.1. Property item 0
Type string
Required No
5.1.4.1.11.1.1.1.5.2. Property item 1
Type array of object
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The Events Items Schema -
5.1.4.1.11.1.1.1.5.2.1. The Events Items Schema

Title: The Events Items Schema
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- whereClauseTable No string No - The whereClauseTable Schema
- whereClause No string No - The whereClause Schema
5.1.4.1.11.1.1.1.5.2.1.1. Property whereClauseTable

Title: The whereClauseTable Schema
Type string
Required No
5.1.4.1.11.1.1.1.5.2.1.2. Property whereClause

Title: The whereClause Schema
Type string
Required No
5.1.4.1.11.1.1.1.6. Property validation

Title: validation
Type object
Required No
Additional properties Any type allowed
5.1.4.1.11.1.1.1.7. Property sortByColumn

Title: The sortByColumn Schema
Type string
Required No
5.1.4.1.11.1.1.1.8. Property disableColumns

Title: The disableColumns Schema
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
disableColumns items -
5.1.4.1.11.1.1.1.8.1. disableColumns items
Type string
Required No
5.1.4.1.11.1.1.1.9. Property pageSize

Title: The pageSize Schema
Type number
Required No
5.1.4.1.11.1.1.1.10. Property CustomArgs

Title: Custom Arguments
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The CustomArgType Schema -
5.1.4.1.11.1.1.1.10.1. The CustomArgType Schema

Title: The CustomArgType Schema
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/CustomArgType
Property Pattern Type Deprecated Definition Title/Description
+ field No string No - The field Schema
+ value No number, string, boolean or null No - The value Schema
5.1.4.1.11.1.1.1.10.1.1. Property field

Title: The field Schema
Type string
Required Yes
5.1.4.1.11.1.1.1.10.1.2. Property value

Title: The value Schema
Type number, string, boolean or null
Required Yes
5.1.4.1.11.1.1.1.11. Property AlternateSearchMethod

Title: override svcPath property
Type string
Required No
5.1.4.1.11.1.1.1.12. Property subPanelResponse

Title: The subPanelResponse Schema
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The SubPanelResponse Schema -
5.1.4.1.11.1.1.1.12.1. The SubPanelResponse Schema

Title: The SubPanelResponse Schema
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/SubPanelResponse
Property Pattern Type Deprecated Definition Title/Description
+ epBinding No string No - The epBinding Schema
+ column No string No - The column Schema
5.1.4.1.11.1.1.1.12.1.1. Property epBinding

Title: The epBinding Schema
Type string
Required Yes
5.1.4.1.11.1.1.1.12.1.2. Property column

Title: The column Schema
Type string
Required Yes
5.1.4.1.11.1.1.1.13. Property valueIn
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
searchValueIn -
5.1.4.1.11.1.1.1.13.1. searchValueIn
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/searchValueIn
Property Pattern Type Deprecated Definition Title/Description
+ id No string No - -
+ value No string No - -
5.1.4.1.11.1.1.1.13.1.1. Property id
Type string
Required Yes
5.1.4.1.11.1.1.1.13.1.2. Property value
Type string
Required Yes
5.1.4.1.11.1.1.1.14. Property useGetRows

Title: Invoke getRows instead of GetList
Type boolean
Required No
5.1.4.1.11.1.1.1.15. Property overrides

Title: The getRow params Schema
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The overrides Schema -
5.1.4.1.11.1.1.1.15.1. The overrides Schema

Title: The overrides Schema
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/overrides
Property Pattern Type Deprecated Definition Title/Description
+ type No string No - The field Schema
+ name No string No - The name Schema
+ value No string No - The value Schema
5.1.4.1.11.1.1.1.15.1.1. Property type

Title: The field Schema
Type string
Required Yes
5.1.4.1.11.1.1.1.15.1.2. Property name

Title: The name Schema
Type string
Required Yes
5.1.4.1.11.1.1.1.15.1.3. Property value

Title: The value Schema
Type string
Required Yes
5.1.4.1.11.1.1.1.16. Property returnMultipleTables

Title: Return Multiple Tables
Type boolean
Required No
5.1.4.1.11.1.1.1.17. Property launchSearchType

Title: Default Search Type
Type string
Required No
5.1.4.1.11.1.1.1.18. Property launchSearchName

Title: Search Name
Type string
Required No
5.1.4.1.12. Property item 11
Type object
Required No
Additional properties Any type allowed
5.1.4.1.12.1. If (type = "data-commit")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/data-commit The data-commit Schema
5.1.4.1.12.1.1. Property param

Title: The data-commit Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/data-commit
Property Pattern Type Deprecated Definition Title/Description
- dataview No string No - -
5.1.4.1.12.1.1.1. Property dataview
Type string
Required No
5.1.4.1.13. Property item 12
Type object
Required No
Additional properties Any type allowed
5.1.4.1.13.1. If (type = "data-clear")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/data-clear The clear-data Schema
5.1.4.1.13.1.1. Property param

Title: The clear-data Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/data-clear
Property Pattern Type Deprecated Definition Title/Description
- type No enum (of string) No - -
- value No string No - -
5.1.4.1.13.1.1.1. Property type
Type enum (of string)
Required No

Must be one of:

  • "dataview"
  • "table"
  • "dataset"
5.1.4.1.13.1.1.2. Property value
Type string
Required No
5.1.4.1.14. Property item 13
Type object
Required No
Additional properties Any type allowed
5.1.4.1.14.1. If (type = "console-write")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/console-write The console-write Schema
5.1.4.1.14.1.1. Property param

Title: The console-write Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/console-write
Property Pattern Type Deprecated Definition Title/Description
- value No string No - -
5.1.4.1.14.1.1.1. Property value
Type string
Required No
5.1.4.1.15. Property item 14
Type object
Required No
Additional properties Any type allowed
5.1.4.1.15.1. If (type = "calculation")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/calculation The Calculation Schema
5.1.4.1.15.1.1. Property param

Title: The Calculation Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/calculation
Property Pattern Type Deprecated Definition Title/Description
- epBinding No string No - -
- initialValue No string No - -
- operations No array No - Custom Arguments
5.1.4.1.15.1.1.1. Property epBinding
Type string
Required No
5.1.4.1.15.1.1.2. Property initialValue
Type string
Required No
5.1.4.1.15.1.1.3. Property operations

Title: Custom Arguments
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The Operations Schema -
5.1.4.1.15.1.1.3.1. The Operations Schema

Title: The Operations Schema
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/Operations
Property Pattern Type Deprecated Definition Title/Description
+ operator No string No - The operator Schema
+ operand No string No - The operand Schema
5.1.4.1.15.1.1.3.1.1. Property operator

Title: The operator Schema
Type string
Required Yes
5.1.4.1.15.1.1.3.1.2. Property operand

Title: The operand Schema
Type string
Required Yes
5.1.4.1.16. Property item 15
Type object
Required No
Additional properties Any type allowed
5.1.4.1.16.1. If (type = "rest")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/rest The rest Schema
5.1.4.1.16.1.1. Property param

Title: The rest Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/rest
Property Pattern Type Deprecated Definition Title/Description
- request No object No In #/definitions/request The request Schema
- response No object No In #/definitions/response The response Schema
5.1.4.1.16.1.1.1. Property request

Title: The request Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/request
Property Pattern Type Deprecated Definition Title/Description
+ svc No string No - The request Schema
+ svcPath No string No - The response Schema
- method No string No - The response Schema
- model No string No - The model Schema
- successOnlyIfConditionsAreMet No boolean No - The successOnlyIfConditionsAreMet Schema
- addFullModelToRequest No boolean No - The addFullModelToRequest Schema
- ignoreIfEmptyDataSet No boolean No - The ignoreIfEmptyDataSet Schema
- params No array No - The params Schema
5.1.4.1.16.1.1.1.1. Property svc

Title: The request Schema
Type string
Required Yes
5.1.4.1.16.1.1.1.2. Property svcPath

Title: The response Schema
Type string
Required Yes
5.1.4.1.16.1.1.1.3. Property method

Title: The response Schema
Type string
Required No
5.1.4.1.16.1.1.1.4. Property model

Title: The model Schema
Type string
Required No
5.1.4.1.16.1.1.1.5. Property successOnlyIfConditionsAreMet

Title: The successOnlyIfConditionsAreMet Schema
Type boolean
Required No
5.1.4.1.16.1.1.1.6. Property addFullModelToRequest

Title: The addFullModelToRequest Schema
Type boolean
Required No
5.1.4.1.16.1.1.1.7. Property ignoreIfEmptyDataSet

Title: The ignoreIfEmptyDataSet Schema
Type boolean
Required No
5.1.4.1.16.1.1.1.8. Property params

Title: The params Schema
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The params Schema -
5.1.4.1.16.1.1.1.8.1. The params Schema

Title: The params Schema
Type object
Required No
Additional properties Not allowed
Same definition as The params Schema
5.1.4.1.16.1.1.2. Property response

Title: The response Schema
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/response
Property Pattern Type Deprecated Definition Title/Description
- model No string No - The model Schema
- hasMultipleModel No boolean No - The hasMultipleModel Schema
- preserveOldData No boolean No - The preserveOldData Schema
- returnObject No string No - The returnObject Schema
- fileType No string No - The fileType Schema
- mergeRow No boolean No - The mergeRow Schema
- replace No array of string No - The replace Schema
5.1.4.1.16.1.1.2.1. Property model

Title: The model Schema
Type string
Required No
5.1.4.1.16.1.1.2.2. Property hasMultipleModel

Title: The hasMultipleModel Schema
Type boolean
Required No
5.1.4.1.16.1.1.2.3. Property preserveOldData

Title: The preserveOldData Schema
Type boolean
Required No
5.1.4.1.16.1.1.2.4. Property returnObject

Title: The returnObject Schema
Type string
Required No
5.1.4.1.16.1.1.2.5. Property fileType

Title: The fileType Schema
Type string
Required No
5.1.4.1.16.1.1.2.6. Property mergeRow

Title: The mergeRow Schema
Type boolean
Required No
5.1.4.1.16.1.1.2.7. Property replace

Title: The replace Schema
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
replace items -
5.1.4.1.16.1.1.2.7.1. replace items
Type string
Required No
5.1.4.1.17. Property item 16
Type object
Required No
Additional properties Any type allowed
5.1.4.1.17.1. If (type = "property-set")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/property-set The property-set Schema
5.1.4.1.17.1.1. Property param

Title: The property-set Schema
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/property-set
Property Pattern Type Deprecated Definition Title/Description
+ component No string No - The component Schema
- guid No string No - -
+ props No array No - The props Schema
5.1.4.1.17.1.1.1. Property component

Title: The component Schema
Type string
Required Yes
5.1.4.1.17.1.1.2. Property guid
Type string
Required No
5.1.4.1.17.1.1.3. Property props

Title: The props Schema
Type array
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The props Schema -
5.1.4.1.17.1.1.3.1. The props Schema

Title: The props Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/props
Property Pattern Type Deprecated Definition Title/Description
+ prop No string No - -
+ value No Combination No - -
5.1.4.1.17.1.1.3.1.1. Property prop
Type string
Required Yes
5.1.4.1.17.1.1.3.1.2. Property value
Type combining
Required Yes
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
5.1.4.1.17.1.1.3.1.2.1. Property item 0
Type boolean
Required No
5.1.4.1.17.1.1.3.1.2.2. Property item 1
Type number
Required No
5.1.4.1.17.1.1.3.1.2.3. Property item 2
Type string
Required No
5.1.4.1.18. Property item 17
Type object
Required No
Additional properties Any type allowed
5.1.4.1.18.1. If (type = "dataview-filter-set")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/dataview-filter-set The dataview-filter-set Schema
5.1.4.1.18.1.1. Property param

Title: The dataview-filter-set Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/dataview-filter-set
Property Pattern Type Deprecated Definition Title/Description
+ dataview No string No - The dataview Schema
+ filter No string No - The filter Schema
5.1.4.1.18.1.1.1. Property dataview

Title: The dataview Schema
Type string
Required Yes
5.1.4.1.18.1.1.2. Property filter

Title: The filter Schema
Type string
Required Yes
5.1.4.1.19. Property item 18
Type object
Required No
Additional properties Any type allowed
5.1.4.1.19.1. If (type = "image-set")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/image-set The dataview-filter-set Schema
5.1.4.1.19.1.1. Property param

Title: The dataview-filter-set Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/image-set
Property Pattern Type Deprecated Definition Title/Description
+ imageContent No string No - The imageContent Schema
+ epBinding No string No - The epBinding Schema
+ width No integer No - The width
+ height No integer No - The height Schema
5.1.4.1.19.1.1.1. Property imageContent

Title: The imageContent Schema
Type string
Required Yes
5.1.4.1.19.1.1.2. Property epBinding

Title: The epBinding Schema
Type string
Required Yes
5.1.4.1.19.1.1.3. Property width

Title: The width
Type integer
Required Yes
5.1.4.1.19.1.1.4. Property height

Title: The height Schema
Type integer
Required Yes
5.1.4.1.20. Property item 19
Type object
Required No
Additional properties Any type allowed
5.1.4.1.20.1. If (type = "row-current-set")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/row-current-set The row-current-set Schema
5.1.4.1.20.1.1. Property param

Title: The row-current-set Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/row-current-set
Property Pattern Type Deprecated Definition Title/Description
+ dataview No string No - The dataview name
- row No integer No - row index
- position No enum (of string) No - -
5.1.4.1.20.1.1.1. Property dataview

Title: The dataview name
Type string
Required Yes
5.1.4.1.20.1.1.2. Property row

Title: row index
Type integer
Required No
5.1.4.1.20.1.1.3. Property position
Type enum (of string)
Required No

Must be one of:

  • "last"
  • "first"
5.1.4.1.21. Property item 20
Type object
Required No
Additional properties Any type allowed
5.1.4.1.21.1. If (type = "dataview-condition")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/dataview-condition The dataview-condition Schema
5.1.4.1.21.1.1. Property param

Title: The dataview-condition Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/dataview-condition
Property Pattern Type Deprecated Definition Title/Description
+ dataview No string No - dataview
+ result No string No - dataview to use to store match result
+ expression No string No - condition expression
- onNoMatch No array No Same as onSuccess The actionResult Schema
- onSingleMatch No array No Same as onSuccess The actionResult Schema
- onMultipleMatch No array No Same as onSuccess The actionResult Schema
- iterativeEvent No string No - perform some action for each matching row in the view.
5.1.4.1.21.1.1.1. Property dataview

Title: dataview
Type string
Required Yes
5.1.4.1.21.1.1.2. Property result

Title: dataview to use to store match result
Type string
Required Yes
5.1.4.1.21.1.1.3. Property expression

Title: condition expression
Type string
Required Yes
5.1.4.1.21.1.1.4. Property onNoMatch

Title: The actionResult Schema
Type array
Required No
Same definition as onSuccess
5.1.4.1.21.1.1.5. Property onSingleMatch

Title: The actionResult Schema
Type array
Required No
Same definition as onSuccess
5.1.4.1.21.1.1.6. Property onMultipleMatch

Title: The actionResult Schema
Type array
Required No
Same definition as onSuccess
5.1.4.1.21.1.1.7. Property iterativeEvent

Title: perform some action for each matching row in the view.
Type string
Required No
5.1.4.1.22. Property item 21
Type object
Required No
Additional properties Any type allowed
5.1.4.1.22.1. If (type = "dashboard-timer-set")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/dashboard-timer-set The setTimer Schema
5.1.4.1.22.1.1. Property param

Title: The setTimer Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/dashboard-timer-set
Property Pattern Type Deprecated Definition Title/Description
+ interval No integer No - interval
+ event No string No - event to execute on timer interval
5.1.4.1.22.1.1.1. Property interval

Title: interval
Type integer
Required Yes
5.1.4.1.22.1.1.2. Property event

Title: event to execute on timer interval
Type string
Required Yes
5.1.4.1.23. Property item 22
Type object
Required No
Additional properties Any type allowed
5.1.4.1.23.1. If (type = "event-complete")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/event-complete The complete event Schema
5.1.4.1.23.1.1. Property param

Title: The complete event Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/event-complete
Property Pattern Type Deprecated Definition Title/Description
+ event-next No string No - next event to trigger
5.1.4.1.23.1.1.1. Property event-next

Title: next event to trigger
Type string
Required Yes
5.1.4.1.24. Property item 23
Type object
Required No
Additional properties Any type allowed
5.1.4.1.24.1. If (type = "switch")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/switch The switch event Schema
5.1.4.1.24.1.1. Property param

Title: The switch event Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/switch
Property Pattern Type Deprecated Definition Title/Description
+ cases No array No - next event to trigger
5.1.4.1.24.1.1.1. Property cases

Title: next event to trigger
Type array
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The case Schema -
5.1.4.1.24.1.1.1.1. The case Schema

Title: The case Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/cases
Property Pattern Type Deprecated Definition Title/Description
- value No string or number No - -
- default No boolean No - -
+ actions No array No - -
5.1.4.1.24.1.1.1.1.1. Property value
Type string or number
Required No
5.1.4.1.24.1.1.1.1.2. Property default
Type boolean
Required No
5.1.4.1.24.1.1.1.1.3. Property actions
Type array
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The action Schema -
5.1.4.1.24.1.1.1.1.3.1. The action Schema

Title: The action Schema
Type combining
Required No
Additional properties Not allowed
Same definition as The action Schema
5.1.4.1.25. Property item 24
Type object
Required No
Additional properties Any type allowed
5.1.4.1.25.1. If (type = "erp-message-handler")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/erp-message-handler The erp-message-handler Schema
- onOk No array No Same as onSuccess The actionResult Schema
- onCancel No array No Same as onSuccess The actionResult Schema
- onYes No array No Same as onSuccess The actionResult Schema
- onNo No array No Same as onSuccess The actionResult Schema
5.1.4.1.25.1.1. Property param

Title: The erp-message-handler Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/erp-message-handler
Property Pattern Type Deprecated Definition Title/Description
+ message No string No - message
+ level No string No - level
+ type No enum (of string) No - type
- buttons No string No - buttons
- title No string No - title
- placeholderValues No array of string No - The placeholderValues Schema
5.1.4.1.25.1.1.1. Property message

Title: message
Type string
Required Yes
5.1.4.1.25.1.1.2. Property level

Title: level
Type string
Required Yes
5.1.4.1.25.1.1.3. Property type

Title: type
Type enum (of string)
Required Yes

Must be one of:

  • "Log"
  • "Toast"
  • "Alert"
  • "Dialog"
  • "Slideout"
5.1.4.1.25.1.1.4. Property buttons

Title: buttons
Type string
Required No
5.1.4.1.25.1.1.5. Property title

Title: title
Type string
Required No
5.1.4.1.25.1.1.6. Property placeholderValues

Title: The placeholderValues Schema
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
placeholderValues items -
5.1.4.1.25.1.1.6.1. placeholderValues items
Type string
Required No
5.1.4.1.25.1.2. Property onOk

Title: The actionResult Schema
Type array
Required No
Same definition as onSuccess
5.1.4.1.25.1.3. Property onCancel

Title: The actionResult Schema
Type array
Required No
Same definition as onSuccess
5.1.4.1.25.1.4. Property onYes

Title: The actionResult Schema
Type array
Required No
Same definition as onSuccess
5.1.4.1.25.1.5. Property onNo

Title: The actionResult Schema
Type array
Required No
Same definition as onSuccess
5.1.4.1.26. Property item 25
Type object
Required No
Additional properties Any type allowed
5.1.4.1.26.1. If (type = "apps-communicator-broadcast")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/apps-communicator-broadcast The apps-communicator-broadcast event Schema
5.1.4.1.26.1.1. Property param

Title: The apps-communicator-broadcast event Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/apps-communicator-broadcast
Property Pattern Type Deprecated Definition Title/Description
+ action No string No - app communicator event name
5.1.4.1.26.1.1.1. Property action

Title: app communicator event name
Type string
Required Yes
5.1.4.1.27. Property item 26
Type object
Required No
Additional properties Any type allowed
5.1.4.1.27.1. If (type = "apps-communicator-publish")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/apps-communicator-publish The apps-communicator-publish event Schema
5.1.4.1.27.1.1. Property param

Title: The apps-communicator-publish event Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/apps-communicator-publish
Property Pattern Type Deprecated Definition Title/Description
+ whoPublished No string No - Name of the publisher application
- args No array No - The arguments to be published
5.1.4.1.27.1.1.1. Property whoPublished

Title: Name of the publisher application
Type string
Required Yes
5.1.4.1.27.1.1.2. Property args

Title: The arguments to be published
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The arguments to publish -
5.1.4.1.27.1.1.2.1. The arguments to publish

Title: The arguments to publish
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/args
Property Pattern Type Deprecated Definition Title/Description
- key No string No - The key for the data item
- value No string No - The value for the data item
5.1.4.1.27.1.1.2.1.1. Property key

Title: The key for the data item
Type string
Required No
5.1.4.1.27.1.1.2.1.2. Property value

Title: The value for the data item
Type string
Required No
5.1.4.1.28. Property item 27
Type object
Required No
Additional properties Any type allowed
5.1.4.1.28.1. If (type = "combo-refill")
Type object
Required No
Additional properties Any type allowed
5.1.4.1.29. Property item 28
Type object
Required No
Additional properties Any type allowed
5.1.4.1.29.1. If (type = "app-open")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/app-open The app-open event Schema
5.1.4.1.29.1.1. Property param

Title: The app-open event Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/app-open
Property Pattern Type Deprecated Definition Title/Description
+ view No string No - -
- layer No string No - -
- slideOut No boolean No - -
- page No string No - -
- width No enum (of string) No - -
- customWidth No number No - -
- onOk No array No In #/definitions/dailogResultActions -
- onCancel No array No Same as onOk -
- onNone No array No Same as onOk -
- onAbort No array No Same as onOk -
- onRetry No array No Same as onOk -
- onIgnore No array No Same as onOk -
- onYes No array No Same as onOk -
- onNo No array No Same as onOk -
- whoLaunched No string No - -
- valueIn No object No - -
- valueOut No object No - -
- launchOptions No object No - -
5.1.4.1.29.1.1.1. Property view
Type string
Required Yes
5.1.4.1.29.1.1.2. Property layer
Type string
Required No
5.1.4.1.29.1.1.3. Property slideOut
Type boolean
Required No
5.1.4.1.29.1.1.4. Property page
Type string
Required No
5.1.4.1.29.1.1.5. Property width
Type enum (of string)
Required No

Must be one of:

  • "Tiny"
  • "Small"
  • "Medium"
  • "Large"
  • "Fill"
  • "Custom"
5.1.4.1.29.1.1.6. Property customWidth
Type number
Required No
5.1.4.1.29.1.1.7. Property onOk
Type array
Required No
Defined in #/definitions/dailogResultActions
5.1.4.1.29.1.1.7.1. The following properties are required
  • actions
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The action Schema -
5.1.4.1.29.1.1.7.2. The action Schema

Title: The action Schema
Type combining
Required No
Additional properties Not allowed
Same definition as The action Schema
5.1.4.1.29.1.1.8. Property onCancel
Type array
Required No
Same definition as onOk
5.1.4.1.29.1.1.9. Property onNone
Type array
Required No
Same definition as onOk
5.1.4.1.29.1.1.10. Property onAbort
Type array
Required No
Same definition as onOk
5.1.4.1.29.1.1.11. Property onRetry
Type array
Required No
Same definition as onOk
5.1.4.1.29.1.1.12. Property onIgnore
Type array
Required No
Same definition as onOk
5.1.4.1.29.1.1.13. Property onYes
Type array
Required No
Same definition as onOk
5.1.4.1.29.1.1.14. Property onNo
Type array
Required No
Same definition as onOk
5.1.4.1.29.1.1.15. Property whoLaunched
Type string
Required No
5.1.4.1.29.1.1.16. Property valueIn
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- dataviews No array No - -
- No object No - -
5.1.4.1.29.1.1.16.1. Property dataviews
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The process-import-service event Schema -
5.1.4.1.29.1.1.16.1.1. The process-import-service event Schema

Title: The process-import-service event Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/dataviews
Property Pattern Type Deprecated Definition Title/Description
+ source No string No - -
- destination No string No - -
5.1.4.1.29.1.1.16.1.1.1. Property source
Type string
Required Yes
5.1.4.1.29.1.1.16.1.1.2. Property destination
Type string
Required No
5.1.4.1.29.1.1.17. Property valueOut
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- dataviews No array No - -
- No object No - -
5.1.4.1.29.1.1.17.1. Property dataviews
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The process-import-service event Schema -
5.1.4.1.29.1.1.17.1.1. The process-import-service event Schema

Title: The process-import-service event Schema
Type object
Required No
Additional properties Not allowed
Same definition as The process-import-service event Schema
5.1.4.1.29.1.1.18. Property launchOptions
Type object
Required No
Additional properties Any type allowed
5.1.4.1.30. Property item 29
Type object
Required No
Additional properties Any type allowed
5.1.4.1.30.1. If (type = "app-close")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/closeView The close-view event Schema
5.1.4.1.30.1.1. Property param

Title: The close-view event Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/closeView
Property Pattern Type Deprecated Definition Title/Description
+ result No enum (of string) No - -
- dataviews No array No - -
- valueOut No object No - -
5.1.4.1.30.1.1.1. Property result
Type enum (of string)
Required Yes

Must be one of:

  • "None"
  • "OK"
  • "Cancel"
  • "Abort"
  • "Retry"
  • "Ignore"
  • "Yes"
  • "No"
5.1.4.1.30.1.1.2. Property dataviews
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The process-import-service event Schema -
5.1.4.1.30.1.1.2.1. The process-import-service event Schema

Title: The process-import-service event Schema
Type object
Required No
Additional properties Not allowed
Same definition as The process-import-service event Schema
5.1.4.1.30.1.1.3. Property valueOut
Type object
Required No
Additional properties Any type allowed
5.1.4.1.31. Property item 30
Type object
Required No
Additional properties Any type allowed
5.1.4.1.31.1. If (type = "process-import-service")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/process-import-service The process-import-service event Schema
5.1.4.1.31.1.1. Property param

Title: The process-import-service event Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/process-import-service
Property Pattern Type Deprecated Definition Title/Description
+ activityId No string No - -
- bindingCacheKey No string No - -
- filesCacheKey No string No - -
- bindingServerFile No string No - -
- specialFolder No enum (of integer) No In #/definitions/ErpSpecialFolder -
- status No object No In #/definitions/processImportStatus -
5.1.4.1.31.1.1.1. Property activityId
Type string
Required Yes
5.1.4.1.31.1.1.2. Property bindingCacheKey
Type string
Required No
5.1.4.1.31.1.1.3. Property filesCacheKey
Type string
Required No
5.1.4.1.31.1.1.4. Property bindingServerFile
Type string
Required No
5.1.4.1.31.1.1.5. Property specialFolder
Type enum (of integer)
Required No
Defined in #/definitions/ErpSpecialFolder

Must be one of:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
5.1.4.1.31.1.1.6. Property status
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/processImportStatus
Property Pattern Type Deprecated Definition Title/Description
+ success No boolean No - -
+ message No string No - -
+ fileNames No array of string No - -
5.1.4.1.31.1.1.6.1. Property success
Type boolean
Required Yes
5.1.4.1.31.1.1.6.2. Property message
Type string
Required Yes
5.1.4.1.31.1.1.6.3. Property fileNames
Type array of string
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
fileNames items -
5.1.4.1.31.1.1.6.3.1. fileNames items
Type string
Required No
5.1.4.1.32. Property item 31
Type object
Required No
Additional properties Any type allowed
5.1.4.1.32.1. If (type = "search-value-set")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/search-value-set The search-value-set event Schema
5.1.4.1.32.1.1. Property param

Title: The search-value-set event Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/search-value-set
Property Pattern Type Deprecated Definition Title/Description
- display No string No - -
- rowDelimiter No string No - -
- fieldDelimiter No string No - -
- columns No array of string No - -
- multiFieldBindings No array of string No - -
5.1.4.1.32.1.1.1. Property display
Type string
Required No
5.1.4.1.32.1.1.2. Property rowDelimiter
Type string
Required No
5.1.4.1.32.1.1.3. Property fieldDelimiter
Type string
Required No
5.1.4.1.32.1.1.4. Property columns
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
columns items -
5.1.4.1.32.1.1.4.1. columns items
Type string
Required No
5.1.4.1.32.1.1.5. Property multiFieldBindings
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
multiFieldBindings items -
5.1.4.1.32.1.1.5.1. multiFieldBindings items
Type string
Required No
5.1.4.1.33. Property item 32
Type object
Required No
Additional properties Any type allowed
5.1.4.1.33.1. If (type = "file-transfer-erp")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/file-transfer-erp -
5.1.4.1.33.1.1. Property param
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/file-transfer-erp
Property Pattern Type Deprecated Definition Title/Description
+ specialFolder No enum (of integer) No Same as specialFolder -
+ serverPath No string No - -
- clientPath No string No - -
- company No string No - -
- transferType No enum (of string) No - -
- erpFileBoxID No string No - -
5.1.4.1.33.1.1.1. Property specialFolder
Type enum (of integer)
Required Yes
Same definition as specialFolder
5.1.4.1.33.1.1.2. Property serverPath
Type string
Required Yes
5.1.4.1.33.1.1.3. Property clientPath
Type string
Required No
5.1.4.1.33.1.1.4. Property company
Type string
Required No
5.1.4.1.33.1.1.5. Property transferType
Type enum (of string)
Required No

Must be one of:

  • "download"
  • "upload"
5.1.4.1.33.1.1.6. Property erpFileBoxID
Type string
Required No
5.1.4.1.34. Property item 33
Type object
Required No
Additional properties Any type allowed
5.1.4.1.34.1. If (type = "event-column-disable")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/columnChangeParam -
5.1.4.1.34.1.1. Property param
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/columnChangeParam
Property Pattern Type Deprecated Definition Title/Description
+ columns No array of string No - -
5.1.4.1.34.1.1.1. Property columns
Type array of string
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
columns items -
5.1.4.1.34.1.1.1.1. columns items
Type string
Required No
5.1.4.1.35. Property item 34
Type object
Required No
Additional properties Any type allowed
5.1.4.1.35.1. If (type = "event-column-enable")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No Same as param -
5.1.4.1.35.1.1. Property param
Type object
Required No
Additional properties Not allowed
Same definition as param
5.1.4.1.36. Property item 35
Type object
Required No
Additional properties Any type allowed
5.1.4.1.36.1. If (type = "page-navigate-to")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/page-navigate-to The page-navigate-to event Schema
5.1.4.1.36.1.1. Property param

Title: The page-navigate-to event Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/page-navigate-to
Property Pattern Type Deprecated Definition Title/Description
+ page No string No - -
5.1.4.1.36.1.1.1. Property page
Type string
Required Yes
5.1.4.1.37. Property item 36
Type object
Required No
Additional properties Any type allowed
5.1.4.1.37.1. If (type = "row-copy")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/row-copy The page-navigate-to event Schema
5.1.4.1.37.1.1. Property param

Title: The page-navigate-to event Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/row-copy
Property Pattern Type Deprecated Definition Title/Description
+ fromDataView No string No - -
+ toDataView No string No - -
- row-current-set No boolean No - -
5.1.4.1.37.1.1.1. Property fromDataView
Type string
Required Yes
5.1.4.1.37.1.1.2. Property toDataView
Type string
Required Yes
5.1.4.1.37.1.1.3. Property row-current-set
Type boolean
Required No
5.1.4.1.38. Property item 37
Type object
Required No
Additional properties Any type allowed
5.1.4.1.38.1. If (type = "slider-open")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/slider-open The slider-open event Schema
5.1.4.1.38.1.1. Property param

Title: The slider-open event Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/slider-open
Property Pattern Type Deprecated Definition Title/Description
+ page No string No - -
5.1.4.1.38.1.1.1. Property page
Type string
Required Yes
5.1.4.1.39. Property item 38
Type object
Required No
Additional properties Any type allowed
5.1.4.1.39.1. If (type = "dataview-copy")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/dataview-copy The dataview-copy event Schema
5.1.4.1.39.1.1. Property param

Title: The dataview-copy event Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/dataview-copy
Property Pattern Type Deprecated Definition Title/Description
+ fromDataView No string No - -
+ toDataView No string No - -
- setCurrentRow No boolean No - -
- mergeBehavior No string No - -
5.1.4.1.39.1.1.1. Property fromDataView
Type string
Required Yes
5.1.4.1.39.1.1.2. Property toDataView
Type string
Required Yes
5.1.4.1.39.1.1.3. Property setCurrentRow
Type boolean
Required No
5.1.4.1.39.1.1.4. Property mergeBehavior
Type string
Required No
5.1.4.1.40. Property item 39
Type object
Required No
Additional properties Any type allowed
5.1.4.1.40.1. If (type = "data-rollback")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/data-rollback The data-rollback Schema
5.1.4.1.40.1.1. Property param

Title: The data-rollback Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/data-rollback
Property Pattern Type Deprecated Definition Title/Description
- dataview No string No - -
- dataset No string No - -
5.1.4.1.40.1.1.1. Property dataview
Type string
Required No
5.1.4.1.40.1.1.2. Property dataset
Type string
Required No
5.1.4.1.41. Property item 40
Type object
Required No
Additional properties Any type allowed
5.1.4.1.41.1. If (type = "split")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/split The split Schema
5.1.4.1.41.1.1. Property param

Title: The split Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/split
Property Pattern Type Deprecated Definition Title/Description
+ value No string No - The value Schema
- rowDelimiter No string No - The rowDelimiter Schema
- columnDelimiter No string No - The columnDelimiter Schema
+ dataView No string No - The dataView Schema
- columnPrefix No string No - The columnPrefix Schema
- dataTypes No array No - The dataTypes Schema
5.1.4.1.41.1.1.1. Property value

Title: The value Schema
Type string
Required Yes
5.1.4.1.41.1.1.2. Property rowDelimiter

Title: The rowDelimiter Schema
Type string
Required No
5.1.4.1.41.1.1.3. Property columnDelimiter

Title: The columnDelimiter Schema
Type string
Required No
5.1.4.1.41.1.1.4. Property dataView

Title: The dataView Schema
Type string
Required Yes
5.1.4.1.41.1.1.5. Property columnPrefix

Title: The columnPrefix Schema
Type string
Required No
5.1.4.1.41.1.1.6. Property dataTypes

Title: The dataTypes Schema
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The dataTypes Schema -
5.1.4.1.41.1.1.6.1. The dataTypes Schema

Title: The dataTypes Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/dataTypes
Property Pattern Type Deprecated Definition Title/Description
- index No number No - The index Schema
- column No string No - The column Schema
- type No string No - The type Schema
5.1.4.1.41.1.1.6.1.1. Property index

Title: The index Schema
Type number
Required No
5.1.4.1.41.1.1.6.1.2. Property column

Title: The column Schema
Type string
Required No
5.1.4.1.41.1.1.6.1.3. Property type

Title: The type Schema
Type string
Required No
5.1.4.1.42. Property item 41
Type object
Required No
Additional properties Any type allowed
5.1.4.1.42.1. If (type = "select-tree-node")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/select-tree-node The select-tree-node Schema
5.1.4.1.42.1.1. Property param

Title: The select-tree-node Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/select-tree-node
Property Pattern Type Deprecated Definition Title/Description
+ component No string No - The component Schema
+ sysRowID No string No - The sysRowID Schema
5.1.4.1.42.1.1.1. Property component

Title: The component Schema
Type string
Required Yes
5.1.4.1.42.1.1.2. Property sysRowID

Title: The sysRowID Schema
Type string
Required Yes
5.1.4.1.43. Property item 42
Type object
Required No
Additional properties Any type allowed
5.1.4.1.43.1. If (type = "set-tree-node-state")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/set-tree-node-state The set-tree-node-state Schema
5.1.4.1.43.1.1. Property param

Title: The set-tree-node-state Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/set-tree-node-state
Property Pattern Type Deprecated Definition Title/Description
+ component No string No - The component Schema
+ sysRowID No string No - The sysRowID Schema
+ childFolderEntityType No string No - The childFolderEntityType Schema
- isExpanded No boolean No - The isExpanded Schema
5.1.4.1.43.1.1.1. Property component

Title: The component Schema
Type string
Required Yes
5.1.4.1.43.1.1.2. Property sysRowID

Title: The sysRowID Schema
Type string
Required Yes
5.1.4.1.43.1.1.3. Property childFolderEntityType

Title: The childFolderEntityType Schema
Type string
Required Yes
5.1.4.1.43.1.1.4. Property isExpanded

Title: The isExpanded Schema
Type boolean
Required No
5.1.4.1.44. Property item 43
Type object
Required No
Additional properties Any type allowed
5.1.4.1.44.1. If (type = "credit-card-entry")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/credit-card-entry The credit-card-entry Schema
5.1.4.1.44.1.1. Property param

Title: The credit-card-entry Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/credit-card-entry
Property Pattern Type Deprecated Definition Title/Description
- component No string No - The hostAddress Schema
- sysRowID No string No - The hostNamespace Schema
- childFolderEntityType No string No - The publicKey Schema
5.1.4.1.44.1.1.1. The following properties are required
  • hostAddress
  • hostNamespace
  • publicKey
5.1.4.1.44.1.1.2. Property component

Title: The hostAddress Schema
Type string
Required No
5.1.4.1.44.1.1.3. Property sysRowID

Title: The hostNamespace Schema
Type string
Required No
5.1.4.1.44.1.1.4. Property childFolderEntityType

Title: The publicKey Schema
Type string
Required No
5.1.4.1.45. Property item 44
Type object
Required No
Additional properties Any type allowed
5.1.4.1.45.1. If (type = "refresh-tree")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/refresh-tree The refresh-tree Schema
5.1.4.1.45.1.1. Property param

Title: The refresh-tree Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/refresh-tree
Property Pattern Type Deprecated Definition Title/Description
+ component No string No - The component Schema
- preserveState No boolean No - The preserveState Schema
5.1.4.1.45.1.1.1. Property component

Title: The component Schema
Type string
Required Yes
5.1.4.1.45.1.1.2. Property preserveState

Title: The preserveState Schema
Type boolean
Required No
5.1.4.1.46. Property item 45
Type object
Required No
Additional properties Any type allowed
5.1.4.1.46.1. If (type = "grid-schema-invalidate")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/grid-schema-invalidate The dataview-set-current Schema
5.1.4.1.46.1.1. Property param

Title: The dataview-set-current Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/grid-schema-invalidate
Property Pattern Type Deprecated Definition Title/Description
- type No string No - The type Schema
- target No string No - The target Schema
5.1.4.1.46.1.1.1. The following properties are required
  • type, target
5.1.4.1.46.1.1.2. Property type

Title: The type Schema
Type string
Required No
5.1.4.1.46.1.1.3. Property target

Title: The target Schema
Type string
Required No
5.1.4.1.47. Property item 46
Type object
Required No
Additional properties Any type allowed
5.1.4.1.47.1. If (type = "session-set")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/session-set The session-set Schema
5.1.4.1.47.1.1. Property param

Title: The session-set Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/session-set
Property Pattern Type Deprecated Definition Title/Description
+ variable No enum (of string) No - The variable Schema
+ value No string No - The value Schema
5.1.4.1.47.1.1.1. Property variable

Title: The variable Schema
Type enum (of string)
Required Yes

Must be one of:

  • "employeeID"
5.1.4.1.47.1.1.2. Property value

Title: The value Schema
Type string
Required Yes
5.1.4.1.48. Property item 47
Type object
Required No
Additional properties Any type allowed
5.1.4.1.48.1. If (type = "download-attachment-erp")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/download-attachment-erp The download-attachment-erp Schema
5.1.4.1.48.1.1. Property param

Title: The download-attachment-erp Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/download-attachment-erp
Property Pattern Type Deprecated Definition Title/Description
+ docTypeID No string No - Document Type ID, blank defaults to file transfer
+ xFileRefNum No number No - Attachment reference number to download from ERP
+ fileName No string No - Client file name to save as
+ relatedToSchemaName No string No - Schema the attachment relates to
+ relatedToFile No string No - Table the attachment relates to
5.1.4.1.48.1.1.1. Property docTypeID

Title: Document Type ID, blank defaults to file transfer
Type string
Required Yes
5.1.4.1.48.1.1.2. Property xFileRefNum

Title: Attachment reference number to download from ERP
Type number
Required Yes
5.1.4.1.48.1.1.3. Property fileName

Title: Client file name to save as
Type string
Required Yes
5.1.4.1.48.1.1.4. Property relatedToSchemaName

Title: Schema the attachment relates to
Type string
Required Yes
5.1.4.1.48.1.1.5. Property relatedToFile

Title: Table the attachment relates to
Type string
Required Yes
5.1.4.1.49. Property item 48
Type object
Required No
Additional properties Any type allowed
5.1.4.1.49.1. If (type = "grid-sort-set")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/grid-sort-set The grid-sort-set Schema
5.1.4.1.49.1.1. Property param

Title: The grid-sort-set Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/grid-sort-set
Property Pattern Type Deprecated Definition Title/Description
- epBinding No string No - The epBinding Schema
- sortColumn No string No - The sortColumnBinding Schema
- sortDirection No string No - The sortColumnBinding Schema
5.1.4.1.49.1.1.1. The following properties are required
  • epBinding, sortColumn, sortDirection
5.1.4.1.49.1.1.2. Property epBinding

Title: The epBinding Schema
Type string
Required No
5.1.4.1.49.1.1.3. Property sortColumn

Title: The sortColumnBinding Schema
Type string
Required No
5.1.4.1.49.1.1.4. Property sortDirection

Title: The sortColumnBinding Schema
Type string
Required No
5.1.4.1.50. Property item 49
Type object
Required No
Additional properties Any type allowed
5.1.4.1.50.1. If (type = "grid-sort-get")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/grid-sort-get The grid-sort-get Schema
5.1.4.1.50.1.1. Property param

Title: The grid-sort-get Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/grid-sort-get
Property Pattern Type Deprecated Definition Title/Description
- epBinding No string No - The epBinding Schema
- sortColumnBinding No string No - The sortColumnBinding Schema
- sortDirectionBinding No string No - The sortDirectionBinding Schema
5.1.4.1.50.1.1.1. The following properties are required
  • epBinding, sortColumnBinding, sortDirectionBinding
5.1.4.1.50.1.1.2. Property epBinding

Title: The epBinding Schema
Type string
Required No
5.1.4.1.50.1.1.3. Property sortColumnBinding

Title: The sortColumnBinding Schema
Type string
Required No
5.1.4.1.50.1.1.4. Property sortDirectionBinding

Title: The sortDirectionBinding Schema
Type string
Required No
5.1.4.1.51. Property item 50
Type object
Required No
Additional properties Any type allowed
5.1.4.1.51.1. If (type = "serial-read")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/serial-read Read data from a device connected to a serial port
5.1.4.1.51.1.1. Property param

Title: Read data from a device connected to a serial port
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/serial-read
Property Pattern Type Deprecated Definition Title/Description
+ subType No string No - Subtype, what instrument are we reading from for example scale
+ port No string No - Device port to read from
+ baudRate No number No - Baud rate to read and write at
- parity No string No - Parity, options are none, odd or even
+ stopBits No number No - Number of data bits in each character
+ timeOut No number No - Maximum time wait for a read in milliseconds
+ dataBits No number No - Number of data bits in each character
+ appendCR No boolean No - Append a carriage return on write
+ inquireMsg No string No - Inquiry message to write to the device
5.1.4.1.51.1.1.1. Property subType

Title: Subtype, what instrument are we reading from for example scale
Type string
Required Yes
5.1.4.1.51.1.1.2. Property port

Title: Device port to read from
Type string
Required Yes
5.1.4.1.51.1.1.3. Property baudRate

Title: Baud rate to read and write at
Type number
Required Yes
5.1.4.1.51.1.1.4. Property parity

Title: Parity, options are none, odd or even
Type string
Required No
5.1.4.1.51.1.1.5. Property stopBits

Title: Number of data bits in each character
Type number
Required Yes
5.1.4.1.51.1.1.6. Property timeOut

Title: Maximum time wait for a read in milliseconds
Type number
Required Yes
5.1.4.1.51.1.1.7. Property dataBits

Title: Number of data bits in each character
Type number
Required Yes
5.1.4.1.51.1.1.8. Property appendCR

Title: Append a carriage return on write
Type boolean
Required Yes
5.1.4.1.51.1.1.9. Property inquireMsg

Title: Inquiry message to write to the device
Type string
Required Yes
5.1.4.1.52. Property item 51
Type object
Required No
Additional properties Any type allowed
5.1.4.1.52.1. If (type = "row-find")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/row-find The row-find Schema
5.1.4.1.52.1.1. Property param

Title: The row-find Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/row-find
Property Pattern Type Deprecated Definition Title/Description
+ dataview No string No - Dataview name
+ expression No string No - The expression
- mode No enum (of string) No - Mode
+ epBinding No string No - The epBinding
5.1.4.1.52.1.1.1. Property dataview

Title: Dataview name
Type string
Required Yes
5.1.4.1.52.1.1.2. Property expression

Title: The expression
Type string
Required Yes
5.1.4.1.52.1.1.3. Property mode

Title: Mode
Type enum (of string)
Required No

Must be one of:

  • "RowIndex"
  • "Exists"
  • "Count"
5.1.4.1.52.1.1.4. Property epBinding

Title: The epBinding
Type string
Required Yes
5.1.4.1.53. Property item 52
Type object
Required No
Additional properties Any type allowed
5.1.4.1.53.1. If (type = "dynamic-panel-open")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/dynamic-panel-open The dynamic-panel-open Schema
5.1.4.1.53.1.1. Property param

Title: The dynamic-panel-open Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/dynamic-panel-open
Property Pattern Type Deprecated Definition Title/Description
- title No string No - Title
- width No number No - The width
+ components No string No - Components
5.1.4.1.53.1.1.1. Property title

Title: Title
Type string
Required No
5.1.4.1.53.1.1.2. Property width

Title: The width
Type number
Required No
5.1.4.1.53.1.1.3. Property components

Title: Components
Type string
Required Yes
5.1.4.1.54. Property item 53
Type object
Required No
Additional properties Any type allowed
5.1.4.1.54.1. If (type = "kbmax-configurator-open")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/kbmax-configurator-open Open KBMax Configurator as a slideout panel
5.1.4.1.54.1.1. Property param

Title: Open KBMax Configurator as a slideout panel
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/kbmax-configurator-open
Property Pattern Type Deprecated Definition Title/Description
+ configuratorId No number No - KBMax Configurator ID
- configuredProduct No number No - KBMax Quote Product ID
- custNum No number No - Customer Number
- custId No string No - Customer ID
- quoteNum No number No - Quote Number
5.1.4.1.54.1.1.1. Property configuratorId

Title: KBMax Configurator ID
Type number
Required Yes
5.1.4.1.54.1.1.2. Property configuredProduct

Title: KBMax Quote Product ID
Type number
Required No
5.1.4.1.54.1.1.3. Property custNum

Title: Customer Number
Type number
Required No
5.1.4.1.54.1.1.4. Property custId

Title: Customer ID
Type string
Required No
5.1.4.1.54.1.1.5. Property quoteNum

Title: Quote Number
Type number
Required No
5.1.4.1.55. Property item 54
Type object
Required No
Additional properties Any type allowed
5.1.4.1.55.1. If (type = "execute-csharp")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/execute-csharp The execute-csharp Schema
5.1.4.1.55.1.1. Property param

Title: The execute-csharp Schema
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/execute-csharp
Property Pattern Type Deprecated Definition Title/Description
+ method No string No - Method
- inputs No array of object No In #/definitions/executeCsharpInputParam The execute-csharp inputs Schema
- outputs No array of object No In #/definitions/executeCsharpOutputParam The execute-csharp outputs Schema
- type No string No - Type
- control No string No - Control
- returnType No string No - ReturnType
5.1.4.1.55.1.1.1. Property method

Title: Method
Type string
Required Yes
5.1.4.1.55.1.1.2. Property inputs

Title: The execute-csharp inputs Schema
Type array of object
Required No
Defined in #/definitions/executeCsharpInputParam
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
inputs items -
5.1.4.1.55.1.1.2.1. inputs items
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- name No string No - Name
- type No enum (of string) No - Type
- value No string, number or boolean No - Value
- columns No array of string No - Columns
5.1.4.1.55.1.1.2.1.1. Property name

Title: Name
Type string
Required No
5.1.4.1.55.1.1.2.1.2. Property type

Title: Type
Type enum (of string)
Required No

Must be one of:

  • "epBinding"
  • "dataview"
  • "number"
  • "string"
  • "boolean"
5.1.4.1.55.1.1.2.1.3. Property value

Title: Value
Type string, number or boolean
Required No
5.1.4.1.55.1.1.2.1.4. Property columns

Title: Columns
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
columns items -
5.1.4.1.55.1.1.2.1.4.1. columns items
Type string
Required No
5.1.4.1.55.1.1.3. Property outputs

Title: The execute-csharp outputs Schema
Type array of object
Required No
Defined in #/definitions/executeCsharpOutputParam
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
outputs items -
5.1.4.1.55.1.1.3.1. outputs items
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- name No string No - Name
- value No string No - Value
5.1.4.1.55.1.1.3.1.1. Property name

Title: Name
Type string
Required No
5.1.4.1.55.1.1.3.1.2. Property value

Title: Value
Type string
Required No
5.1.4.1.55.1.1.4. Property type

Title: Type
Type string
Required No
5.1.4.1.55.1.1.5. Property control

Title: Control
Type string
Required No
5.1.4.1.55.1.1.6. Property returnType

Title: ReturnType
Type string
Required No
5.1.4.1.56. Property item 55
Type object
Required No
Additional properties Any type allowed
5.1.4.1.56.1. If (type = "erp-function")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/erp-function The erp-function outputs Schema
5.1.4.1.56.1.1. Property param

Title: The erp-function outputs Schema
Type object
Required No
Additional properties Any type allowed
Defined in #/definitions/erp-function
5.1.4.1.57. Property item 56
Type object
Required No
Additional properties Any type allowed
5.1.4.1.57.1. If (type = "datatree-bindings-set")
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- param No object No In #/definitions/datatree-bindings-set Dynamically sets erp-data-tree treeBindings
5.1.4.1.57.1.1. Property param

Title: Dynamically sets erp-data-tree treeBindings
Type object
Required No
Additional properties Not allowed
Defined in #/definitions/datatree-bindings-set
Property Pattern Type Deprecated Definition Title/Description
+ epBinding No string No - The view.column that contains the JSON for the new treeBindings node
+ modelId No string No - the Id on the model of the tree on which to replace treeBindings
5.1.4.1.57.1.1.1. Property epBinding

Title: The view.column that contains the JSON for the new treeBindings node
Type string
Required Yes
5.1.4.1.57.1.1.2. Property modelId

Title: the Id on the model of the tree on which to replace treeBindings
Type string
Required Yes
5.1.4.1.58. Property type

Title: The type Schema
Type enum (of string)
Required Yes

Must be one of:

  • "search-show"
  • "rest"
  • "row-update"
  • "addRows"
  • "dialog-show"
  • "url-open"
  • "condition"
  • "event-next"
  • "data-commit"
  • "combo-refill"
  • "dataview-clear"
  • "function"
  • "dataview-replace"
  • "value-set"
  • "setFocus"
  • "app-open"
  • "app-close"
  • "process-import-service"
  • "search-value-set"
  • "property-set"
  • "title-set"
  • "file-transfer-erp"
  • "row-delete"
  • "event-column-disable"
  • "event-column-enable"
  • "event-row-disable"
  • "event-row-enable"
  • "event-view-disable"
  • "event-view-enable"
  • "event-cancel"
  • "page-navigate-to"
  • "dialog-show-system"
  • "row-copy"
  • "image-set"
  • "dataview-filter-set"
  • "row-current-set"
  • "dataview-condition"
  • "dashboard-timer-set"
  • "dashboard-timer-clear"
  • "event-complete"
  • "switch"
  • "data-clear"
  • "rest-erp"
  • "slider-open"
  • "slider-close"
  • "dataview-copy"
  • "erp-message-handler"
  • "apps-communicator-broadcast"
  • "apps-communicator-publish"
  • "return"
  • "data-rollback"
  • "global-variable-set"
  • "return-error"
  • "exit"
  • "split"
  • "select-tree-node"
  • "set-tree-node-state"
  • "refresh-tree"
  • "credit-card-entry"
  • "dataview-set-current"
  • "row-add"
  • "console-write"
  • "dialog-result-set"
  • "grid-schema-invalidate"
  • "session-set"
  • "download-attachment-erp"
  • "calculation"
  • "serial-read"
  • "grid-sort-set"
  • "grid-sort-get"
  • "row-find"
  • "dynamic-panel-open"
  • "kbmax-configurator-open"
  • "execute-csharp"
  • "erp-function"
  • "datatree-bindings-set"
5.1.4.1.59. Property param

Title: The Param Schema
Type object or array of object
Required No
5.1.4.1.60. Property value

Title: The Value Schema
Type string, boolean, number or null
Required No
5.1.4.1.61. Property option

Title: The Option Schema
Type object
Required No
Additional properties Not allowed
Property Pattern Type Deprecated Definition Title/Description
- name No string No - -
- args No array of string No - -
- output No string No - -
- dataType No enum (of string) No - -
5.1.4.1.61.1. Property name
Type string
Required No
5.1.4.1.61.2. Property args
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The Events Items Schema -
5.1.4.1.61.2.1. The Events Items Schema

Title: The Events Items Schema
Type string
Required No
5.1.4.1.61.3. Property output
Type string
Required No
5.1.4.1.61.4. Property dataType
Type enum (of string)
Required No

Must be one of:

  • "string"
  • "bool"
  • "number"
5.1.4.1.62. Property epBinding

Title: The EpBinding Schema
Type string
Required No
5.1.4.1.63. Property dataview

Title: The Dataview Schema
Type string
Required No
5.1.4.1.64. Property dataTable

Title: The Datatable Schema
Type string
Required No
5.1.4.1.65. Property onSuccess

Title: The actionResult Schema
Type array
Required No
Defined in #/definitions/successResult
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The action Schema -
5.1.4.1.65.1. The action Schema

Title: The action Schema
Type combining
Required No
Additional properties Not allowed
Same definition as The action Schema
5.1.4.1.66. Property onError

Title: The actionResult Schema
Type array
Required No
Defined in #/definitions/errorResult
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The action Schema -
5.1.4.1.66.1. The action Schema

Title: The action Schema
Type combining
Required No
Additional properties Not allowed
Same definition as The action Schema
5.1.4.1.67. Property onEmpty

Title: The actionResult Schema
Type array
Required No
Defined in #/definitions/emptyResult
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The action Schema -
5.1.4.1.67.1. The action Schema

Title: The action Schema
Type combining
Required No
Additional properties Not allowed
Same definition as The action Schema
5.1.4.1.68. Property condition

Title: The Condition Schema
Type string
Required No
5.1.4.1.69. Property variable

Title: The variable Schema
Type string
Required No
5.1.4.1.70. Property onOk

Title: The actionResult Schema
Type array
Required No
Defined in #/definitions/okResult
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The action Schema -
5.1.4.1.70.1. The action Schema

Title: The action Schema
Type combining
Required No
Additional properties Not allowed
Same definition as The action Schema
5.1.4.1.71. Property onCancel

Title: The actionResult Schema
Type array
Required No
Defined in #/definitions/cancelResult
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The action Schema -
5.1.4.1.71.1. The action Schema

Title: The action Schema
Type combining
Required No
Additional properties Not allowed
Same definition as The action Schema
5.1.4.1.72. Property onYes

Title: The actionResult Schema
Type array
Required No
Defined in #/definitions/yesResult
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The action Schema -
5.1.4.1.72.1. The action Schema

Title: The action Schema
Type combining
Required No
Additional properties Not allowed
Same definition as The action Schema
5.1.4.1.73. Property onNo

Title: The actionResult Schema
Type array
Required No
Defined in #/definitions/noResult
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The action Schema -
5.1.4.1.73.1. The action Schema

Title: The action Schema
Type combining
Required No
Additional properties Not allowed
Same definition as The action Schema
5.1.4.1.74. Property onRetry

Title: The actionResult Schema
Type array
Required No
Defined in #/definitions/retryResult
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The action Schema -
5.1.4.1.74.1. The action Schema

Title: The action Schema
Type combining
Required No
Additional properties Not allowed
Same definition as The action Schema
5.1.4.1.75. Property onNone

Title: The actionResult Schema
Type array
Required No
Defined in #/definitions/noneResult
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The action Schema -
5.1.4.1.75.1. The action Schema

Title: The action Schema
Type combining
Required No
Additional properties Not allowed
Same definition as The action Schema
5.1.4.1.76. Property onAbort

Title: The actionResult Schema
Type array
Required No
Defined in #/definitions/abortResult
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The action Schema -
5.1.4.1.76.1. The action Schema

Title: The action Schema
Type combining
Required No
Additional properties Not allowed
Same definition as The action Schema
5.1.4.1.77. Property onIgnore

Title: The actionResult Schema
Type array
Required No
Defined in #/definitions/ignoreResult
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
The action Schema -
5.1.4.1.77.1. The action Schema

Title: The action Schema
Type combining
Required No
Additional properties Not allowed
Same definition as The action Schema
5.1.4.1.78. Property expression

Title: The Expression Schema
Type string
Required No

Generated using json-schema-for-humans on 2025-05-13 at 22:27:27 -0400

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment