Reference

Models

Config

Txn properties to be used as config.

Default: null

Name	Type	Description	Required
Config	object	Txn properties to be used as config. Default: null

ConfigCurrentSpace

Config to be used within a Space.

Name	Type	Description	Required
actions	CurrentSpaceActions	List of available actions. Possible values: Receipt, Claim, Release, Assign, Unassign, Decision, ViewForm, Recover, Withdraw	No
attachments	CurrentSpaceAttachments	Sets the filters for the Attachments. Default: null	No
currentView	CurrentSpaceCurrentView	View to display in the Txn Table section. Default: [0]	No
customCards	CurrentSpaceCustomCards	List of custom cards to be rendered in the Custom Cards section. Default: []	No
emptyMessage	string	Message to be displayed when Txn Query returns empty. Default: null	No
globalActions	CurrentSpaceGlobalActions	Config for the global actions. Default: null	No
globalFilters	CurrentSpaceGlobalFilters	Config for the global filters. Default: null	No
keyInfo	CurrentSpaceKeyInfo	List of properties to be rendered in the Key Info section. Default: []	No
loadLatestTxn	boolean	Sets the detail screen to show the transaction that is clicked on in the listing page. Possible Values: false	No
loadQuery	boolean	Flag to define if Txn Query should be triggered on load. Default: null	No
pageSize	number	Page size to be used in the Txn Query. Default: 10	No
title	string	Title to be used on top of the Txn Table section. Default: Home	No
views	CurrentSpaceViews	List of views to be rendered in the Txn Table section. Default: []	Yes

ConfigGlobal

Config to be used globally.

Name	Type	Description	Required
currentLocale	string	Locale to be used globally. Default: en	No
currentSpace	string	Space to be used globally. Default: null	No
hideSteps	GlobalHideSteps	List 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
mappings	GlobalMappings	Mappings config to be used globally. Default: null	Yes
spaces	GlobalSpaces	List of spaces to be displayed on the Left Nav section. Default: []	Yes
theme	GlobalTheme	Theme config to be used globally. Default: null	No

CurrentSpaceAction

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

Default: null

Name	Type	Description	Required
label	GlobalLabel	Sets type of Action	Yes
permissions	GlobalPermissions	Sets the persmissions for the Action	No

CurrentSpaceActionCustom

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

Default: null

Name	Type	Description	Required
label	GlobalLabel	Sets type of Action	Yes
permissions	GlobalPermissions	Sets the persmissions for the Action	No
properties	CurrentSpaceActionCustomProperties	Sets the persmissions for the Action	Yes

CurrentSpaceActionCustomProperties

List of custom actions

Name	Type	Description	Required
CurrentSpaceActionCustomProperties	array	List of custom actions

CurrentSpaceActionCustomProperty

Custom Action Property

Name	Type	Description	Required
dataIndex	GlobalDataIndex	Sets dataIndex of Action	Yes
encoding	GlobalEncoding	Sets the encoding. We currently support the following encoding: base64	No
label	GlobalLabel	Sets type of Action	Yes
type	GlobalLinkType	Sets attributes for the link	Yes

CurrentSpaceActions

List of available actions.

Name	Type	Description	Required
Assign	CurrentSpaceAction	When 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
Claim	CurrentSpaceAction	When clicked it assigns the current Txn to the current user.	No
Custom	CurrentSpaceActionCustom	Allows configured custom actions to be displayed in a dropdown.	No
Decision	CurrentSpaceAction	When clicked it opens up a modal with the current Txn formUrl + &pageId=decision.	No
Receipt	CurrentSpaceAction	Shows 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
Recover	CurrentSpaceAction	When clicked the abandoned txn will be re-opened.	No
Release	CurrentSpaceAction	When clicked it unassigns the current Txn. This actions will be available only if the current user is the assignee.	No
Unassign	CurrentSpaceAction	When clicked it unassigns the current Txn. The difference with Release is that Unassign is available to all users.	No
ViewForm	CurrentSpaceAction	When clicked it opens up a modal with the current Txn formUrl + &pageId=view.	No
Withdraw	CurrentSpaceAction	When clicked saved txn will be abandoned.	No

