Skip to main content
Version: 22.10

Reference

Models

ConfigCurrentSpace

Config to be used within a Space.

NameTypeDescriptionRequired
attachmentsCurrentSpaceAttachmentsSets the filters for the Attachments. Default: nullNo
bulkActionsCurrentSpaceBulkActionsConfiguration for bulk actions. Default: nullNo
currentBulkActionCurrentSpaceCurrentBulkActionBulk Action to apply in the Txn Table section. Default: [0]No
currentBulkUserCurrentSpaceCurrentBulkUserBulk User to apply in the Txn Table section. Default: nullNo
currentViewCurrentSpaceCurrentViewView to display in the Txn Table section. Default: [0]No
customCardsCurrentSpaceCustomCardsList of custom cards to be rendered in the Custom Cards section. Default: []No
emptyMessagestringMessage to be displayed when Txn Query returns empty. Default: nullNo
globalActionsCurrentSpaceGlobalActionsConfig for the global actions. Default: nullNo
globalFiltersCurrentSpaceGlobalFiltersConfig for the global filters. Default: nullNo
hideTasksCurrentSpaceHideTasksShows a list of steps and an array of tasks as children of those steps to be hidden from the timelineNo
iconCurrentSpaceIconSets the icon to be used for the space Default: static//icon.pngYes
invokeCurrentSpaceInvokeConfiguration to invoke fluent function. Default: nullNo
jobActionsCurrentSpaceJobActionsList of available job actions. Possible values: Receipt, ViewNotesNo
keyInfoCurrentSpaceKeyInfoList of properties to be rendered in the Key Info section. Default: []No
labelGlobalLabelSets the label to be used for the spaceYes
loadQuerybooleanFlag to define if Txn Query should be triggered on load. Default: nullNo
pageSizeCurrentSpacePageSizePage size to be used in the Txn Query. Default: 10No
permissionsGlobalPermissionsSets the permissions for the SpaceNo
rulesGlobalRulesRules that show/hide the attachments upload buttonNo
searchCurrentSpaceSearchList of searchable mapping properties. Default: []No
sourcestringSets the source for the current space Possible values: Job Default: nullNo
stepsCurrentSpaceStepsConfiguration for timeline. Default: []No
txnActionsCurrentSpaceTxnActionsList of available txn actions. Possible values: Claim, Release, Assign, Unassign, Decision, ViewForm, Recover, WithdrawNo
viewsCurrentSpaceViewsList of views to be rendered in the Txn Table section. Default: []Yes

ConfigGlobal

Config to be used globally.

NameTypeDescriptionRequired
faviconstringFavicon config to be used globally. Default: static//favicon.pngNo
hideStepsGlobalHideStepsList of steps to hide in the Timeline section. Default: []No
logostringLogo config to be used globally. Default: static/logo.pngNo
mappingsGlobalMappingsMappings config to be used globally. Default: nullYes
scopeGlobalScopeScope config to be used with txn and currentTxn query. Default: FormNo
themeThemeTheme config to be used globally. Default: nullNo

CurrentSpaceAction

Actions config to display in the Txn Table and Actions section.

Default: null

NameTypeDescriptionRequired
dataIndexGlobalDataIndexSets dataIndex of ActionNo
labelGlobalLabelSets type of ActionYes
permissionsGlobalPermissionsSets the persmissions for the ActionNo

CurrentSpaceActionCustom

Custom Actions config to display in the Txn Table and Actions section.

Default: null

NameTypeDescriptionRequired
dataIndexGlobalDataIndexSets dataIndex of ActionNo
labelGlobalLabelSets type of ActionYes
permissionsGlobalPermissionsSets the persmissions for the ActionNo
propertiesCurrentSpaceActionCustomPropertiesSets the persmissions for the ActionYes

CurrentSpaceActionCustomProperties

List of custom actions

NameTypeDescriptionRequired
CurrentSpaceActionCustomPropertiesarrayList of custom actions

CurrentSpaceActionCustomProperty

Custom Action Property

