Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
Anchor | ||||
---|---|---|---|---|
|
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 Common models 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 format ("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. |
⬆️ Back to top
Filter Models
The Common models used in requests to Workbench List endpoints for filtering and sorting data from Workbench list API.
GridRequestParameters
Field | Type | Description |
---|---|---|
Sidx | String | The field that the data will be sorted on. |
SordSort | 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 | 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 | 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 |
⬆️ Back to top
Grid Models
CellDataCommon models in responses from Workbench List endpoints for filtered data.
GridResult
Field | Type | Description |
---|
records |
CellValue
CellNumValue
CellBoolValue
CellTag
CellValueDate
CellValueInt
ColModel
Field
Type
Description
Required
Boolean
Name
String
Title
String
Index
String
ShowGroupingHeader
Boolean
Hidden
Boolean
Editable
Boolean
IsNumeric
Boolean
IsCenteredText
Boolean
LabelClasses
String
Resizable
Boolean
Format
Integer
FormatWidth
Integer
DateWidthSpecified
Boolean
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. |
⬆️ Back to top
Line Models
Common line models shared by the Company, Job, and People endpoints.
AttributeKey
Field | Type | Description |
---|
Category |
Integer
DatasheetTemplateId
Integer
String | The Job Group Category. |
Group | String |
KeyInt
Integer
DatasheetsDatasheetModelLine
The Job Group Code. |
AttributeLine
Field | Type | Description |
---|
Key |
CellData
Template
CellData
The unique key for the line. | |
Category | String |
Name
String
KeyTable
String
Subject
String
Rating
Number
Complete
Boolean
JSON
String
Status
String
ReadonlyFlag
Integer
ReadonlyMessage
String
OriginalKey
DatasheetsDatasheetKey
CurrentKey
DatasheetsDatasheetKey
Key
DatasheetsDatasheetKey
Index
Integer
ExtensionFieldsViewData
The Job Group Category of the Attribute. | ||
CategoryValue | The Job Group Category of the Attribute. | |
Group | String | The Job Group of the Attribute. |
GroupValue | The Job Group of the Attribute. | |
Value | The value of the Attribute. |
NoteKey
Field | Type | Description |
---|
Fields
Array [FieldViewData]
Form
Object
Disabled
Boolean
Name
String
Visible
Boolean
Required
Boolean
InfoText
InfoText
ToDoNoteId | Integer | The unique ID of the Note. |
KeyTable | String | The type of the document this Note belongs to. |
NoteLine
Field | Type | Description |
---|
Key |
String
Value
String
GeneralAddressLine
Field
Type
Description
Title
String
Company name
Name
String
Address name.
Line1
String
Street line 1 information
Line2
String
Street line 2 information
CompanyId
Integer
Code of the company.
Company
String
Company name
Inactive
Boolean
Status
IsPostalAddress
Boolean
This is a Post address or not.
IsPhysicalAddress
Boolean
This is a physical address or not.
String
Email address.
Phone
String
Phone number.
PostCode
String
Post code.
Select
TitleValue
NameValue
Line1Value
Address line 1.
Line2Value
Address line 2.
CompanyValue
Company name.
EmailValue
Email address.
PhoneValue
Phone number.
PostCodeValue
Post code.
HasMore
Delete
Status
String
Status.
ReadonlyFlag
Integer
Marked as Read Only.
ReadonlyMessage
String
OriginalKey
GeneralAddressKey
CurrentKey
GeneralAddressKey
Key
GeneralAddressKey
Index
Integer
GeneralAttributeKey
Field
Type
Description
Category
Group
GeneralAttributeLine
Field
Type
Description
Category
Group
CategoryValue
GroupValue
Value
Delete
Status
ReadonlyFlag
Read Only status.
ReadonlyMessage
String
Read Only message.
OriginalKey
CurrentKey
Key
Index
GeneralExtensionFields
Field
Type
Description
Fields
Array [FieldViewData]
ReturnFields
Array [FormItem]
GeneralNoteKey
Field
Type
Description
ToDoNoteId
KeyTable
GridId
GeneralNoteLine
Field
Type
Description
Description
Details
NoteTypeId
NoteType
CreatedById
CreatedBy
CreatedDate
KeyTable
EntityDescription
Select
DescriptionValue
DetailsValue
NoteTypeValue
CreatedByValue
CreatedDateValue
EntityValue
EntityDescriptionValue
Delete
Status
ReadonlyFlag
ReadonlyMessage
OriginalKey
CurrentKey
Key
Index
GeneralToDoKey
Field
Type
Description
ToDoNoteId
KeyTable
GeneralToDoLine
Field
Type
Description
Details
NoteTypeId
NoteType
NoteStatusId
NoteStatus
DoById
CreatedByID
DoBy
KeyTable
EntityDescription
DoByDate
Completed
Select
DescriptionValue
DetailsValue
NoteTypeValue
NoteStatusValue
DoByValue
EntityValue
EntityDescriptionValue
DoByDateValue
CompletedValue
Delete
Status
ReadonlyFlag
ReadonlyMessage
OriginalKey
CurrentKey
Key
Index
GridModel
Field
Type
Description
GridId
String
ColModel
Array [ColModel]
NewRowPosition
String
UpdateColumnEditable
Boolean
Hidden
Boolean
GridResult
Field
Type
Description
total
page
records
rows
form
widgets
HeaderColumnViewData
Field
Type
Description
ColumnNo
Integer
Headers
Array [FieldViewData]
HeaderViewData
Field
Type
Description
Headers
Array [FieldViewData]
Columns
Array [HeaderColumnViewData]
KeyValuePair
Field
Type
Description
Key
String
Value
String
Layout
Field
Type
Description
Caption
String
MvcValidationError
Field
Type
Description
n
String
m
String
The unique key for the line. | ||
Description | String | The description on the Note. |
DescriptionValue | The description on the Note. | |
Details | String | The details on the Note. |
DetailsValue | The details on the Note. | |
NoteTypeId | Integer | The ID of the Note Type. |
NoteType | String | The description of the Note Type. |
NoteTypeValue | The Note Type. | |
CreatedById | Integer | The ID of the Person who created this Note. |
CreatedBy | String | The name of the Person who created this Note. |
CreatedByValue | The Person who created this Note. | |
CreatedDate | DateTime | The date this Note was created. |
CreatedDateValue | The date this Note was created. | |
KeyTable | String | The type of the document this Note belongs to. |
EntityValue | The type of the document this Note belongs to. | |
EntityDescription | String | The description of the document this Note belongs to. |
EntityDescriptionValue | The description of the document this Note belongs to. |
ToDoKey
Field | Type | Description |
---|---|---|
ToDoNoteId | Integer | The unique ID of the To Do Item. |
KeyTable | String | The type of the document this To Do Item belongs to. |
ToDoLine
Field | Type | Description |
---|---|---|
Key | The unique key for the line. | |
Description | String | The description on the To Do Note. |
DescriptionValue | The description on the To Do Note. | |
Details | String | The details on the To Do Note. |
DetailsValue | The details on the To Do Note. | |
NoteTypeId | Integer | The ID of the Note Type. |
NoteType | String | The description of the Note Type. |
NoteTypeValue | The Note Type. | |
NoteStatusId | Integer | The ID of the To Do Note Status. |
NoteStatus | String | The description of the To Do Note Status. |
NoteStatusValue | The To Do Note Status. | |
DoById | Integer | The ID of the Person who is assigned this To Do Note. |
DoBy | String | The name of the Person who is assigned this To Do Note. |
DoByValue | The Person who is assigned this To Do Note. | |
KeyTable | String | The type of the document this To Do Note belongs to. |
EntityValue | The type of the document this To Do Note belongs to. | |
EntityDescription | String | The description of the document this To Do Note belongs to. |
EntityDescriptionValue | The description of the document this To Do Note belongs to. | |
DoByDate | DateTime | The Do By Date on the To Do Note. |
DoByDateValue | The Do By Date on the To Do Note. | |
Completed | Boolean | The Completed flag on the To Do Note. |
CompletedValue | The Completed flag on the To Do Note. | |
CreatedById | Integer | The ID of the Person who created this To Do Note. |
⬆️ Back to top
Update Models
Common models in responses from Workbench Detail endpoints to save data.
SaveResult
StoredFilesApiModel
Field
Type
Description
Key
StoredFilesApiKey
RelatedRecord
String
RelatedRecordId
String
FileGroupId
Integer
Details
String
FileName
String
Url
String
ImageDocument
Boolean
SecondaryPath
String
KeyStr
String
Field | Type | Description | |||
---|---|---|---|---|---|
successMessage | String | Successful messageThe success message if the save was successful. | |||
warningMessage | String | Wanning messageA possible warning message if the save was successful. | |||
errorMessage | String | Error messageThe error message if the save was unsuccessful. | |||
validationErrors | Array [MvcValidationError]Array<MvcValidationError> | A list of specific validation errors if the save was unsuccessful. | |||
KeyStr | String | KeyDate | String | KeyInt | Integer |
StoredFilesApiKey
Field
Type
Description
StoredFileId
Integer
Some endpoints will return additional context relating to the updated document. | |
KeyDate | String |
KeyInt | Integer |
MvcValidationError
Field | Type | Description |
---|
SerialNo
SerialNoSelect
SerialNoSelect
BatchNoSelect
ExpiryDate
String
SerialDetails
Quantity
TransDetails
Delete
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
WebEAVGridLine
Field
Type
Description
WBNodeId
Col00
Col01
Col02
Col03
Col04
Col05
Col06
Col07
Col08
Col09
Col10
Col11
Col12
Col13
Col14
Col15
Col16
Col17
Col18
Col19
Col20
Col21
Col22
Col23
Col24
Col25
Col26
Col27
Col28
Col29
RowId
Delete
Status
String
ReadonlyFlag
Integer
ReadonlyMessage
String
OriginalKey
CurrentKey
Key
Index
n | String | The name of the field with a validation error. |
m | String | The validation error message. |
⬆️ Back to top
On this page
Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|