CurrentSpaceAttachments

Name	Type	Description	Required
duplicates	CurrentSpaceAttachmentsDuplicates	Set duplicates to show or hide.	No
filter	CurrentSpaceAttachmentsFilter	Set filter for the attachments	No
uploadWithoutClaim	CurrentSpaceAttachmentsUploadWithoutClaim	Sets the persmissions for the Action.	No

CurrentSpaceAttachmentsDuplicates

Name	Type	Description	Required
CurrentSpaceAttachmentsDuplicates	boolean

CurrentSpaceAttachmentsFilter

Filter applied to attachments

Name	Type	Description	Required
action	string	Action for the filter. Possible values: include, exclude	Yes
regex	string	Regex 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 included	Yes

CurrentSpaceAttachmentsUploadWithoutClaim

Sets the persmissions for the Action.

Name	Type	Description	Required
CurrentSpaceAttachmentsUploadWithoutClaim	boolean	Sets the persmissions for the Action.

CurrentSpaceCreateForm

Show/Hide a global create form action

Name	Type	Description	Required
label	GlobalLabel	Sets the label	Yes
options	CurrentSpaceFormOptions	List of the forms to select from	Yes

CurrentSpaceCurrentView

View to display in the Txn Table section.

Default: [0]

Name	Type	Description	Required
CurrentSpaceCurrentView	string	View to display in the Txn Table section. Default: [0]

CurrentSpaceCustomCardContainerProperty

Name	Type	Description	Required
label	GlobalLabel	Sets label for the Custom Card	Yes
properties	[ CurrentSpaceCustomCardProperty ]	Mappings for the Custom Card	Yes

CurrentSpaceCustomCardList

Name	Type	Description	Required
dataSource	GlobalDataSource	Used to define a deep data source (It needs to be a JSON value).	No
icon	GlobalIcon	Sets icon for the Custom Card	No
label	GlobalLabel	Sets label for the Custom Card	Yes
properties		Mappings for the Custom Card	Yes
type	string	Sets the custom card type. Possible value: list	Yes

CurrentSpaceCustomCardListExtended

Name	Type	Description	Required
dataSource	GlobalDataSource	Used to define a deep data source (It needs to be a JSON value).	No
icon	GlobalIcon	Sets icon for the Custom Card	No
label	GlobalLabel	Sets label for the Custom Card	Yes
properties		Mappings for the Custom Card	Yes
statusColors	CurrentSpaceStatusColors	Status color config to be used in the ExtendedList card section. Default: null	Yes
type	string	Sets the custom card type, Possible value: listExtended	Yes

CurrentSpaceCustomCardListStacked

Name	Type	Description	Required
dataSource	GlobalDataSource	Used to define a deep data source (It needs to be a JSON value).	No
icon	GlobalIcon	Sets icon for the Custom Card	No
label	GlobalLabel	Sets label for the Custom Card	Yes
properties	[ CurrentSpaceCustomCardProperty ]	Mappings for the Custom Card	Yes
type	string	Sets the custom card type. Possible value: listStacked	Yes

CurrentSpaceCustomCardProperty

Name	Type	Description	Required
dataIndex	GlobalDataIndex	Sets the path of the Txn property to be displayed. Default: null	Yes
format	GlobalFormat	Sets a format for the data Possible values: relative, duration	No
fullWidth	GlobalFullWidth	Sets property display to full width Possible values: true	No
label	GlobalLabel	Sets the label to be used	Yes
link	GlobalLink	Sets attributes for the link	No
type	GlobalType	Sets property type. Possible values: date, text, number	Yes

CurrentSpaceCustomCardTable

Name	Type	Description	Required
dataSource	GlobalDataSource	Used to define a deep data source (It needs to be a JSON value).	Yes
icon	GlobalIcon	Sets icon for the Custom Card	No
label	GlobalLabel	Sets label for the Custom Card	Yes
properties	[ CurrentSpaceCustomCardProperty ]	Mappings for the Custom Card	Yes
type	string	Sets the custom card type. Possible value: table	Yes

CurrentSpaceCustomCardTableExtended