NameTypeDescriptionRequired
dataIndexGlobalDataIndexSets dataIndex of ActionNo
encodingGlobalEncodingSets the encoding. We currently support the following encoding: base64No
labelGlobalLabelSets type of ActionYes
paramsGlobalParamsSets the params of the fluent functionNo
rulesGlobalRulesSets the visibility rules for the custom actionNo
serviceNameGlobalServiceNameSets the name of the fluent functionNo
typeGlobalLinkTypeSets attributes for the linkYes
versionNumberGlobalInvokeVersionNumberSets the version number of the fluent functionNo

CurrentSpaceActionOptions

Object of form attributes

NameTypeDescriptionRequired
labelstringYes
valuestringYes

CurrentSpaceAttachments

NameTypeDescriptionRequired
duplicatesCurrentSpaceAttachmentsDuplicatesSet duplicates to show or hide.No
filterCurrentSpaceAttachmentsFilterSet filter for the attachmentsNo
hideUploadButtonCurrentSpaceAttachmentsHideUploadButtonHides the Document Upload ButtonNo
rulesGlobalRulesRules that show/hide the attachments upload buttonNo
uploadWithoutClaimCurrentSpaceAttachmentsUploadWithoutClaimSets the persmissions for the Action.No

CurrentSpaceAttachmentsDuplicates

Remove duplicates.

NameTypeDescriptionRequired
CurrentSpaceAttachmentsDuplicatesbooleanRemove duplicates.

CurrentSpaceAttachmentsFilter

Filter applied to attachments

NameTypeDescriptionRequired
actionstringAction for the filter. Possible values: include, excludeYes
regexstringRegex to match for the filter. If action is set to excludes, any items that match will be excluded. If action is set to includes and items that match will be includedYes

CurrentSpaceAttachmentsHideUploadButton

Hides the Document Upload Button

NameTypeDescriptionRequired
CurrentSpaceAttachmentsHideUploadButtonbooleanHides the Document Upload Button

CurrentSpaceAttachmentsUploadWithoutClaim

Sets the permissions for the Action.

NameTypeDescriptionRequired
CurrentSpaceAttachmentsUploadWithoutClaimbooleanSets the permissions for the Action.

CurrentSpaceBulkActions

The current space bulk actions

Default: null

NameTypeDescriptionRequired
enabledGlobalEnabledSets enabled/disabled stateNo
labelGlobalLabelSets type of ActionYes
permissionsGlobalPermissionsSets the persmissions for the ActionNo

CurrentSpaceCreateForm

Show/Hide a global create form action

NameTypeDescriptionRequired
labelGlobalLabelSets the labelYes
options[ CurrentSpaceActionOptions ]List of the forms to select fromYes

CurrentSpaceCurrentBulkAction

Bulk Action to apply in the Txn Table section.

Default: null

NameTypeDescriptionRequired
CurrentSpaceCurrentBulkActionstringBulk Action to apply in the Txn Table section. Default: null

CurrentSpaceCurrentBulkUser

Bulk User to apply in the Txn Table section.

Default: null

NameTypeDescriptionRequired
CurrentSpaceCurrentBulkUserstringBulk User to apply in the Txn Table section. Default: null

CurrentSpaceCurrentView

View to display in the Txn Table section.

Default: [0]

NameTypeDescriptionRequired
CurrentSpaceCurrentViewstringView to display in the Txn Table section. Default: [0]

CurrentSpaceCustomCardContainerProperty

NameTypeDescriptionRequired
labelGlobalLabelSets label for the Custom CardYes
properties[ CurrentSpaceCustomCardProperty ]Mappings for the Custom CardYes

CurrentSpaceCustomCardForm

NameTypeDescriptionRequired
dataSourceGlobalDataSourceUsed to define a deep data source (It needs to be a JSON value).No
hideEmptyGlobalHideEmptyHide empty fields configNo
labelGlobalLabelSets label for the Custom CardYes
permissionsGlobalPermissionsSets the permissions for the custom cardNo
propertiesMappings for the Custom CardYes
rulesGlobalRulesvisibility rules fields configNo
typestringSets the custom card type. Possible value: formYes

CurrentSpaceCustomCardList

NameTypeDescriptionRequired
dataSourceGlobalDataSourceUsed to define a deep data source (It needs to be a JSON value).No
hideEmptyGlobalHideEmptyHide empty fields configNo
labelGlobalLabelSets label for the Custom CardNo
permissionsGlobalPermissionsSets the permissions for the custom cardNo
propertiesMappings for the Custom CardYes
rulesGlobalRulesvisibility rules fields configNo
typestringSets the custom card type. Possible value: listYes

