Skip to main content
Version: 19.11

Reference

Models

Config

Txn properties to be used as config.

Default: null

NameTypeDescriptionRequired
ConfigobjectTxn properties to be used as config. Default: null

ConfigCurrentSpace

Config to be used within a Space.

NameTypeDescriptionRequired
actionsCurrentSpaceActionsList of available actions. Possible values: Receipt, Claim, Release, Assign, Unassign, Decision, ViewForm, Recover, WithdrawNo
attachmentsCurrentSpaceAttachmentsSets the filters for the Attachments. 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
keyInfoCurrentSpaceKeyInfoList of properties to be rendered in the Key Info section. Default: []No
loadLatestTxnbooleanSets the detail screen to show the transaction that is clicked on in the listing page. Possible Values: falseNo
loadQuerybooleanFlag to define if Txn Query should be triggered on load. Default: nullNo
pageSizenumberPage size to be used in the Txn Query. Default: 10No
titlestringTitle to be used on top of the Txn Table section. Default: HomeNo
viewsCurrentSpaceViewsList of views to be rendered in the Txn Table section. Default: []Yes

ConfigGlobal

Config to be used globally.

NameTypeDescriptionRequired
currentLocalestringLocale to be used globally. Default: enNo
currentSpacestringSpace to be used globally. Default: nullNo
hideStepsGlobalHideStepsList of steps to hide in the Timeline section. Default: []No
locales[ string ]List of locales to be displayed in the Top Nav section. Default: []No
mappingsGlobalMappingsMappings config to be used globally. Default: nullYes
spacesGlobalSpacesList of spaces to be displayed on the Left Nav section. Default: []Yes
themeGlobalThemeTheme config to be used globally. Default: nullNo

CurrentSpaceAction

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

Default: null

NameTypeDescriptionRequired
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
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 ActionYes
encodingGlobalEncodingSets the encoding. We currently support the following encoding: base64No
labelGlobalLabelSets type of ActionYes
typeGlobalLinkTypeSets attributes for the linkYes

CurrentSpaceActions

List of available actions.

NameTypeDescriptionRequired
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
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
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
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

CurrentSpaceAttachments

NameTypeDescriptionRequired
duplicatesCurrentSpaceAttachmentsDuplicatesSet duplicates to show or hide.No
filterCurrentSpaceAttachmentsFilterSet filter for the attachmentsNo
uploadWithoutClaimCurrentSpaceAttachmentsUploadWithoutClaimSets the persmissions for the Action.No

CurrentSpaceAttachmentsDuplicates

NameTypeDescriptionRequired
CurrentSpaceAttachmentsDuplicatesboolean

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

CurrentSpaceAttachmentsUploadWithoutClaim

Sets the persmissions for the Action.

NameTypeDescriptionRequired
CurrentSpaceAttachmentsUploadWithoutClaimbooleanSets the persmissions for the Action.

CurrentSpaceCreateForm

Show/Hide a global create form action

NameTypeDescriptionRequired
labelGlobalLabelSets the labelYes
optionsCurrentSpaceFormOptionsList of the forms to select fromYes

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

CurrentSpaceCustomCardList

NameTypeDescriptionRequired
dataSourceGlobalDataSourceUsed to define a deep data source (It needs to be a JSON value).No
iconGlobalIconSets icon for the Custom CardNo
labelGlobalLabelSets label for the Custom CardYes
propertiesMappings for the Custom CardYes
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
iconGlobalIconSets icon for the Custom CardNo
labelGlobalLabelSets label for the Custom CardYes
propertiesMappings for the Custom CardYes
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
iconGlobalIconSets icon for the Custom CardNo
labelGlobalLabelSets label for the Custom CardYes
properties[ CurrentSpaceCustomCardProperty ]Mappings for the Custom CardYes
typestringSets the custom card type. Possible value: listStackedYes

CurrentSpaceCustomCardProperty

NameTypeDescriptionRequired
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
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
iconGlobalIconSets icon for the Custom CardNo
labelGlobalLabelSets label for the Custom CardYes
properties[ CurrentSpaceCustomCardProperty ]Mappings for the Custom CardYes
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
iconGlobalIconSets icon for the Custom CardNo
labelGlobalLabelSets label for the Custom CardYes
sectionsCurrentSpaceSectionsSub-sections for the Custom CardYes
typestringSets the custom card type. Possible value: tableExtendedYes

CurrentSpaceCustomCards

List of Custom Cards

NameTypeDescriptionRequired
CurrentSpaceCustomCardsarrayList of Custom Cards

CurrentSpaceDateCreated

Show/Hide a global filter for Date Created