Name	Type	Description	Required
dataSource	GlobalDataSource	Used to define a deep data source (It needs to be a JSON value).	Yes
icon	GlobalIcon	Sets icon for the Custom Card	No
label	GlobalLabel	Sets label for the Custom Card	Yes
sections	CurrentSpaceSections	Sub-sections for the Custom Card	Yes
type	string	Sets the custom card type. Possible value: tableExtended	Yes

CurrentSpaceCustomCards

List of Custom Cards

Name	Type	Description	Required
CurrentSpaceCustomCards	array	List of Custom Cards

CurrentSpaceDateCreated

Show/Hide a global filter for Date Created

Name	Type	Description	Required
label	GlobalLabel	Sets a label for the filter. Default: null	Yes
value	[ ]	Sets a date range for the filter. Default: null	Yes

CurrentSpaceFilterBy

Sets the filters to apply to the view.

Default: null

Name	Type	Description	Required
CurrentSpaceFilterBy	object	Sets 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

Name	Type	Description	Required
label	GlobalLabel	Sets the label for the filter	Yes
options	CurrentSpaceFormOptions	List of the product types to select from	Yes
value	string	Sets the defaut option for the filter	Yes

CurrentSpaceFormOptions

List of products

Name	Type	Description	Required
CurrentSpaceFormOptions	array	List of products

CurrentSpaceGlobalActions

Global actions config

Default: null

Name	Type	Description	Required
CreateForm	CurrentSpaceCreateForm	Show/hide Create Form button.	Yes

CurrentSpaceGlobalFilters

Global filters config

Default: null

Name	Type	Description	Required
DateCreated	CurrentSpaceDateCreated	Show/Hide a global filter for Date Created	No
FormName	CurrentSpaceFormName	Used to show/hide the Create Forms button that allows Workspaces users to create new forms using Maestro forms	No
GroupName	CurrentSpaceGroupName	Show/Hide a global filter for Group Names	No

CurrentSpaceGroupName

Show/Hide a global filter for Group Names

Name	Type	Description	Required
label	GlobalLabel	Sets a label for the filter Default: null	Yes
options	CurrentSpaceGroupOptions	List of groups to select from Default: []	Yes
value	string	Sets the defaut option for the filter Default: null	Yes

CurrentSpaceGroupOptions

List of groups

Name	Type	Description	Required
CurrentSpaceGroupOptions	array	List of groups

CurrentSpaceKeyInfo

List of items displaying in the Key Info panel

Name	Type	Description	Required
CurrentSpaceKeyInfo	array	List of items displaying in the Key Info panel

CurrentSpaceProperty

Defines a mapping for use in the view.

Name	Type	Description	Required
columnWrap	GlobalColumnWrap	Sets the column content to not wrap. Possible Values: false	No
dataIndex	GlobalDataIndex	Sets the path of the Txn property to be displayed. Default: null	Yes
filter	GlobalFilter	Sets the filter strategy for this mapping. Possible values: input, select, multiselect, picker	No
format	GlobalFormat	Sets a format for the data Possible values: relative, duration	No
icon	GlobalIcon	Sets the icon to be used	No
label	GlobalLabel	Sets the label to be used	Yes
sorter	GlobalSorter	Sets the mapping to be sortable via the column header	No
type	GlobalType	Sets property type. Possible values: date, text, number	Yes

CurrentSpaceSections

Name	Type	Description	Required
CurrentSpaceSections	array

CurrentSpaceSortBy

The mapping key to sort by

Default: null

Name	Type	Description	Required
CurrentSpaceSortBy	string	The mapping key to sort by Default: null

CurrentSpaceSortOrder

Direction of the sort.

Possible values: asc, desc.

Default: asc

Name	Type	Description	Required
CurrentSpaceSortOrder	string	Direction of the sort. Possible values: asc, desc. Default: asc

CurrentSpaceStatusColors

Status color config to be used in the ExtendedList card section

Name	Type	Description	Required
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).