CurrentSpaceCustomCardListExtended

NameTypeDescriptionRequired
dataSourceGlobalDataSourceUsed to define a deep data source (It needs to be a JSON value).No
hideEmptyGlobalHideEmptyHide empty fields configNo
labelGlobalLabelSets label for the Custom CardNo
permissionsGlobalPermissionsSets the permissions for the custom cardNo
propertiesMappings for the Custom CardYes
rulesGlobalRulesvisibility rules fields configNo
statusColorsCurrentSpaceStatusColorsStatus color config to be used in the ExtendedList card section. Default: nullYes
typestringSets the custom card type, Possible value: listExtendedYes

CurrentSpaceCustomCardListStacked

NameTypeDescriptionRequired
dataSourceGlobalDataSourceUsed to define a deep data source (It needs to be a JSON value).No
hideEmptyGlobalHideEmptyHide empty fields configNo
labelGlobalLabelSets label for the Custom CardNo
permissionsGlobalPermissionsSets the permissions for the custom cardNo
properties[ CurrentSpaceCustomCardProperty ]Mappings for the Custom CardYes
rulesGlobalRulesvisibility rules fields configNo
typestringSets the custom card type. Possible value: listStackedYes

CurrentSpaceCustomCardProperty

NameTypeDescriptionRequired
columnWrapGlobalColumnWrapSets the column content to not wrap. Possible Values: falseNo
dataIndexGlobalDataIndexSets the path of the Txn property to be displayed. Default: nullYes
formatGlobalFormatSets a format for the data Possible values: relative, durationNo
fullWidthGlobalFullWidthSets property display to full width Possible values: trueNo
labelGlobalLabelSets the label to be usedYes
linkGlobalLinkSets attributes for the linkNo
nameGlobalNameSets a name for the data Possible values: stringNo
parseGlobalParseSets a parse for the data. Possible values: nullNo
spanGlobalSpanSets the grid config.No
typeGlobalTypeSets property type. Possible values: date, text, numberYes

CurrentSpaceCustomCardTable

NameTypeDescriptionRequired
dataSourceGlobalDataSourceUsed to define a deep data source (It needs to be a JSON value).Yes
hideEmptyGlobalHideEmptyHide empty fields configNo
labelGlobalLabelSets label for the Custom CardYes
permissionsGlobalPermissionsSets the permissions for the custom cardNo
properties[ CurrentSpaceCustomCardProperty ]Mappings for the Custom CardYes
rulesGlobalRulesvisibility rules fields configNo
typestringSets the custom card type. Possible value: tableYes

CurrentSpaceCustomCardTableExtended

NameTypeDescriptionRequired
dataSourceGlobalDataSourceUsed to define a deep data source (It needs to be a JSON value).Yes
hideEmptyGlobalHideEmptyHide empty fields configNo
labelGlobalLabelSets label for the Custom CardYes
permissionsGlobalPermissionsSets the permissions for the custom cardNo
rulesGlobalRulesvisibility rules fields configNo
sectionsCurrentSpaceSectionsSub-sections for the Custom CardYes
typestringSets the custom card type. Possible value: tableExtendedYes

CurrentSpaceCustomCardTabs

Sets the customCard tabs properties

NameTypeDescriptionRequired
hideEmptyGlobalHideEmptyNo
labelCurrentSpaceCustomCardTabsLabelYes
properties[ ]Yes
rulesGlobalRulesNo

CurrentSpaceCustomCardTabsLabel

Sets the label to be used for the custom card tab

NameTypeDescriptionRequired
CurrentSpaceCustomCardTabsLabelstringSets the label to be used for the custom card tab

CurrentSpaceCustomCards

Removes string for Custom Card type

NameTypeDescriptionRequired
CurrentSpaceCustomCardsarrayRemoves string for Custom Card type

CurrentSpaceDateCreated

Show/Hide a global filter for Date Created

NameTypeDescriptionRequired
labelGlobalLabelSets a label for the filter. Default: nullYes
value[ string ]Sets a date range for the filter. Default: nullYes

CurrentSpaceFilterBy

Sets the filters to apply to the view.

Default: null

