Common functions

Overview

This page serves as a central hub where you can find detailed descriptions of common models used repeatedly across various Workbench APIs.

Form Models

The various field types found on Workbench forms.

BoolViewData

Field	Type	Description
BoolValue	Boolean	The boolean value of the field.
Name	String	The name of the field.
Disabled	Boolean	A flag to indicate if the field is editable.
Required	Boolean	A flag to indicate if the field is required.

DateViewData

Field	Type	Description
DateValue	String	The date value of the field, as an ISO 8601 formatted string ("YYYY-MM-DDT00:00:00Z").
Name	String	The name of the field.
Disabled	Boolean	A flag to indicate if the field is editable.
Required	Boolean	A flag to indicate if the field is required.

DecimalViewData

Field	Type	Description
DecimalValue	Number	The decimal value of the field.
Name	String	The name of the field.
Disabled	Boolean	A flag to indicate if the field is editable.
Required	Boolean	A flag to indicate if the field is required.

DropdownViewData

Field	Type	Description
SelectedValue	String	The selected value of the field.
Name	String	The name of the field.
Disabled	Boolean	A flag to indicate if the field is editable.
Required	Boolean	A flag to indicate if the field is required.

FileAttachmentsViewData

Field	Type	Description
RelatedRecordID	String	The ID of this document. Used when uploading files to the StoredFilesApi endpoint.
RelatedRecord	String	The type of this document. Used when uploading files to the StoredFilesApi endpoint.
Disabled	Boolean	A flag to indicate if the field is editable.
Required	Boolean	A flag to indicate if the field is required.

MultiPickerViewData

Field	Type	Description
StringValue	String	A comma-delimited list of the selected value of the field.
Name	String	The name of the field.
Disabled	Boolean	A flag to indicate if the field is editable.
Required	Boolean	A flag to indicate if the field is required.

OptionsViewData

Field	Type	Description
SelectedOption	String	The selected option of the field.
Name	String	The name of the field.
Disabled	Boolean	A flag to indicate if the field is editable.
Required	Boolean	A flag to indicate if the field is required.

PercentageViewData

Field	Type	Description
DecimalValue	Number	The decimal value of the field, representing a percentage.
Name	String	The name of the field.
Disabled	Boolean	A flag to indicate if the field is editable.
Required	Boolean	A flag to indicate if the field is required.

PickerViewData

Field	Type	Description
SelectedValue	String	The selected value of the field.
SelectedText	String	A description of the selected value of the field (read-only).
Name	String	The name of the field.
Disabled	Boolean	A flag to indicate if the field is editable.
Required	Boolean	A flag to indicate if the field is required.

StringViewData

Field	Type	Description
StringValue	String	The string value of the field.
Name	String	The name of the field.
Disabled	Boolean	A flag to indicate if the field is editable.
Required	Boolean	A flag to indicate if the field is required.

TimeViewData

Field	Type	Description
TimeValue	String	The time value of the field, as a formatted string ("hh:mm:ss").
Is24H	Boolean	24h format
Name	String	The name of the field.
Disabled	Boolean	A flag to indicate if the field is editable.
Required	Boolean	A flag to indicate if the field is required.

Filter Models

The models used for filtering and sorting data from Workbench list API.

GridRequestParameters

Field	Type	Description
Sidx	String	The field that the data will be sorted on.
Sord	String	The sort order (“asc”, or “desc”).
Page	Integer	The specific page to be retrieved.
Rows	Integer	The number of records returned per page.
Predicate	DynamicPredicate	The filter to apply to the data.
Jobcode	String	Some list API endpoints will accept additional context to filter the data by.
finCode	String
functionalCode	String
IntValue	Integer
StringValue	String
BoolValue	Boolean
DateValue	Date

DynamicPredicate

Field	Type	Description
PredicateRows	Array<DynamicPredicateRow>	A row for each column to be filtered on.

DynamicPredicateRow

Field	Type	Description
LeftOperand	String	The name of the field to be filtered
Operator	Operator	The operator to apply to the filtered field.
RightOperand	Array<String>	The value(s) to filter the field by.

Operator

Value	Right Operands Required	Description
“Lt“	1	Less than the first item of the Right Operand.
“Gt“	1	Greater than the first item of the Right Operand.
“Eq“	1	Equal to the first item of the Right Operand.
“Ne“	1	Not equal to the first item of the Right Operand.
“Le”	1	Less than or equal to the first item of the Right Operand.
“Ge”	1	Greater than or equal to the first item of the Right Operand.
“Like”	1	Contains the first item of the Right Operand.
“IsOneOf”	Multiple	Is equal to any item in the Right Operand.
“IsNotOneOf”	Multiple	Is not equal to any item in the Right Operand.
“Between”	2	Between the first 2 items in the Right Operand.
“StartsWith”	1	Starts with the first item in the Right Operand.
“StartsWithIsOneOf”	Multiple	Starts with any item in the Right Operand

Grid Models

The structure of data returned by requests to Workbench List API.

GridResult

Field	Type	Description
records	Integer	The total number of records in the filtered dataset.
total	Integer	The total number of pages in the filtered dataset.
page	Integer	The specific page requested and retrieved.
rows	Array<T>	The page of filtered data.

CellData

Field	Type	Description
CellId	String	The ID of the value of the field.
CellValue	String	The text value of the field.
CellNumValue	Decimal	The decimal value of the field.
CellBoolValue	Boolean	The boolean value of the field.
CellValueDate	Date	The data value of the field.
CellValueInt	Integer	the integer value of the field.

SaveResult

Field	Type	Description
successMessage	String	Successful message.
warningMessage	String	Wanning message.
errorMessage	String	Error message.
validationErrors	Array [MvcValidationError]
KeyStr	String
KeyDate	String
KeyInt	Integer

MvcValidationError

Field	Type	Description
n	String
m	String

StoredFilesApiKey

Field	Type	Description
StoredFileId	Integer

StoredFilesApiModel

Field	Type	Description
Key	StoredFilesApiKey
RelatedRecord	String
RelatedRecordId	String
FileGroupId	Integer
Details	String
FileName	String
Url	String
ImageDocument	Boolean
SecondaryPath	String
KeyStr	String
KeyDate	String
KeyInt	Integer

TabletSerialLine

Field	Type	Description
SerialNo	CellData
SerialNoSelect	CellData
SerialNoSelect	CellData
BatchNoSelect	CellData
ExpiryDate	String
SerialDetails	CellData
Quantity	CellData
TransDetails	CellData
Delete	CellData
Status	String
ReadonlyFlag	Integer
ReadonlyMessage	String
OriginalKey	TabletSerialLineKey
CurrentKey	TabletSerialLineKey
Key	TabletSerialLineKey
Index	Integer

TabletSerialLineKey

Field	Type	Description
SNID	Integer
SNTranID	Integer

Tuple_String

Field	Type	Description
Item1	String
Item2	String

ViewData_GridWidget

Field	Type	Description
WidgetId
LayoutCode
Name
Colour
BGColour
Icon
Type
Visible
Order
Count
WidgetLines

ViewData_GridWidgetLine

Field	Type	Description
WidgetLineId
WidgetId
Name
Predicate
Order
Count

⬆️ Back to top

On this page

Resource

Support