Name	Type	Description	Required
filterBy	CurrentSpaceFilterBy	Sets the filters to apply to the view Default: null	No
label	GlobalLabel	Text used as value and name of the view. Default: null	Yes
properties	CurrentSpaceViewProperties	List of Mapping Objects or Mapping keys. Default: null	Yes
sortBy	CurrentSpaceSortBy	The mapping key to sort by Default: null	No
sortOrder	CurrentSpaceSortOrder	Direction of the sort. Possible values: asc, desc. Default: asc	No

CurrentSpaceViewProperties

List of Mapping Objects or Mapping keys.

Default: null

Name	Type	Description	Required
CurrentSpaceViewProperties	array	List of Mapping Objects or Mapping keys. Default: null

CurrentSpaceViews

List of views

Name	Type	Description	Required
CurrentSpaceViews	array	List of views

GlobalColumnWrap

Sets the column content to not wrap.

Possible values: true/false

Name	Type	Description	Required
GlobalColumnWrap	boolean	Sets the column content to not wrap. Possible values: true/false

GlobalCustomCardType

Sets type for the Custom Card

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

Name	Type	Description	Required
GlobalCustomCardType	string	Sets type for the Custom Card Possible values: list, listStacked, listExtended, table, tableExtended

GlobalDataIndex

Sets the path of the Txn property to be displayed.

Name	Type	Description	Required
GlobalDataIndex		Sets the path of the Txn property to be displayed.

GlobalDataSource

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

Name	Type	Description	Required
GlobalDataSource	string	Used to define a deep data source (It needs to be a JSON value).

GlobalEncoding

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

Name	Type	Description	Required
GlobalEncoding	string	Sets the encoding. We currently support the following encoding: base64

GlobalFilter

Sets the filter strategy for this mapping.

Possible values: input, select, multiselect, picker

Name	Type	Description	Required
GlobalFilter		Sets the filter strategy for this mapping. Possible values: input, select, multiselect, picker

GlobalFilterOptionsInput

Name	Type	Description	Required
type	string	Sets the global filter type to input. Possible values: input	Yes

GlobalFilterOptionsPicker

Name	Type	Description	Required
options	object	Set the default date range for the date picker. Possible values: minDate, maxDate	No
type	string	Set the global filter type to be a date picker. Possible values: picker	Yes

GlobalFilterOptionsSelect

Name	Type	Description	Required
options	[ string ]	Sets the options for the select dropdown	No
type	string	Sets the global filter type Possible values: select, multiselect	Yes

GlobalFormat

Sets a format for the data

Possible values: relative, duration

Name	Type	Description	Required
GlobalFormat	string	Sets a format for the data Possible values: relative, duration

GlobalFullWidth

Sets property display to full width

Possible values: true

Name	Type	Description	Required
GlobalFullWidth	boolean	Sets property display to full width Possible values: true

GlobalHideSteps

List of steps to hide in the Timeline section.

Default: []

Name	Type	Description	Required
GlobalHideSteps	array	List of steps to hide in the Timeline section. Default: []

GlobalIcon

Sets the icon to be used

Name	Type	Description	Required
GlobalIcon	string	Sets the icon to be used. For a list of supported icons, see Icons.

GlobalLabel

Sets the label to be used

Name	Type	Description	Required
GlobalLabel	string	Sets the label to be used

GlobalLink

Name	Type	Description	Required
dataIndex	GlobalDataIndex	Sets the path of the Txn property to be displayed.	Yes
encoding	GlobalEncoding	Sets the encoding. We currently support the following encoding: base64	No
type	GlobalLinkType	Sets link type. Possible values: pdf, html, text, xml, json, url, file	Yes

GlobalLinkType

Sets link type.

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

Name	Type	Description	Required
GlobalLinkType	string	Sets link type. Possible values: pdf, html, text, xml, json, url, file

GlobalMapping