NameTypeDescriptionRequired
CurrentSpaceFilterByobjectSets the filters to apply to the view. Default: null

CurrentSpaceFormName

Used to show/hide the Create Forms button that allows Workspaces users to create new forms using Maestro forms

NameTypeDescriptionRequired
labelGlobalLabelSets the label for the filterYes
options[ CurrentSpaceFormOptions ]List of the product types to select from.No
valueSets the defaut option for the filterYes

CurrentSpaceFormOptions

Object of form attributes

NameTypeDescriptionRequired
labelstringYes
value[ string ]Yes

CurrentSpaceGlobalActions

Global actions config

Default: null

NameTypeDescriptionRequired
CreateFormCurrentSpaceCreateFormShow/hide Create Form button.Yes

CurrentSpaceGlobalFilters

Global filters config

Default: null

NameTypeDescriptionRequired
DateCreatedCurrentSpaceDateCreatedShow/Hide a global filter for Date CreatedNo
FormNameCurrentSpaceFormNameUsed to show/hide the Create Forms button that allows Workspaces users to create new forms using Maestro formsNo
GroupNameCurrentSpaceGroupNameShow/Hide a global filter for Group NamesNo
SpaceNameCurrentSpaceSpaceNameShow/Hide a global filter for SpacesNo

CurrentSpaceGroupName

Show/Hide a global filter for Spaces

NameTypeDescriptionRequired
labelGlobalLabelSets a label for the filter Default: nullYes
options[ CurrentSpaceGroupOptions ]List of groups to select from Default: []Yes
valueSets the default option for the filter Default: nullYes

CurrentSpaceGroupOptions

Object of form attributes

NameTypeDescriptionRequired
labelstringYes
value[ string ]Yes

CurrentSpaceHideTasks

Shows a list of steps and an array of tasks as children of those steps to be hidden from the timeline

NameTypeDescriptionRequired
CurrentSpaceHideTasksobjectShows a list of steps and an array of tasks as children of those steps to be hidden from the timeline

CurrentSpaceIcon

Sets the icon to be used for the space

NameTypeDescriptionRequired
CurrentSpaceIconstringSets the icon to be used for the space

CurrentSpaceInvoke

NameTypeDescriptionRequired
paramsGlobalParamsSets the params of the fluent functionNo
rulesGlobalRulesvisibility rules fields configNo
serviceNameGlobalServiceNameSets the name of the fluent functionYes
versionNumberGlobalInvokeVersionNumberSets the version number of the fluent functionNo

CurrentSpaceJobActions

NameTypeDescriptionRequired
ReceiptCurrentSpaceActionShows the receipt. When clicked it opens up a modal with the current Txn formReceipt. If there is more than one receipt attached to the Txn, the modal will show a dropdown list to view each one.No
ViewNotesCurrentSpaceActionShows the all notes for the job in a modal.No
ViewXMLCurrentSpaceActionWhen clicked it display the txn's XML.No

CurrentSpaceKeyInfo

List of items displaying in the Key Info panel

NameTypeDescriptionRequired
CurrentSpaceKeyInfoarrayList of items displaying in the Key Info panel

CurrentSpacePageSize

The current rows per page

NameTypeDescriptionRequired
CurrentSpacePageSizenumberThe current rows per page

CurrentSpaceProperty

Defines a mapping for use in the view.

NameTypeDescriptionRequired
columnWrapGlobalColumnWrapSets the column content to not wrap. Possible Values: falseNo
dataIndexGlobalDataIndexSets the path of the Txn property to be displayed. Default: nullYes
filterGlobalFilterSets the filter strategy for this mapping. Possible values: input, select, multiselect, pickerNo
formatGlobalFormatSets a format for the data Possible values: relative, durationNo
hideFromTablebooleanHide fields from table (but can still filter on them)No
iconCurrentSpaceIconSets the icon to be usedNo
labelGlobalLabelSets the label to be usedYes
parseGlobalParseSets a parse for the data. Possible values: nullNo
sorterGlobalSorterSets the mapping to be sortable via the column headerNo
tooltipGlobalTooltipSets the tooltip optionsNo
typeGlobalTypeSets property type. Possible values: date, text, numberYes

CurrentSpaceSearch

Sets the search bar properties

NameTypeDescriptionRequired
labelCurrentSpaceSearchLabelYes
propertiesCurrentSpaceSearchPropertiesYes

