System / settings.

Owned by Bao TRINH
Last updated: Aug 06, 2024 by Cam Mackay
2 min read

Endpoints

ControlParametersApi

[Description]

/api/ControlParametersApi

/api/ControlParametersApi

Operation

Logged in User

Parameters

Body

Response

GET

 

 

 

 

 

DataImportDetailApi

[Description]

/api/DataImportDetailApi

/api/DataImportDetailApi

Operation

Logged in User

Parameters

Body

Response

GET
Retrieves an Import Header and details.

 

importId

 

 

POST
Imports a stored file based on an import header configuration.

 

 

 

 

 

DataImportListApi

[Description]

/api/DataImportListApi

/api/DataImportListApi

Operation

Logged in User

Parameters

Body

Response

POST
Returns all Workbench Import Headers

 

 

 

 

 

GridManagementApi

[Description]

/api/GridManagementApi

/api/GridManagementApi

Operation

Logged in User

Parameters

Body

Response

DELETE

 

key*

 

 

GET

 

layoutname

 

 

POST

 

 

 

 

 

ScaffoldDetailApi

[Description]

/api/ScaffoldDetailApi

/api/ScaffoldDetailApi

Operation

Logged in User

Parameters

Body

Response

DELETE
Delete records in database by Name - table name, KeyName - column name one, KeyName1 - column name two (optional)

 

 

 

 

GET
Name - table name, KeyName - PK Column name, IntId - Pk value, StringId - Pk value. Order for kEy fields is important, should be as per database

 

stringId
intId
dateId
stringId1
intId1
dateId1
name
keyName
keyName1
sortDesc

 

 

POST
Update records in database by Name - table name, KeyName - column name, IntId - PK Value, StringId - PK Value

 

 

 

 

PULL
create new records in database by Name - table name, KeyName - column name. Return field contains IntId - PK Value, StringId - PK Value

 

 

 

 


ScaffoldLiteApi

[Description]

/api/ScaffoldLiteApi

/api/ScaffoldLiteApi

Operation

Logged in User

Parameters

Body

Response

DELETE
Delete records in database by Name - table name, KeyName - column name one, KeyName1 - column name two (optional). Return field contains IntId - PK Value, StringId - PK Value

 

 

 

 

GET
Name - table name, KeyName - PK Column name, IntId - Pk value, StringId - Pk value. Order for kEy fields is important, should be as per database

 

stringId
intId
dateId
stringId1
intId1
dateId1
name
keyName
keyName1
sortDesc

 

 

POST
Update records in database by Name - table name, KeyName - column name, IntId - PK Value, StringId - PK Value. Uses 'Key' property to find data for update

 

 

 

 

PUT
Allows you to create new records in database by Name - table name, KeyName - column name. Return field contains IntId - PK Value, StringId - PK Value

 

 

 

 


ScaffoldListApi

[Description]

/api/ScaffoldListApi

/api/ScaffoldListApi

Operation

Logged in User

Parameters

Body

Response

POST
Return list of records

 

 

 

 

 

SiteMapApi

[Description]

/api/SiteMapApi

/api/SiteMapApi

Operation

Logged in User

Parameters

Body

Response

GET
Retrieves site maps for the logged in user. Only works with Basic authentication.

 

 

 

 

 

TableApi

[Description]

ColumnNames property, which is a comma delimited list of columns that you want in the response 

/api/TableApi

/api/TableApi

Operation

Logged in User

Parameters

Body

Response

POST
Returns list of Records from a table

 

 

 

 

 

TableRowApi

[Description]

/api/TableRowApi

/api/TableRowApi

Operation

Logged in User

Parameters

Body

Response

DELETE
Delete records in database.

 

 

 

 

GET

 

tableName
keyName
keyValue
columnNames

 

 

POST
Update records in database.

 

 

 

 

PUT
Create new records in database.

 

 

 

 

Models

 

AdminImportLineFields

Property

Data Type

Description

Property

Data Type

Description

ImportId

Integer

 

StoredFileId

Integer

 

BatchTypeEnum

String

 

ImportProcedure

StringViewData

 

ImportParameter

StringViewData

 

Batch

PickerViewData

Batch

Period

StringViewData

Financial period.

BatchType

StringViewData

Batch type.

BatchDate

StringViewData

Batch date.

ImportFile

FileViewData

 

FirstLineHeading

BoolViewData

 

Delimeter

DropdownViewData

 

FileExtension

DropdownViewData

 

TabName

StringViewData

 

Details

StringViewData

 

SecurityGroup

PickerViewData

 

Back to top

 

AdminImportHeaderKey

Property

Data Type

Description

Property

Data Type

Description

ImportId

Integer

 

Back to top

 

AdminImportHeaderLine

Property

Data Type

Description

Property

Data Type

Description

Details

String

 

Description

String

 

ImportProcedure

String

 

DetailsValue

CellData

 

DescriptionValue

CellData

 

Status

String

 

ReadonlyFlag

Integer

 

ReadonlyMessage

String

 

