Operation

Logged in User

Parameters

Body

Response

GET

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.

Operation

Logged in User

Parameters

Body

Response

POST
Returns all Workbench Import Headers

Operation

Logged in User

Parameters

Body

Response

DELETE

key*

GET

layoutname

POST

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

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

Operation

Logged in User

Parameters

Body

Response

POST
Return list of records

Operation

Logged in User

Parameters

Body

Response

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

Operation

Logged in User

Parameters

Body

Response

POST
Returns list of Records from a table

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.

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

ImportId

Integer

Details

String

Description

String

ImportProcedure

String

DetailsValue

CellData

DescriptionValue

CellData

Status

String

ReadonlyFlag

Integer

ReadonlyMessage

String

OriginalKey

AdminImportHeaderKey

CurrentKey

AdminImportHeaderKey

Key

AdminImportHeaderKey

Index

Integer

Key

AdminImportHeaderKey

Fields

AdminImportLineFields

GridId

String

ColModel

Array [ColModel]

NewRowPosition

String

UpdateColumnEditable

Boolean

Hidden

Boolean

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

Fields

Array [FieldViewData]

Form

Object

Disabled

Boolean

Name

String

Visible

Boolean

Required

Boolean

InfoText

InfoText

Name

String

Value

String

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

Category

Group

Category

Group

CategoryValue

GroupValue

Value

Delete

Status

ReadonlyFlag

Read Only status.

ReadonlyMessage

String

Read Only message.

OriginalKey

CurrentKey

Key

Index

Fields

Array [FieldViewData]

ReturnFields

Array [FormItem]

ToDoNoteId

KeyTable

GridId

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

ToDoNoteId

KeyTable

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

Week1EndDate

String

WeekEndingDayNumber

Integer

TimeUnitsPerHour

Integer

StringId

String

IntId

Integer

DateId

String

StringId1

String

IntId1

Integer

DateId1

String

Name

String

KeyName

String

KeyName1

String

SortDesc

Boolean

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

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

SiteMapID

Integer

ParentSiteMapID

Integer

Name

String

Controller

String

Action

String

Area

String

SiteMapProfileID

Integer

Name

String

Description

String

SiteMaps

Array [SiteMapApiModel]

TableName

String

KeyName

String

KeyValue

String

ColumnNames

String

Key

TableApiKey

Col##

String

Col01 to Col40

Tag##

String

Tag01 to Tag 40