CurrentSpaceSearchLabel

Sets the label to be used for the space

NameTypeDescriptionRequired
CurrentSpaceSearchLabelstringSets the label to be used for the space

CurrentSpaceSearchProperties

Sets the icon to be used for the space

NameTypeDescriptionRequired
CurrentSpaceSearchPropertiesarraySets the icon to be used for the space

CurrentSpaceSections

NameTypeDescriptionRequired
CurrentSpaceSectionsarray

CurrentSpaceSortBy

The mapping key to sort by

Default: null

NameTypeDescriptionRequired
CurrentSpaceSortBystringThe mapping key to sort by Default: null

CurrentSpaceSortOrder

Direction of the sort.

Possible values: asc, desc.

Default: asc

NameTypeDescriptionRequired
CurrentSpaceSortOrderstringDirection of the sort. Possible values: asc, desc. Default: asc

CurrentSpaceSpaceName

Show/Hide a global filter for Space Names

NameTypeDescriptionRequired
labelGlobalLabelSets a label for the filter Default: nullYes
optionsCurrentSpaceSpaceOptionsList of spaces to select from Default: []No
valueCurrentSpaceSpaceNameValueSets the default option for the filter Default: nullYes

CurrentSpaceSpaceNameValue

Sets the default option for the filter

Default: null

NameTypeDescriptionRequired
CurrentSpaceSpaceNameValuestringSets the default option for the filter Default: null

CurrentSpaceSpaceOptions

List of Spaces

NameTypeDescriptionRequired
CurrentSpaceSpaceOptionsarrayList of Spaces

CurrentSpaceStatusColors

Status color config to be used in the ExtendedList card section

NameTypeDescriptionRequired
Black[ string ]No
Blue[ string ]No
Green[ string ]No
LightGreen[ string ]No
Orange[ string ]No
Red[ string ]No

CurrentSpaceSteps

List of steps to show in timeline

Type: CurrentSpaceStepsProperties[]

NameTypeDescriptionRequired
CurrentSpaceStepsarrayList of steps to show in timeline Type: CurrentSpaceStepsProperties[]

CurrentSpaceStepsProperties

NameTypeDescriptionRequired
labelstringYes
valueYes

CurrentSpaceTxnActions

List of available actions.

NameTypeDescriptionRequired
AbandonCurrentSpaceActionWhen clicked it triggers the abandone process.No
AssignCurrentSpaceActionWhen clicked it opens up a dropdown of usernames to pick from. Once a user is selected, the current Txn gets assigned to that user.No
ClaimCurrentSpaceActionWhen clicked it assigns the current Txn to the current user.No
CustomCurrentSpaceActionCustomAllows configured custom actions to be displayed in a dropdown.No
DecisionCurrentSpaceActionWhen clicked it opens up a modal with the current Txn formUrl + &pageId=decision.No
PurgeCurrentSpaceActionWhen clicked it triggers the purge process.No
ReassignCurrentSpaceActionWhen clicked it opens up a dropdown of usernames to pick from. Once a user is selected, the current Txn gets re-assigned to that user.No
RecoverCurrentSpaceActionWhen clicked the abandoned txn will be re-opened.No
ReleaseCurrentSpaceActionWhen clicked it unassigns the current Txn. This actions will be available only if the current user is the assignee.No
ResumeCurrentSpaceActionWhen clicked it resumes the job.No
TransactionPurgeCurrentSpaceActionWhen clicked it triggers the txn purge process.No
UnassignCurrentSpaceActionWhen clicked it unassigns the current Txn. The difference with Release is that Unassign is available to all users.No
ViewFormCurrentSpaceActionWhen clicked it opens up a modal with the current Txn formUrl + &pageId=view.No
WithdrawCurrentSpaceActionWhen clicked saved txn will be abandoned.No

CurrentSpaceView

Defines a group of table configurations that will be displayed on the List Screen. Views are pre-configured groups of properties, they specifies which criterias are included on the Txn query (sort and filters).

