Versions Compared

Old Version 2

changes.mady.by.user Bao TRINH

Saved on

compared with

New Version 3

changes.mady.by.user Bao TRINH

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Endpoints

ControlParametersApi

[Description]

/api/ControlParametersApi

Operation

Logged in User

Parameters

Body

Response

GET

DataImportDetailApi

[Description]

/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

Operation

Logged in User

Parameters

Body

Response

POST
Returns all Workbench Import Headers

GridManagementApi

[Description]

/api/GridManagementApi

Operation

Logged in User

Parameters

Body

Response

DELETE

key*

GET

layoutname

POST

ScaffoldDetailApi

[Description]

/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

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

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

Operation

Logged in User

Parameters

Body

Response

POST
Return list of records

SiteMapApi

[Description]

/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]

/api/TableApi

Operation

Logged in User

Parameters

Body

Response

POST
Returns list of Records from a table

TableRowApi

[Description]

/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

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

ImportId

Integer

⬆️ Back to top

AdminImportHeaderLine

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

Key

AdminImportHeaderKey

Fields

AdminImportLineFields

⬆️ Back to top

ControlParameterApiModel

Property

Data Type

Description

Week1EndDate

String

WeekEndingDayNumber

Integer

TimeUnitsPerHour

Integer

⬆️ Back to top

ScaffoldTableDataKey

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

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

SiteMapApiModel

Property

Data Type

Description

SiteMapID

Integer

ParentSiteMapID

Integer

Name

String

Controller

String

Action

String

Area

String

⬆️ Back to top

SiteMapProfileApiModel

Property

Data Type

Description

SiteMapProfileID

Integer

Name

String

Description

String

SiteMaps

Array [SiteMapApiModel]

⬆️ Back to top

TableApiKey

Property

Data Type

Description

TableName

String

KeyName

String

KeyValue

String

ColumnNames

String

⬆️ Back to top

TableApiResponse

Property

Data Type

Description

Key

TableApiKey

Col##

String

Col01 to Col40

Tag##

String

Tag01 to Tag 40

⬆️ Back to top

Example

%title

Expand
titleClick to view

Request

Code Block
languagejson
Response
 Code Block
languagejson
Response sample
 Code Block
languagejson
⬆️  Top of page
 Table of Contents
minLevel1
maxLevel2
outlinefalse
typelist
separatorbrackets
printablefalse