Name	Type	Description	Required
columnWrap	GlobalColumnWrap	Sets the column content to not wrap. Possible Values: true/false	No
dataIndex	GlobalDataIndex	Sets the path of the Txn property to be displayed	No
dataSource	GlobalDataSource	Used to define a deep data source (It needs to be a JSON value)	No
filter	GlobalFilter	Sets the filter strategy for this mapping. Possible values: input, select, multiselect, picker	No
format	GlobalFormat	Sets a format for the data. Possible values: relative, duration	No
fullWidth	GlobalFullWidth	Sets property display to full width Possible values: true	No
icon	GlobalIcon	Sets the icon	No
label	GlobalLabel	Sets the label	Yes
link	GlobalLink	Sets attributes for the link	No
properties	GlobalMappingProperties	List of Mapping Objects or Mapping keys Default: null	No
sections	CurrentSpaceSections	Status color config to be used in the ExtendedList card section Default: null	No
sorter	GlobalSorter	Sets the mapping to be sortable via the column header	No
statusColors	CurrentSpaceStatusColors	Status color config to be used in the ExtendedList card section Default: null	No
type		Sets type for the property Possible values: text, date, number, alert, time, list, listExtended, table, tableExtended	Yes
warning	GlobalWarning	Sets warning timeframe for the SLA	No

GlobalMappingProperties

Name	Type	Description	Required
GlobalMappingProperties	array

GlobalMappingProperty

Name	Type	Description	Required
columnWrap	GlobalColumnWrap	Sets the column content to not wrap. Possible Values: true/false	No
dataIndex	GlobalDataIndex	Sets the path of the Txn property to be displayed	No
filter	GlobalFilter	Sets the filter strategy for this mapping. Possible values: input, select, multiselect, picker	No
format	GlobalFormat	Sets a format for the data. Possible values: relative, duration	No
fullWidth	GlobalFullWidth	Sets property display to full width Possible values: true	No
label	GlobalLabel	Sets the label	Yes
link	GlobalLink	Sets attributes for the link	No
properties	GlobalMappingProperties	List of Mapping Objects or Mapping keys Default: null	No
sorter	GlobalSorter	Sets the mapping to be sortable via the column header	No
type		Sets type for the property Possible values: text, date, number, alert, time, list, listExtended, table, tableExtended	No
warning	GlobalWarning	Sets warning timeframe for the SLA	No

GlobalMappings

Mappings config to be used globally.

Default: null

Name	Type	Description	Required
GlobalMappings	object	Mappings config to be used globally. Default: null

GlobalPermissions

Sets permissions for spaces or actions.

Name	Type	Description	Required
type	GlobalPermissionsType	Sets permission type. Possible values: group, role	Yes
value	[ string ]	Sets values depending on the permission	Yes

GlobalPermissionsType

Name	Type	Description	Required
GlobalPermissionsType	string

GlobalSorter

Sets the sorter to be used

Name	Type	Description	Required
GlobalSorter	boolean	Sets the sorter to be used

GlobalSpace

Name	Type	Description	Required
icon	GlobalIcon	Sets the icon to be used	Yes
label	GlobalLabel	Sets the label to be used	Yes
permissions	GlobalPermissions	Sets the permissions for the Space	No
value	string	Sets the name of the Space	Yes

GlobalSpaces

List of Spaces

Name	Type	Description	Required
GlobalSpaces	array	List of Spaces

GlobalTheme

Theme config to be used globally.

Name	Type	Description	Required
accent	GlobalThemeProperty	Global theme accent color. Possible values: main	No
black	string	Global theme color	No
blue	GlobalThemeProperty	Global theme color. Possible values: main, light	No
green	string	Global theme color	No
grey	GlobalThemeProperty	Global theme color. Possible values: background, keyline	No
lightGreen	string	Global theme color	No
orange	string	Global theme color	No
primary	GlobalThemeProperty	Global theme primary color. Possible values: main	No
red	GlobalThemeProperty	Global theme color. Possible values: main, light	No
text	GlobalThemeProperty	Global theme color. Possible values: dark, light	No
white	string	Global theme color	No

GlobalThemeProperty

Global theme property

Name	Type	Description	Required
background	string	Global theme color variation	No
dark	string	Global theme color variation	No
keyline	string	Global theme color variation	No
light	string	Global theme color variation	No
main	string	Global theme color variation	No

GlobalType

Sets property type.

Possible values: date, text, number, alert

Name	Type	Description	Required
GlobalType	string	Sets property type. Possible values: date, text, number, alert

GlobalWarning

Sets warning timeframe for the SLA

Name	Type	Description	Required
GlobalWarning	string	Sets warning timeframe for the SLA