OriginalKey

AdminImportHeaderKey

 

CurrentKey

AdminImportHeaderKey

 

Key

AdminImportHeaderKey

 

Index

Integer

 

Back to top

 

DataImportApiModel

Property

Data Type

Description

Property

Data Type

Description

Key

AdminImportHeaderKey

 

Fields

AdminImportLineFields

 

Back to top

 

GridModel

Field

Type

Description

Field

Type

Description

GridId

String

 

ColModel

Array [ColModel]

 

NewRowPosition

String

 

UpdateColumnEditable

Boolean

 

Hidden

Boolean

 

ColModel

Field

Type

Description

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

 

 

ExtensionFieldsViewData

Field

Type

Description

Field

Type

Description

Fields

Array [FieldViewData]

 

Form

Object

 

Disabled

Boolean

 

Name

String

 

Visible

Boolean

 

Required

Boolean

 

InfoText

InfoText

 

 

FormItem

Field

Type

Description

Field

Type

Description

Name

String

 

Value

String

 

 

GeneralAddressLine

Field

Type

Description

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.

Email

String

Email address.

Phone

String

Phone number.

PostCode

String

Post code.

Select

CellData

 

TitleValue

CellData

 

NameValue

CellData

 

Line1Value

CellData

Address line 1.

Line2Value

CellData

Address line 2.

CompanyValue

CellData

Company name.

EmailValue

CellData

Email address.

PhoneValue

CellData

Phone number.

PostCodeValue

CellData

Post code.

HasMore

CellData

 

Delete

CellData

 

Status

String

Status.

ReadonlyFlag

Integer

Marked as Read Only.

ReadonlyMessage

String

 

OriginalKey

GeneralAddressKey

 

CurrentKey

GeneralAddressKey

 

Key

GeneralAddressKey

 

Index

Integer

 

 

GeneralAttributeKey

Field

Type

Description

Field

Type

Description

Category

 

 

Group

 

 

 

GeneralAttributeLine

Field

Type

Description

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

Field

Type

Description

Fields

 

Array [FieldViewData]

ReturnFields

 

Array [FormItem]

GeneralNoteKey

Field

Type

Description

Field

Type

Description

ToDoNoteId

 

 

KeyTable

 

 

GridId

 

 

 

GeneralNoteLine

Field

Type

Description

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

Field

Type

Description

ToDoNoteId

 

 

KeyTable

 

 

 

GeneralToDoLine

Field

Type

Description

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

 

 

 

 

ControlParameterApiModel

Property

Data Type

Description

Property

Data Type

Description

Week1EndDate

String

 

WeekEndingDayNumber

Integer

 

TimeUnitsPerHour

Integer

 

Back to top

 

ScaffoldTableDataKey

Property

Data Type

Description

Property

Data Type

Description

StringId

String

 

IntId

Integer

 

DateId

String

 

StringId1

String

 

IntId1

Integer

 

DateId1

String

 

Name

String

 

KeyName

String

 

KeyName1

String

 

SortDesc

Boolean

 

Back to top

 

ScaffoldTableDataLine

Property

Data Type

Description

Property

Data Type

Description

Col##

CellDate

Column numbers with values ranging from 01 to 99. One column number on each line

Delete

CellDate

 

Status

String

 

ReadonlyFlag

Integer

 

ReadonlyMessage

String

 

OriginalKey

ScaffoldTableDataKey

 

CurrentKey

ScaffoldTableDataKey

 

Key

ScaffoldTableDataKey

 

Index

Integer

 

Back to top

 

ScaffoldTableDataLite

Property

Data Type

Description

Property

Data Type

Description

Name01

String

 

Value01

String

 

Name02

String

 

Value02

String

 

Name03

String

 

Value03

String

 

Name04

String

 

Value04

String

 

Name05

String

 

Value05

String

 

Name06

String

 

Value06

String

 

Name07

String

 

Value07

String

 

Name08

String

 

Value08

String

 

Name09

String

 

Value09

String

 

Name10

String

 

Value10

String

 

Key

ScaffoldTableDataKey

 

Back to top

 

SiteMapApiModel

Property

Data Type

Description

Property

Data Type

Description

SiteMapID

Integer

 

ParentSiteMapID

Integer

 

Name

String

 

Controller

String

 

Action

String

 

Area

String

 

Back to top

 

SiteMapProfileApiModel

Property

Data Type

Description

Property

Data Type

Description

SiteMapProfileID

Integer

 

Name

String

 

Description

String

 

SiteMaps

Array [SiteMapApiModel]

 

Back to top

 

TableApiKey

Property

Data Type

Description

Property

Data Type

Description

TableName

String

 

KeyName

String

 

KeyValue

String

 

ColumnNames

String

 

Back to top

 

TableApiResponse

Property

Data Type

Description

Property

Data Type

Description

Key

TableApiKey

 

Col##

String

Col01 to Col40

Tag##

String

Tag01 to Tag 40

Back to top

Example

%title

Request

Response

Response sample

Top of page