Common models

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

PredicateRows

Array<DynamicPredicateRow>

A row for each column to be filtered on.

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.

“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

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.

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.

Category

String

The Job Group Category.

Group

String

The Job Group Code.

Key

AttributeKey

The unique key for the line.

Category

String

The Job Group Category of the Attribute.

CategoryValue

CellData

The Job Group Category of the Attribute.

Group

String

The Job Group of the Attribute.

GroupValue

CellData

The Job Group of the Attribute.

Value

CellData

The value of the Attribute.

ToDoNoteId

Integer

The unique ID of the Note.

KeyTable

String

The type of the document this Note belongs to.

Key

NoteKey

The unique key for the line.

Description

String

The description on the Note.

DescriptionValue

CellData

The description on the Note.

Details

String

The details on the Note.

DetailsValue

CellData

The details on the Note.

NoteTypeId

Integer

The ID of the Note Type.

NoteType

String

The description of the Note Type.

NoteTypeValue

CellData

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

CellData

The Person who created this Note.

CreatedDate

DateTime

The date this Note was created.

CreatedDateValue

CellData

The date this Note was created.

KeyTable

String

The type of the document this Note belongs to.

EntityValue

CellData

The type of the document this Note belongs to.

EntityDescription

String

The description of the document this Note belongs to.

EntityDescriptionValue

CellData

The description of the document this Note belongs to.

ToDoNoteId

Integer

The unique ID of the To Do Item.

KeyTable

String

The type of the document this To Do Item belongs to.

Key

ToDoKey

The unique key for the line.

Description

String

The description on the To Do Note.

DescriptionValue

CellData

The description on the To Do Note.

Details

String

The details on the To Do Note.

DetailsValue

CellData

The details on the To Do Note.

NoteTypeId

Integer

The ID of the Note Type.

NoteType

String

The description of the Note Type.

NoteTypeValue

CellData

The Note Type.

NoteStatusId

Integer

The ID of the To Do Note Status.

NoteStatus

String

The description of the To Do Note Status.

NoteStatusValue

CellData

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

CellData

The Person who is assigned this To Do Note.

KeyTable

String

The type of the document this To Do Note belongs to.

EntityValue

CellData

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

CellData

The description of the document this To Do Note belongs to.

DoByDate

DateTime

The Do By Date on the To Do Note.

DoByDateValue

CellData

The Do By Date on the To Do Note.

Completed

Boolean

The Completed flag on the To Do Note.

CompletedValue

CellData

The Completed flag on the To Do Note.

CreatedById

Integer

The ID of the Person who created this To Do Note.

successMessage

String

The success message if the save was successful.

warningMessage

String

A possible warning message if the save was successful.

errorMessage

String

The error message if the save was unsuccessful.

validationErrors

Array<MvcValidationError>

A list of specific validation errors if the save was unsuccessful.

KeyStr

String

Some endpoints will return additional context relating to the updated document.

KeyDate

String

KeyInt

Integer

n

String

The name of the field with a validation error.

m

String

The validation error message.