NameTypeDescriptionRequired
filterByCurrentSpaceFilterBySets the filters to apply to the view Default: nullNo
labelGlobalLabelText used as value and name of the view. Default: nullYes
permissionsGlobalPermissionsSets the permissions for the viewNo
propertiesCurrentSpaceViewPropertiesList of Mapping Objects or Mapping keys. Default: nullYes
sortByCurrentSpaceSortByThe mapping key to sort by Default: nullNo
sortOrderCurrentSpaceSortOrderDirection of the sort. Possible values: asc, desc. Default: ascNo

CurrentSpaceViewProperties

List of Mapping Objects or Mapping keys.

Default: null

NameTypeDescriptionRequired
CurrentSpaceViewPropertiesarrayList of Mapping Objects or Mapping keys. Default: null

CurrentSpaceViews

List of views

NameTypeDescriptionRequired
CurrentSpaceViewsarrayList of views

GlobalColumnWrap

Sets the column content to not wrap.

Possible values: true/false

NameTypeDescriptionRequired
GlobalColumnWrapbooleanSets the column content to not wrap. Possible values: true/false

GlobalCustomCardType

Sets type for the Custom Card

Possible values: list, listStacked, listExtended, table, tableExtended

NameTypeDescriptionRequired
GlobalCustomCardTypestringSets type for the Custom Card Possible values: list, listStacked, listExtended, table, tableExtended

GlobalDataIndex

Sets the path of the Txn property to be displayed.

NameTypeDescriptionRequired
GlobalDataIndexSets the path of the Txn property to be displayed.

GlobalDataSource

Used to define a deep data source (It needs to be a JSON value).

NameTypeDescriptionRequired
GlobalDataSourceUsed to define a deep data source (It needs to be a JSON value).

GlobalDisabled

The global disabled state

NameTypeDescriptionRequired
GlobalDisabledbooleanThe global disabled state

GlobalDisplayFormat

Sets display format

NameTypeDescriptionRequired
GlobalDisplayFormatstringSets display format

GlobalEnabled

Sets enabled/disabled state

NameTypeDescriptionRequired
GlobalEnabledbooleanSets enabled/disabled state

GlobalEncoding

Sets the encoding. We currently support the following encoding: base64

NameTypeDescriptionRequired
GlobalEncodingstringSets the encoding. We currently support the following encoding: base64

GlobalFilter

Sets the filter strategy for this mapping.

Possible values: input, select, multiselect, picker

NameTypeDescriptionRequired
GlobalFilterSets the filter strategy for this mapping. Possible values: input, select, multiselect, picker

GlobalFilterOptionsInput

NameTypeDescriptionRequired
typestringSets the global filter type to input. Possible values: inputYes

GlobalFilterOptionsPicker

NameTypeDescriptionRequired
optionsobjectSet the default date range for the date picker. Possible values: minDate, maxDateNo
typestringSet the global filter type to be a date picker. Possible values: datepicker,daterangepickerYes

GlobalFilterOptionsSelect

NameTypeDescriptionRequired
options[ string ]Sets the options for the select dropdownNo
typestringSets the global filter type Possible values: select, multiselectYes

GlobalFormat

Sets a format for the data.

Possible values: relative, duration

NameTypeDescriptionRequired
GlobalFormatstringSets a format for the data. Possible values: relative, duration

GlobalFullWidth

Sets property display to full width.

Possible values: true/false

NameTypeDescriptionRequired
GlobalFullWidthbooleanSets property display to full width. Possible values: true/false

GlobalHideEmpty

Hide empty fields config

NameTypeDescriptionRequired
GlobalHideEmptybooleanHide empty fields config

GlobalHideSteps

List of steps to hide in the Timeline section.

Default: []

NameTypeDescriptionRequired
GlobalHideStepsarrayList of steps to hide in the Timeline section. Default: []

GlobalIcon

Sets the icon to be used

NameTypeDescriptionRequired
GlobalIconstringSets the icon to be used

GlobalInput

The global input

NameTypeDescriptionRequired
GlobalInputThe global input

GlobalInvokeVersionNumber

NameTypeDescriptionRequired
GlobalInvokeVersionNumber

GlobalInvokeVersionNumberDataIndex

NameTypeDescriptionRequired
dataIndexGlobalDataIndexYes

GlobalLabel

Sets the label to be used