NameTypeDescriptionRequired
labelGlobalLabelSets a label for the filter. Default: nullYes
value[ ]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
optionsCurrentSpaceFormOptionsList of the product types to select fromYes
valuestringSets the defaut option for the filterYes

CurrentSpaceFormOptions

List of products

NameTypeDescriptionRequired
CurrentSpaceFormOptionsarrayList of products

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

CurrentSpaceGroupName

Show/Hide a global filter for Group Names

NameTypeDescriptionRequired
labelGlobalLabelSets a label for the filter Default: nullYes
optionsCurrentSpaceGroupOptionsList of groups to select from Default: []Yes
valuestringSets the defaut option for the filter Default: nullYes

CurrentSpaceGroupOptions

List of groups

NameTypeDescriptionRequired
CurrentSpaceGroupOptionsarrayList of groups

CurrentSpaceKeyInfo

List of items displaying in the Key Info panel

NameTypeDescriptionRequired
CurrentSpaceKeyInfoarrayList of items displaying in the Key Info panel

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
iconGlobalIconSets the icon to be usedNo
labelGlobalLabelSets the label to be usedYes
sorterGlobalSorterSets the mapping to be sortable via the column headerNo
typeGlobalTypeSets property type. Possible values: date, text, numberYes

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

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

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
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
GlobalDataSourcestringUsed to define a deep data source (It needs to be a JSON value).

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: pickerYes

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

NameTypeDescriptionRequired
GlobalFullWidthbooleanSets property display to full width Possible values: true

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. For a list of supported icons, see Icons.

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
typeGlobalLinkTypeSets link type. Possible values: pdf, html, text, xml, json, url, fileYes

GlobalLinkType

Sets link type.

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

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

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
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
iconGlobalIconSets the iconNo
labelGlobalLabelSets the labelYes
linkGlobalLinkSets attributes for the linkNo
propertiesGlobalMappingPropertiesList of Mapping Objects or Mapping keys Default: nullNo
sectionsCurrentSpaceSectionsStatus color config to be used in the ExtendedList card section Default: nullNo
sorterGlobalSorterSets the mapping to be sortable via the column headerNo
statusColorsCurrentSpaceStatusColorsStatus color config to be used in the ExtendedList card section Default: nullNo
typeSets type for the property Possible values: text, date, number, alert, time, list, listExtended, table, tableExtendedYes
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
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
labelGlobalLabelSets the labelYes
linkGlobalLinkSets attributes for the linkNo
propertiesGlobalMappingPropertiesList of Mapping Objects or Mapping keys Default: nullNo
sorterGlobalSorterSets the mapping to be sortable via the column headerNo
typeSets type for the property Possible values: text, date, number, alert, time, list, listExtended, table, tableExtendedNo
warningGlobalWarningSets warning timeframe for the SLANo

GlobalMappings

Mappings config to be used globally.

Default: null

NameTypeDescriptionRequired
GlobalMappingsobjectMappings config to be used globally. Default: null

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

GlobalSorter

Sets the sorter to be used

NameTypeDescriptionRequired
GlobalSorterbooleanSets the sorter to be used

GlobalSpace

NameTypeDescriptionRequired
iconGlobalIconSets the icon to be usedYes
labelGlobalLabelSets the label to be usedYes
permissionsGlobalPermissionsSets the permissions for the SpaceNo
valuestringSets the name of the SpaceYes

GlobalSpaces

List of Spaces

NameTypeDescriptionRequired
GlobalSpacesarrayList of Spaces

GlobalTheme

Theme config to be used globally.

NameTypeDescriptionRequired
accentGlobalThemePropertyGlobal theme accent color. Possible values: mainNo
blackstringGlobal theme colorNo
blueGlobalThemePropertyGlobal theme color. Possible values: main, lightNo
greenstringGlobal theme colorNo
greyGlobalThemePropertyGlobal theme color. Possible values: background, keylineNo
lightGreenstringGlobal theme colorNo
orangestringGlobal theme colorNo
primaryGlobalThemePropertyGlobal theme primary color. Possible values: mainNo
redGlobalThemePropertyGlobal theme color. Possible values: main, lightNo
textGlobalThemePropertyGlobal theme color. Possible values: dark, lightNo
whitestringGlobal theme colorNo

GlobalThemeProperty

Global theme property

NameTypeDescriptionRequired
backgroundstringGlobal theme color variationNo
darkstringGlobal theme color variationNo
keylinestringGlobal theme color variationNo
lightstringGlobal theme color variationNo
mainstringGlobal theme color variationNo

GlobalType

Sets property type.

Possible values: date, text, number, alert

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

GlobalWarning

Sets warning timeframe for the SLA

NameTypeDescriptionRequired
GlobalWarningstringSets warning timeframe for the SLA