NameTypeDescriptionRequired
GlobalLabelstringSets the label to be used
NameTypeDescriptionRequired
dataIndexGlobalDataIndexSets the path of the Txn property to be displayed.Yes
encodingGlobalEncodingSets the encoding. We currently support the following encoding: base64No
paramsGlobalParamsSets the params of the fluent functionNo
rulesGlobalRulesvisibility rules fields configNo
serviceNameGlobalServiceNameSets the name of the fluent functionNo
typeGlobalLinkTypeSets link type. Possible values: pdf, html, text, xml, json, url, fileYes
versionNumberGlobalInvokeVersionNumberSets the version number of the fluent functionNo

GlobalLinkType

Sets link type.

Possible values: pdf, html, text, xml, invoke, json, url, file, auto

NameTypeDescriptionRequired
GlobalLinkTypestringSets link type. Possible values: pdf, html, text, xml, invoke, json, url, file, auto

GlobalMapping

NameTypeDescriptionRequired
columnWrapGlobalColumnWrapSets the column content to not wrap. Possible Values: true/falseNo
dataIndexGlobalDataIndexSets the path of the Txn property to be displayedNo
dataSourceGlobalDataSourceUsed to define a deep data source (It needs to be a JSON value)No
disabledGlobalDisabledSets the path of the Txn property to be displayedNo
displayFormatGlobalDisplayFormatSets the display FormatNo
filterGlobalFilterSets the filter strategy for this mapping. Possible values: input, select, multiselect, pickerNo
formatGlobalFormatSets a format for the data. Possible values: relative, durationNo
hideEmptyGlobalHideEmptyHide empty fields configNo
hideFromTablebooleanHide fields from table (but can still filter on them)No
iconGlobalIconSets the iconNo
inputGlobalInputSets the input config.No
labelGlobalLabelSets the labelYes
linkGlobalLinkSets attributes for the linkNo
maxLengthGlobalMaxLengthSets the max length of the property to be displayedNo
nameGlobalNameSets a name for the data. Possible values: nullNo
newRowGlobalNewRowSets a new rowNo
parseGlobalParseSets a parse for the data. Possible values: nullNo
permissionsGlobalPermissionsSets the permissions for the viewNo
propertiesGlobalMappingPropertiesList of Mapping Objects or Mapping keys Default: nullNo
rulesGlobalRulesvisibility rules fields configNo
sectionsCurrentSpaceSectionsStatus color config to be used in the ExtendedList card section Default: nullNo
sorterGlobalSorterSets the mapping to be sortable via the column headerNo
spanGlobalSpanSets the grid config.No
statusColorsCurrentSpaceStatusColorsStatus color config to be used in the ExtendedList card section Default: nullNo
tooltipGlobalTooltipSets the tooltip optionsNo
typeSets type for the property Possible values: text, date, number, alert, time, list, listExtended, listStacked, table, tableExtendedYes
validationGlobalValidationSets the validationNo
warningGlobalWarningSets warning timeframe for the SLANo

GlobalMappingProperties

NameTypeDescriptionRequired
GlobalMappingPropertiesarray

GlobalMappingProperty

NameTypeDescriptionRequired
columnWrapGlobalColumnWrapSets the column content to not wrap. Possible Values: true/falseNo
dataIndexGlobalDataIndexSets the path of the Txn property to be displayedNo
disabledGlobalDisabledSets the property as disabledNo
displayFormatGlobalDisplayFormatSets the display FormatNo
filterGlobalFilterSets the filter strategy for this mapping. Possible values: input, select, multiselect, pickerNo
formatGlobalFormatSets a format for the data. Possible values: relative, durationNo
fullWidthGlobalFullWidthSets property display to full width Possible values: trueNo
hideEmptyGlobalHideEmptyHide empty fields configNo
inputGlobalInputSets the input config.No
labelGlobalLabelSets the labelYes
linkGlobalLinkSets attributes for the linkNo
maxLengthGlobalMaxLengthSets the max length of the property to be displayedNo
nameGlobalNameSets name to the custom card. Default: nullNo
newRowGlobalNewRowSets a new rowNo
parseGlobalParseSets a parse for the data. Possible values: nullNo
propertiesGlobalMappingPropertiesList of Mapping Objects or Mapping keys Default: nullNo
rulesGlobalRulesvisibility rules fields configNo
sorterGlobalSorterSets the mapping to be sortable via the column headerNo
spanGlobalSpanSets the grid config.No
tooltipGlobalTooltipSets the tooltip optionsNo
typeSets type for the property Possible values: text, date, number, alert, time, list, listExtended, listStacked, table, tableExtendedNo
validationGlobalValidationSets the validationNo
warningGlobalWarningSets warning timeframe for the SLANo

GlobalMappings

Mappings config to be used globally.

Default: null

NameTypeDescriptionRequired
GlobalMappingsobjectMappings config to be used globally. Default: null

GlobalMaxLength

The global maxLength state

NameTypeDescriptionRequired
GlobalMaxLengthnumberThe global maxLength state

GlobalName

The global name state

NameTypeDescriptionRequired
GlobalNamestringThe global name state

GlobalNewRow

Sets new row

NameTypeDescriptionRequired
GlobalNewRowbooleanSets new row

GlobalParams

The global params state

NameTypeDescriptionRequired
GlobalParamsThe global params state

GlobalParse

Sets a parse for the data.

NameTypeDescriptionRequired
GlobalParsestringSets a parse for the data.

GlobalPermissions

Sets permissions for spaces or actions.

NameTypeDescriptionRequired
typeGlobalPermissionsTypeSets permission type. Possible values: group, roleYes
value[ string ]Sets values depending on the permissionYes

GlobalPermissionsType

NameTypeDescriptionRequired
GlobalPermissionsTypestring

GlobalRules

The global rules config.

NameTypeDescriptionRequired
GlobalRulesThe global rules config.

GlobalRulesItem

The global rules item

NameTypeDescriptionRequired
dataIndexYes
valueYes

GlobalScope

Scope config to be used with txn and currentTxn query.

NameTypeDescriptionRequired
GlobalScopestringScope config to be used with txn and currentTxn query.

GlobalServiceName

Sets the name of the fluent function

NameTypeDescriptionRequired
GlobalServiceNamestringSets the name of the fluent function

GlobalSorter

Sets the sorter to be used

NameTypeDescriptionRequired
GlobalSorterbooleanSets the sorter to be used

GlobalSpan

Sets grid configuration

NameTypeDescriptionRequired
GlobalSpanSets grid configuration

GlobalTooltip

Set global tooltip options

NameTypeDescriptionRequired
dataIndexstringNo

GlobalType

Sets property type.

Possible values: date, text, number, alert

NameTypeDescriptionRequired
GlobalTypestringSets property type. Possible values: date, text, number, alert

GlobalValidation

The global validation

NameTypeDescriptionRequired
GlobalValidationThe global validation

GlobalVersionNumber

Sets the version number of the fluent function

NameTypeDescriptionRequired
GlobalVersionNumberstringSets the version number of the fluent function

GlobalWarning

Sets warning timeframe for the SLA.

NameTypeDescriptionRequired
GlobalWarningstringSets warning timeframe for the SLA.

Theme

NameTypeDescriptionRequired
blackstringGlobal theme colorNo
blueThemeSecondaryColorPropertyGlobal theme color. Possible values: main, lightNo
greenThemeSecondaryColorPropertyGlobal theme color. Possible values: main, lightNo
greyThemeColorPropertyGlobal theme color. Possible values: light, lightest, primary, dark, darkestNo
orangestringGlobal theme colorNo
primaryThemePrimaryColorPropertyGlobal theme primary color. Possible values: mainNo
redThemeSecondaryColorPropertyGlobal theme color. Possible values: main, lightNo
textThemeSecondaryColorPropertyGlobal theme color. Possible values: main, lightNo
whitestringGlobal theme colorNo

ThemeColorProperty

Global theme property

NameTypeDescriptionRequired
darkstringGlobal theme color variation. Use a hex color codeNo
darkeststringGlobal theme color variation. Use a hex color codeNo
lightstringGlobal theme color variation. Use a hex color codeNo
lighteststringGlobal theme color variation. Use a hex color codeNo
primarystringGlobal theme color variation. Use a hex color codeNo

ThemePrimaryColorProperty

NameTypeDescriptionRequired
mainstringGlobal theme color variation. Use a hex color codeNo

ThemeSecondaryColorProperty

NameTypeDescriptionRequired
lightstringGlobal theme color variation. Use a hex color codeNo
mainstringGlobal theme color variation. Use a hex color codeNo