API Endpoints

In this guide, you'll find the different API endpoints High Systems provides.

Applications

Get Applications

This endpoint allows you to query for all the applications you've been invited to.

Request

GET

/api/rest/v1/applications

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getApplications();

Response

{
	success: true,
	results: undefined
}

Get Application

This endpoint allows you to query for a specific application.

Request Paramaters

Name
appid
Type
string
required
Description
The Application ID you wish to query for.

Request

GET

/api/rest/v1/applications/{appid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getApplication({

});

Response

{
	success: true,
	results: undefined
}

Get Application Users

Request Paramaters

Name
appid
Type
string
required
Description
Application ID

Request

GET

/api/rest/v1/applications/{appid}/users

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getApplicationUsers({

});

Response

{
	success: true,
	results: undefined
}

Get Application User

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
userid
Type
string
required
Description
User ID

Request

GET

/api/rest/v1/applications/{appid}/users/{userid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getApplicationUser({

});

Response

{
	success: true,
	results: undefined
}

Get Application Relationships

Request Paramaters

Name
appid
Type
string
required
Description
Application ID

Request

GET

/api/rest/v1/applications/{appid}/relationships

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getApplicationRelationships({

});

Response

{
	success: true,
	results: undefined
}

Get Application Fields

Request Paramaters

Name
appid
Type
string
required
Description
Application ID

Request

GET

/api/rest/v1/applications/{appid}/fields

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getApplicationFields({

});

Response

{
	success: true,
	results: undefined
}

Get Application Reports

Request Paramaters

Name
appid
Type
string
required
Description
Application ID

Request

GET

/api/rest/v1/applications/{appid}/reports

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getApplicationReports({

});

Response

{
	success: true,
	results: undefined
}

Get Application Forms

Request Paramaters

Name
appid
Type
string
required
Description
Application ID

Request

GET

/api/rest/v1/applications/{appid}/forms

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getApplicationForms({

});

Response

{
	success: true,
	results: undefined
}

Get Application Entity Relationship Diagram

Request Paramaters

Name
appid
Type
string
required
Description
Application ID

Request

GET

/api/rest/v1/applications/{appid}/erd

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getApplicationEntityRelationshipDiagram({

});

Response

{
	success: true,
	results: undefined
}

Post Application

This endpoint allows you to create a new application.

Request Paramaters

Name
icon
Type
string
Description
Default Value: RectangleGroupIcon
Name
name
Type
string
required
Description
Name
description
Type
string
Description
Name
dateFormat
Type
string
required
Description
Name
datetimeFormat
Type
string
required
Description
Name
timeFormat
Type
string
required
Description
Name
defaultCurrency
Type
string
Description
Default Value: USD

Request

POST

/api/rest/v1/applications

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postApplication({

});

Response

{
	success: true,
	results: undefined
}

Post Application User

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
relatedUser
Type
string
Description
Name
relatedRole
Type
string
required
Description
Name
email
Type
string
Description
Name
sendEmail
Type
boolean
Description
Default Value: true

Request

POST

/api/rest/v1/applications/{appid}/users

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postApplicationUser({

});

Response

{
	success: true,
	results: undefined
}

Put Application

This endpoint allows you to update an existing application.

Request Paramaters

Name
appid
Type
string
required
Description
The Application ID of the application you wish to update.
Name
icon
Type
string
Description
Default Value: RectangleGroupIcon
Name
name
Type
string
Description
Name
description
Type
string
Description
Name
dateFormat
Type
string
Description
Name
datetimeFormat
Type
string
Description
Name
timeFormat
Type
string
Description
Name
defaultMenu
Type
string
Description
Name
defaultCurrency
Type
string
Description
Default Value: USD

Request

PUT

/api/rest/v1/applications/{appid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putApplication({

});

Response

{
	success: true,
	results: undefined
}

Put Application User

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
applicationUserId
Type
string
required
Description
Application User ID
Name
relatedRole
Type
string
required
Description

Request

PUT

/api/rest/v1/applications/{appid}/users/{applicationUserId}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putApplicationUser({

});

Response

{
	success: true,
	results: undefined
}

Put Application Entity Relationship Diagram

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
diagramid
Type
string
required
Description
Name
layout
Type
object
required
Description

Request

PUT

/api/rest/v1/applications/{appid}/erd/{diagramid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putApplicationEntityRelationshipDiagram({

});

Response

{
	success: true,
	results: undefined
}

Delete Application

This endpoint allows you to delete an existing application.

Request Paramaters

Name
appid
Type
string
required
Description
The Application ID of the application you wish to delete.

Request

DELETE

/api/rest/v1/applications/{appid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteApplication({

});

Response

{
	success: true,
	results: undefined
}

Delete Application User

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
userid
Type
string
required
Description
User ID

Request

DELETE

/api/rest/v1/applications/{appid}/users/{userid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteApplicationUser({

});

Response

{
	success: true,
	results: undefined
}

Dashboards

Get Dashboards

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
relatedTable
Type
string
Description
Table ID

Request

GET

/api/rest/v1/applications/{appid}/dashboards

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getDashboards({

});

Response

{
	success: true,
	results: undefined
}

Get Dashboard

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
dashboardid
Type
string
required
Description
Dashboard ID
Name
relatedTable
Type
string
Description
Table ID

Request

GET

/api/rest/v1/applications/{appid}/dashboards/{dashboardid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getDashboard({

});

Response

{
	success: true,
	results: undefined
}

Post Dashboard

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
relatedTable
Type
string
Description
Name
type
Type
string
required
Description
Name
name
Type
string
required
Description
Name
description
Type
string
Description
Name
schema
Type
object
required
Description
- Name
  md
  Type
  array
  required
  Description
  Name
  id
  Type
  string
  required
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  data
  Type
  object
  Description
  Name
  readonly
  Type
  boolean
  Description
  Name
  required
  Type
  boolean
  Description
  Name
  displayLabel
  Type
  boolean
  Description
- Name
  sm
  Type
  array
  required
  Description
  Name
  id
  Type
  string
  required
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  data
  Type
  object
  Description
  Name
  readonly
  Type
  boolean
  Description
  Name
  required
  Type
  boolean
  Description
  Name
  displayLabel
  Type
  boolean
  Description
- Name
  xs
  Type
  array
  required
  Description
  Name
  id
  Type
  string
  required
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  data
  Type
  object
  Description
  Name
  readonly
  Type
  boolean
  Description
  Name
  required
  Type
  boolean
  Description
  Name
  displayLabel
  Type
  boolean
  Description
Name
layout
Type
object
required
Description
- Name
  md
  Type
  array
  required
  Description
- Name
  sm
  Type
  array
  required
  Description
- Name
  xs
  Type
  array
  required
  Description
Name
properties
Type
object
required
Description
- Name
  displayOnMenu
  Type
  boolean
  required
  Description
- Name
  useCustomLayouts
  Type
  boolean
  Description

Request

POST

/api/rest/v1/applications/{appid}/dashboards

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postDashboard({

});

Response

{
	success: true,
	results: undefined
}

Put Dashboard

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
dashboardid
Type
string
required
Description
Dashboard ID
Name
relatedTable
Type
string
Description
Name
type
Type
string
Description
Name
name
Type
string
Description
Name
description
Type
string
Description
Name
schema
Type
object
Description
- Name
  md
  Type
  array
  Description
  Name
  id
  Type
  string
  required
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  data
  Type
  object
  Description
  Name
  readonly
  Type
  boolean
  Description
  Name
  required
  Type
  boolean
  Description
  Name
  displayLabel
  Type
  boolean
  Description
- Name
  sm
  Type
  array
  Description
  Name
  id
  Type
  string
  required
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  data
  Type
  object
  Description
  Name
  readonly
  Type
  boolean
  Description
  Name
  required
  Type
  boolean
  Description
  Name
  displayLabel
  Type
  boolean
  Description
- Name
  xs
  Type
  array
  Description
  Name
  id
  Type
  string
  required
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  data
  Type
  object
  Description
  Name
  readonly
  Type
  boolean
  Description
  Name
  required
  Type
  boolean
  Description
  Name
  displayLabel
  Type
  boolean
  Description
Name
layout
Type
object
Description
- Name
  md
  Type
  array
  Description
- Name
  sm
  Type
  array
  Description
- Name
  xs
  Type
  array
  Description
Name
properties
Type
object
Description
- Name
  displayOnMenu
  Type
  boolean
  Description
- Name
  useCustomLayouts
  Type
  boolean
  Description

Request

PUT

/api/rest/v1/applications/{appid}/dashboards/{dashboardid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putDashboard({

});

Response

{
	success: true,
	results: undefined
}

Delete Dashboard

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
dashboardid
Type
string
required
Description
Dashboard ID
Name
tableid
Type
string
Description
Table ID

Request

DELETE

/api/rest/v1/applications/{appid}/dashboards/{dashboardid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteDashboard({

});

Response

{
	success: true,
	results: undefined
}

Fields

Get Fields

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
clist
Type
string
Description

Request

GET

/api/rest/v1/applications/{appid}/tables/{tableid}/fields

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getFields({

});

Response

{
	success: true,
	results: undefined
}

Get Field

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
fieldid
Type
string
required
Description
Field ID
Name
tableid
Type
string
required
Description
Table ID

Request

GET

/api/rest/v1/applications/{appid}/tables/{tableid}/fields/{fieldid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getField({

});

Response

{
	success: true,
	results: undefined
}

Post Field

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
field
Type
object
Description
Name
fields
Type
array
Description
- Name
  relatedTable
  Type
  string
  Description
- Name
  name
  Type
  string
  required
  Description
- Name
  type
  Type
  string
  required
  Description
- Name
  data
  Type
  undefined
  Description

Request

POST

/api/rest/v1/applications/{appid}/tables/{tableid}/fields

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postField({

});

Response

{
	success: true,
	results: undefined
}

Put Field

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
fieldid
Type
string
required
Description
Field ID
Name
tableid
Type
string
required
Description
Table ID
Name
field
Type
object
required
Description

Request

PUT

/api/rest/v1/applications/{appid}/tables/{tableid}/fields/{fieldid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putField({

});

Response

{
	success: true,
	results: undefined
}

Delete Field

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
fieldid
Type
string
required
Description
Field ID
Name
tableid
Type
string
required
Description
Table ID

Request

DELETE

/api/rest/v1/applications/{appid}/tables/{tableid}/fields/{fieldid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteField({

});

Response

{
	success: true,
	results: undefined
}

Files

Get File

This endpoint allows you to download a file as base 64.

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
fieldid
Type
string
required
Description
Field ID
Name
recordid
Type
string
required
Description
Record ID
Name
tableid
Type
string
required
Description
Table ID

Request

GET

/api/rest/v1/files/{appid}/{tableid}/{recordid}/{fieldid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getFile({

});

Response

{
	success: true,
	results: undefined
}

Get Presigned File Url

This endpoint allows you to obtain a presigned URL for either fetching or uploading a file attachment.

Request Paramaters

Name
action
Type
string
required
Description
Name
appid
Type
string
Description
Application ID
Name
contentType
Type
string
Description
Name
fieldid
Type
string
Description
Field ID
Name
logo
Type
boolean
Description
Name
pageid
Type
string
Description
Page ID
Name
recordid
Type
string
Description
Record ID
Name
responseDisposition
Type
string
Description
Name
responseType
Type
string
Description
Name
tableid
Type
string
Description
Table ID

Request

GET

/api/rest/v1/files/presigned

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getPresignedFileUrl({

});

Response

{
	success: true,
	results: undefined
}

Finalize File Upload

This endpoint allows you to finalize a file upload, attaching a temporarily uploaded file to a record.

Request Paramaters

Name
appid
Type
string
required
Description
Target Application ID
Name
fieldid
Type
string
required
Description
Target Field ID
Name
filename
Type
string
required
Description
The filename of the file to upload
Name
recordid
Type
string
required
Description
Target Record ID
Name
size
Type
number
required
Description
Size of the file to upload
Name
tableid
Type
string
required
Description
Target Table ID
Name
tmpLocation
Type
string
required
Description
Temporary location of the file to finalize

Request

GET

/api/rest/v1/files/finalize

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.finalizeFileUpload({

});

Response

{
	success: true,
	results: undefined
}

Forms

Get Forms

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID

Request

GET

/api/rest/v1/applications/{appid}/tables/{tableid}/forms

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getForms({

});

Response

{
	success: true,
	results: undefined
}

Get Form

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
formid
Type
string
required
Description
Form ID
Name
tableid
Type
string
required
Description
Table ID

Request

GET

/api/rest/v1/applications/{appid}/tables/{tableid}/forms/{formid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getForm({

});

Response

{
	success: true,
	results: undefined
}

Post Form

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
name
Type
string
required
Description
Name
description
Type
string
Description
Name
schema
Type
object
required
Description
- Name
  md
  Type
  array
  required
  Description
  Name
  id
  Type
  string
  required
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  data
  Type
  object
  Description
  Name
  readonly
  Type
  boolean
  Description
  Name
  required
  Type
  boolean
  Description
  Name
  displayLabel
  Type
  boolean
  Description
- Name
  sm
  Type
  array
  required
  Description
  Name
  id
  Type
  string
  required
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  data
  Type
  object
  Description
  Name
  readonly
  Type
  boolean
  Description
  Name
  required
  Type
  boolean
  Description
  Name
  displayLabel
  Type
  boolean
  Description
- Name
  xs
  Type
  array
  required
  Description
  Name
  id
  Type
  string
  required
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  data
  Type
  object
  Description
  Name
  readonly
  Type
  boolean
  Description
  Name
  required
  Type
  boolean
  Description
  Name
  displayLabel
  Type
  boolean
  Description
Name
layout
Type
object
required
Description
- Name
  md
  Type
  array
  required
  Description
- Name
  sm
  Type
  array
  required
  Description
- Name
  xs
  Type
  array
  required
  Description
Name
rules
Type
array
required
Description
Name
properties
Type
object
required
Description
- Name
  displayCoreFields
  Type
  boolean
  required
  Description
- Name
  displayOnMenu
  Type
  boolean
  required
  Description
- Name
  useCustomLayouts
  Type
  boolean
  required
  Description
- Name
  addRedirect
  Type
  string
  Description
  Default Value: record
- Name
  editRedirect
  Type
  string
  Description
  Default Value: referrer

Request

POST

/api/rest/v1/applications/{appid}/tables/{tableid}/forms

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postForm({

});

Response

{
	success: true,
	results: undefined
}

Put Form

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
formid
Type
string
required
Description
Form ID
Name
tableid
Type
string
required
Description
Table ID
Name
relatedTable
Type
string
Description
Name
name
Type
string
Description
Name
description
Type
string
Description
Name
schema
Type
object
Description
- Name
  md
  Type
  array
  Description
  Name
  id
  Type
  string
  required
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  data
  Type
  object
  Description
  Name
  readonly
  Type
  boolean
  Description
  Name
  required
  Type
  boolean
  Description
  Name
  displayLabel
  Type
  boolean
  Description
- Name
  sm
  Type
  array
  Description
  Name
  id
  Type
  string
  required
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  data
  Type
  object
  Description
  Name
  readonly
  Type
  boolean
  Description
  Name
  required
  Type
  boolean
  Description
  Name
  displayLabel
  Type
  boolean
  Description
- Name
  xs
  Type
  array
  Description
  Name
  id
  Type
  string
  required
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  data
  Type
  object
  Description
  Name
  readonly
  Type
  boolean
  Description
  Name
  required
  Type
  boolean
  Description
  Name
  displayLabel
  Type
  boolean
  Description
Name
layout
Type
object
Description
- Name
  md
  Type
  array
  Description
- Name
  sm
  Type
  array
  Description
- Name
  xs
  Type
  array
  Description
Name
rules
Type
array
Description
Name
properties
Type
object
Description
- Name
  displayCoreFields
  Type
  boolean
  Description
- Name
  displayOnMenu
  Type
  boolean
  Description
- Name
  useCustomLayouts
  Type
  boolean
  Description
- Name
  addRedirect
  Type
  string
  Description
  Default Value: record
- Name
  editRedirect
  Type
  string
  Description
  Default Value: referrer

Request

PUT

/api/rest/v1/applications/{appid}/tables/{tableid}/forms/{formid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putForm({

});

Response

{
	success: true,
	results: undefined
}

Delete Form

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
formid
Type
string
required
Description
Form ID
Name
tableid
Type
string
required
Description
Table ID

Request

DELETE

/api/rest/v1/applications/{appid}/tables/{tableid}/forms/{formid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteForm({

});

Response

{
	success: true,
	results: undefined
}

Functions

Get Functions

Request Paramaters

Name
appid
Type
string
required
Description
Application ID

Request

GET

/api/rest/v1/applications/{appid}/functions

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getFunctions({

});

Response

{
	success: true,
	results: undefined
}

Get Function

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
functionid
Type
string
required
Description
Function ID

Request

GET

/api/rest/v1/applications/{appid}/functions/{functionid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getFunction({

});

Response

{
	success: true,
	results: undefined
}

Post Function

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
name
Type
string
required
Description
Name
description
Type
string
Description
Name
body
Type
string
required
Description

Request

POST

/api/rest/v1/applications/{appid}/functions

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postFunction({

});

Response

{
	success: true,
	results: undefined
}

Put Function

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
functionid
Type
string
required
Description
Function ID
Name
name
Type
string
required
Description
Name
description
Type
string
Description
Name
body
Type
string
required
Description

Request

PUT

/api/rest/v1/applications/{appid}/functions/{functionid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putFunction({

});

Response

{
	success: true,
	results: undefined
}

Delete Function

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
functionid
Type
string
required
Description
Function ID

Request

DELETE

/api/rest/v1/applications/{appid}/functions/{functionid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteFunction({

});

Response

{
	success: true,
	results: undefined
}

Instance Settings

Get Instance Settings

This endpoint allows you to retreive the settings for a given instance.

Request

GET

/api/rest/v1/settings

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getInstanceSettings();

Response

{
	success: true,
	results: {
"theme": {
	"primary": "#00b188"
},
"name": "Demonstration",
"instance": "demo",
"logo": null,
"twoFactorEnforced": true
}
}

Put Instance Settings

This endpoint allows you to update the settings for a given instance.

Request

PUT

/api/rest/v1/settings

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putInstanceSettings();

Response

{
	success: true,
	results: undefined
}

Menus

Get Application Menus

This endpoint allows you to query for all the menus available for an application.

Request Paramaters

Name
appid
Type
string
required
Description
The Application ID of the application you wish to query all menus for.

Request

GET

/api/rest/v1/applications/{appid}/menus

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getApplicationMenus({

});

Response

{
	success: true,
	results: undefined
}

This endpoint allows you to query for a specific application menu.

Request Paramaters

Name
appid
Type
string
required
Description
The Application ID of the menu you wish to query for.
Name
menuid
Type
string
required
Description
The Menu ID of the menu you wish to query for.

Request

GET

/api/rest/v1/applications/{appid}/menus/{menuid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getApplicationMenu({

});

Response

{
	success: true,
	results: undefined
}

This endpoint allows you to query for the rendered application menu for the current user.

Request Paramaters

Name
appid
Type
string
required
Description
The Application ID of the menu you wish to query for.

Request

GET

/api/rest/v1/applications/{appid}/menus/user

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getApplicationUserMenu({

});

Response

{
	success: true,
	results: undefined
}

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
name
Type
string
required
Description
Name
groups
Type
array
required
Description
- Name
  type
  Type
  string
  required
  Description
- Name
  name
  Type
  string
  required
  Description
- Name
  icon
  Type
  string
  Description
- Name
  children
  Type
  array
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  name
  Type
  string
  Description
  Name
  icon
  Type
  string
  Description
  Name
  appid
  Type
  string
  required
  Description
  Name
  tableid
  Type
  string
  Description
  Name
  dashboardid
  Type
  string
  required
  Description
  Name
  children
  Type
  array
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  name
  Type
  string
  required
  Description
  Name
  icon
  Type
  string
  Description
  Name
  children
  Type
  array
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  name
  Type
  string
  Description
  Name
  icon
  Type
  string
  Description
  Name
  appid
  Type
  string
  required
  Description
  Name
  tableid
  Type
  string
  Description
  Name
  dashboardid
  Type
  string
  required
  Description

Request

POST

/api/rest/v1/applications/{appid}/menus

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postApplicationMenu({

});

Response

{
	success: true,
	results: undefined
}

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
menuid
Type
string
required
Description
Menu ID
Name
name
Type
string
required
Description
Name
groups
Type
array
required
Description
- Name
  type
  Type
  string
  required
  Description
- Name
  name
  Type
  string
  required
  Description
- Name
  icon
  Type
  string
  Description
- Name
  children
  Type
  array
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  name
  Type
  string
  Description
  Name
  icon
  Type
  string
  Description
  Name
  appid
  Type
  string
  required
  Description
  Name
  tableid
  Type
  string
  Description
  Name
  dashboardid
  Type
  string
  required
  Description
  Name
  children
  Type
  array
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  name
  Type
  string
  required
  Description
  Name
  icon
  Type
  string
  Description
  Name
  children
  Type
  array
  Description
  Name
  type
  Type
  string
  required
  Description
  Name
  name
  Type
  string
  Description
  Name
  icon
  Type
  string
  Description
  Name
  appid
  Type
  string
  required
  Description
  Name
  tableid
  Type
  string
  Description
  Name
  dashboardid
  Type
  string
  required
  Description

Request

PUT

/api/rest/v1/applications/{appid}/menus/{menuid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putApplicationMenu({

});

Response

{
	success: true,
	results: undefined
}

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
menuid
Type
string
required
Description
Menu ID

Request

DELETE

/api/rest/v1/applications/{appid}/menus/{menuid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteApplicationMenu({

});

Response

{
	success: true,
	results: undefined
}

Notifications

Get Notifications

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID

Request

GET

/api/rest/v1/applications/{appid}/tables/{tableid}/notifications

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getNotifications({

});

Response

{
	success: true,
	results: undefined
}

Get Notification

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
notificationid
Type
string
required
Description
Notification ID
Name
tableid
Type
string
required
Description
Table ID

Request

GET

/api/rest/v1/applications/{appid}/tables/{tableid}/notifications/{notificationid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getNotification({

});

Response

{
	success: true,
	results: undefined
}

Post Notification

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
active
Type
boolean
required
Description
Name
name
Type
string
required
Description
Name
description
Type
string
Description
Name
type
Type
array
Description
Default Value: record-added,record-deleted,record-updated
Name
triggeringFields
Type
array
Description
Default Value:
Name
condition
Type
string
required
Description
Name
to
Type
array
required
Description
Name
cc
Type
array
Description
Name
bcc
Type
array
Description
Name
subject
Type
string
required
Description
Name
html
Type
string
Description
Name
body
Type
string
Description
Name
attachments
Type
array
Description
- Name
  filename
  Type
  string
  required
  Description
- Name
  content
  Type
  string
  required
  Description

Request

POST

/api/rest/v1/applications/{appid}/tables/{tableid}/notifications

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postNotification({

});

Response

{
	success: true,
	results: undefined
}

Put Notification

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
notificationid
Type
string
required
Description
Notification ID
Name
tableid
Type
string
required
Description
Table ID
Name
relatedTable
Type
string
Description
Name
relatedOwner
Type
string
Description
Name
active
Type
boolean
Description
Name
name
Type
string
Description
Name
description
Type
string
Description
Name
type
Type
array
Description
Default Value: record-added,record-deleted,record-updated
Name
triggeringFields
Type
array
Description
Default Value:
Name
condition
Type
string
Description
Name
from
Type
string
Description
Name
to
Type
array
Description
Name
cc
Type
array
Description
Name
bcc
Type
array
Description
Name
subject
Type
string
Description
Name
html
Type
string
Description
Name
body
Type
string
Description
Name
attachments
Type
array
Description
- Name
  filename
  Type
  string
  required
  Description
- Name
  content
  Type
  string
  required
  Description

Request

PUT

/api/rest/v1/applications/{appid}/tables/{tableid}/notifications/{notificationid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putNotification({

});

Response

{
	success: true,
	results: undefined
}

Delete Notification

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
notificationid
Type
string
required
Description
Notification ID
Name
tableid
Type
string
required
Description
Table ID

Request

DELETE

/api/rest/v1/applications/{appid}/tables/{tableid}/notifications/{notificationid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteNotification({

});

Response

{
	success: true,
	results: undefined
}

Pages

Get Pages

Request Paramaters

Name
appid
Type
string
required
Description
Application ID

Request

GET

/api/rest/v1/applications/{appid}/pages

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getPages({

});

Response

{
	success: true,
	results: undefined
}

Get Page

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
pageid
Type
string
required
Description
Page ID

Request

GET

/api/rest/v1/applications/{appid}/pages/{pageid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getPage({

});

Response

{
	success: true,
	results: undefined
}

Post Page

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
name
Type
undefined
Description
Name
content
Type
undefined
Description
Name
properties
Type
undefined
Description

Request

POST

/api/rest/v1/applications/{appid}/pages

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postPage({

});

Response

{
	success: true,
	results: undefined
}

Put Page

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
pageid
Type
string
required
Description
Page ID
Name
name
Type
undefined
Description
Name
content
Type
undefined
Description
Name
properties
Type
undefined
Description

Request

PUT

/api/rest/v1/applications/{appid}/pages/{pageid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putPage({

});

Response

{
	success: true,
	results: undefined
}

Delete Page

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
pageid
Type
string
required
Description
Page ID

Request

DELETE

/api/rest/v1/applications/{appid}/pages/{pageid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deletePage({

});

Response

{
	success: true,
	results: undefined
}

Preferences

Get Preferences

This endpoint allows you to retrieve your saved preferences.

Request

GET

/api/rest/v1/preferences

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getPreferences();

Response

{
	success: true,
	results: {
"reports": {
	"perPage": 10
}
}
}

Put Preferences

This endpoint allows you to update your saved preferences.

Request Paramaters

Name
reports
Type
object
Description
- Name
  perPage
  Type
  number
  required
  Description

Request

PUT

/api/rest/v1/preferences

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putPreferences({

});

Response

{
	success: true,
	results: undefined
}

Records

Get Records

This endpoint allows you to fetch a collection of records.

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
columns
Type
array
Description
An array of field ids to return in the query. Can also be a period delimited string.
Name
grouping
Type
array
Description
An array of field ids to group by. Can also be a period delimited string.
Name
includePermissions
Type
boolean
Description
Return a permissions object that includes an edit and delete properties as booleans.
Name
mergeQuery
Type
boolean
Description
Merge the submitted query string with the saved query string from the report
Name
page
Type
object
Description
Name
query
Type
string
Description
Query string to filter the record set
Name
reportid
Type
string
Description
Name
sorting
Type
array
Description
An array of field ids to sort by. Can also be a period delimited string.
Name
summarize
Type
array
Description
An array of field ids to summarize by. Can also be a period delimited string.
Name
type
Type
string
Description
Default Value: table
Query type

Request

GET

/api/rest/v1/applications/{appid}/tables/{tableid}/records

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getRecords({
	appid: 'mun1w2nm53iur7',
	tableid: 'i8gsxh71n4ea58',
	columns: 'id.vfupchvb89fq2s.ocn33ra4zbjyuu.nmsw8ehz1ztn7k',
	query: `{'nmsw8ehz1ztn7k'.=.'Some Value'}`
});

Response

{
	success: true,
	results: [
{
	"id": "",
	"vfupchvb89fq2s": "",
	"ocn33ra4zbjyuu": "",
	"nmsw8ehz1ztn7k": "Some Value"
}
]
}

Get Records Count

This endpoint allows you to fetch the total number of records that match a given query or report.

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
mergeQuery
Type
boolean
Description
Merge the submitted query string with the saved query string from the report
Name
query
Type
string
Description
Name
reportid
Type
string
Description

Request

GET

/api/rest/v1/applications/{appid}/tables/{tableid}/records/count

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getRecordsCount({

});

Response

{
	success: true,
	results: undefined
}

Get Records Totals

This endpoint allows you to fetch the totals and averages of a given record set.

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
columns
Type
array
Description
An array of field ids to return in the query. Can also be a period delimited string.
Name
grouping
Type
array
Description
An array of field ids to group by. Can also be a period delimited string.
Name
includePermissions
Type
boolean
Description
Return a permissions object that includes an edit and delete properties as booleans.
Name
mergeQuery
Type
boolean
Description
Merge the submitted query string with the saved query string from the report
Name
page
Type
object
Description
Name
query
Type
string
Description
Query string to filter the record set
Name
reportid
Type
string
Description
Name
sorting
Type
array
Description
An array of field ids to sort by. Can also be a period delimited string.
Name
summarize
Type
array
Description
An array of field ids to summarize by. Can also be a period delimited string.
Name
totals
Type
boolean
Description
If true, the returned data will be summarized
Name
type
Type
string
Description
Default Value: table
Query type

Request

GET

/api/rest/v1/applications/{appid}/tables/{tableid}/records/totals

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getRecordsTotals({

});

Response

{
	success: true,
	results: undefined
}

Get Record

This endpoint allows you to fetch a specific record.

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
recordid
Type
string
required
Description
Record ID
Name
tableid
Type
string
required
Description
Table ID
Name
clist
Type
string
Description
Name
includePermissions
Type
boolean
Description
Return a permissions object that includes an edit and delete properties as booleans.

Request

GET

/api/rest/v1/applications/{appid}/tables/{tableid}/records/{recordid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getRecord({

});

Response

{
	success: true,
	results: undefined
}

Post Record

This endpoint allows you to create a new record.

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
format
Type
string
Description

Request

POST

/api/rest/v1/applications/{appid}/tables/{tableid}/records

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postRecord({

});

Response

{
	success: true,
	results: undefined
}

Upsert Records

This endpoint allows you to add and modify records in a single call. If an id is provided, it will update the record, otherwise it will add a new record.

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
data
Type
array
required
Description
An array of records to upsert

Request

POST

/api/rest/v1/applications/{appid}/tables/{tableid}/records/upsert

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.upsertRecords({

});

Response

{
	success: true,
	results: undefined
}

Calculate Record Formulas

This endpoint allows you calculate the value of a given formula with a given record and data.

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
recordid
Type
string
Description
Record ID
Name
formulas
Type
array
required
Description
Name
adHocData
Type
object
required
Description

Request

POST

/api/rest/v1/applications/{appid}/tables/{tableid}/calculate-formulas

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.calculateRecordFormulas({

});

Response

{
	success: true,
	results: undefined
}

Put Record

This endpoint allows you to update an existing record.

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
id
Type
string
required
Description
Record ID
Name
tableid
Type
string
required
Description
Table ID
Name
format
Type
string
Description

Request

PUT

/api/rest/v1/applications/{appid}/tables/{tableid}/records/{id}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putRecord({

});

Response

{
	success: true,
	results: undefined
}

Delete Records

This endpoint allows you to delete multiple records from a table.

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
query
Type
string
Description

Request

DELETE

/api/rest/v1/applications/{appid}/tables/{tableid}/records

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteRecords({

});

Response

{
	success: true,
	results: undefined
}

Delete Record

This endpoint allows you to delete a specific record from a table.

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
recordid
Type
string
required
Description
Record ID
Name
tableid
Type
string
required
Description
Table ID

Request

DELETE

/api/rest/v1/applications/{appid}/tables/{tableid}/records/{recordid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteRecord({

});

Response

{
	success: true,
	results: undefined
}

Reports

Get Reports

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID

Request

GET

/api/rest/v1/applications/{appid}/tables/{tableid}/reports

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getReports({

});

Response

{
	success: true,
	results: undefined
}

Get Report

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
reportid
Type
string
required
Description
Report ID
Name
tableid
Type
string
required
Description
Table ID

Request

GET

/api/rest/v1/applications/{appid}/tables/{tableid}/reports/{reportid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getReport({

});

Response

{
	success: true,
	results: undefined
}

Post Report

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
report
Type
object
required
Description

Request

POST

/api/rest/v1/applications/{appid}/tables/{tableid}/reports

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postReport({

});

Response

{
	success: true,
	results: undefined
}

Put Report

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
reportid
Type
string
required
Description
Report ID
Name
tableid
Type
string
required
Description
Table ID
Name
report
Type
object
required
Description

Request

PUT

/api/rest/v1/applications/{appid}/tables/{tableid}/reports/{reportid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putReport({

});

Response

{
	success: true,
	results: undefined
}

Delete Report

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
reportid
Type
string
required
Description
Report ID
Name
tableid
Type
string
required
Description
Table ID

Request

DELETE

/api/rest/v1/applications/{appid}/tables/{tableid}/reports/{reportid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteReport({

});

Response

{
	success: true,
	results: undefined
}

Roles

Get Roles

Request Paramaters

Name
appid
Type
string
required
Description
Application ID

Request

GET

/api/rest/v1/applications/{appid}/roles

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getRoles({

});

Response

{
	success: true,
	results: undefined
}

Get Role

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
roleid
Type
string
required
Description
Role ID

Request

GET

/api/rest/v1/applications/{appid}/roles/{roleid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getRole({

});

Response

{
	success: true,
	results: undefined
}

Get Role Permissions

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
roleid
Type
string
required
Description
Role ID

Request

GET

/api/rest/v1/applications/{appid}/roles/{roleid}/permissions

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getRolePermissions({

});

Response

{
	success: true,
	results: undefined
}

Get Role Table Permissions

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
roleid
Type
string
required
Description
Role ID

Request

GET

/api/rest/v1/applications/{appid}/roles/{roleid}/permissions/tables

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getRoleTablePermissions({

});

Response

{
	success: true,
	results: undefined
}

Get Role Defaults

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
roleid
Type
string
required
Description
Role ID

Request

GET

/api/rest/v1/applications/{appid}/roles/{roleid}/defaults

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getRoleDefaults({

});

Response

{
	success: true,
	results: undefined
}

Post Role

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
name
Type
string
required
Description
Name
description
Type
string
Description
Name
isAdmin
Type
boolean
Description
Name
isLimitedAdmin
Type
boolean
Description
Name
canInvite
Type
boolean
Description
Name
readonly
Type
boolean
Description
Name
defaultDashboard
Type
string
Description
Name
relatedMenu
Type
string
Description

Request

POST

/api/rest/v1/applications/{appid}/roles

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postRole({

});

Response

{
	success: true,
	results: undefined
}

Put Role

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
roleid
Type
string
required
Description
Role ID
Name
name
Type
string
Description
Name
description
Type
string
Description
Name
isAdmin
Type
boolean
Description
Name
isLimitedAdmin
Type
boolean
Description
Name
canInvite
Type
boolean
Description
Name
readonly
Type
boolean
Description
Name
defaultDashboard
Type
string
Description
Name
relatedMenu
Type
string
Description
Name
permissions
Type
object
Description
- Name
  tables
  Type
  array
  required
  Description
- Name
  fields
  Type
  array
  required
  Description

Request

PUT

/api/rest/v1/applications/{appid}/roles/{roleid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putRole({

});

Response

{
	success: true,
	results: undefined
}

Delete Role

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
roleid
Type
string
required
Description
Role ID

Request

DELETE

/api/rest/v1/applications/{appid}/roles/{roleid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteRole({

});

Response

{
	success: true,
	results: undefined
}

Tables

Get Tables

Request Paramaters

Name
appid
Type
string
required
Description
Application ID

Request

GET

/api/rest/v1/applications/{appid}/tables

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getTables({

});

Response

{
	success: true,
	results: undefined
}

Get Table

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID

Request

GET

/api/rest/v1/applications/{appid}/tables/{tableid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getTable({

});

Response

{
	success: true,
	results: undefined
}

Get Table Relationships

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID

Request

GET

/api/rest/v1/applications/{appid}/tables/relationships

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getTableRelationships({

});

Response

{
	success: true,
	results: undefined
}

Post Table

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
icon
Type
string
Description
Default Value: FolderIcon
Name
name
Type
string
required
Description
Name
description
Type
string
Description
Name
singular
Type
string
required
Description
Name
plural
Type
string
required
Description
Name
displayOnMenu
Type
boolean
Description
Default Value: true
Name
defaultDashboard
Type
string
Description
Name
defaultForm
Type
string
Description
Name
dataRule
Type
string
Description

Request

POST

/api/rest/v1/applications/{appid}/tables

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postTable({

});

Response

{
	success: true,
	results: undefined
}

Put Table

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
relatedApplication
Type
string
Description
Name
icon
Type
string
Description
Default Value: FolderIcon
Name
name
Type
string
Description
Name
description
Type
string
Description
Name
singular
Type
string
Description
Name
plural
Type
string
Description
Name
recordPicker
Type
array
Description
Default Value: id
Name
recordLabel
Type
string
Description
Default Value: id
Name
displayOnMenu
Type
boolean
Description
Default Value: true
Name
defaultDashboard
Type
string
Description
Name
defaultForm
Type
string
Description
Name
dataRule
Type
string
Description

Request

PUT

/api/rest/v1/applications/{appid}/tables/{tableid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putTable({

});

Response

{
	success: true,
	results: undefined
}

Delete Table

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID

Request

DELETE

/api/rest/v1/applications/{appid}/tables/{tableid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteTable({

});

Response

{
	success: true,
	results: undefined
}

Transactions

Get Transaction

This endpoint allows you to start a new transaction.

Transactions allow you to execute multiple API calls within the same, well, transaction. A transaction allows you to rollback or commit all the changes you've made attached to the transaction.

This is useful for when you are creating multiple records and need to do any clean up if one of those records fails to be added.

Request

GET

/api/rest/v1/transactions

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getTransaction();

Response

{
	success: true,
	results: 'cr8uy4dufq9hq7'
}

Post Transaction

This endpoint allows you to commit an existing transaction.

Request Paramaters

Name
id
Type
string
required
Description
The Transaction ID of the transaction you want to commit.

Request

POST

/api/rest/v1/transactions/{id}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postTransaction({
	id: 'cr8uy4dufq9hq7'
});

Response

{
	success: true,
	results: {}
}

Delete Transaction

This endpoint allows you to rollback an existing transaction.

Request Paramaters

Name
id
Type
string
required
Description
The Transaction ID of the transaction you want to commit.

Request

DELETE

/api/rest/v1/transactions/{id}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteTransaction({
	id: 'cr8uy4dufq9hq7'
});

Response

{
	success: true,
	results: undefined
}

Triggers

Get Triggers

Request Paramaters

Name
appid
Type
string
required
Description
Application ID

Request

GET

/api/rest/v1/applications/{appid}/triggers

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getTriggers({

});

Response

{
	success: true,
	results: undefined
}

Get Trigger

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
triggerid
Type
string
required
Description
Trigger ID

Request

GET

/api/rest/v1/applications/{appid}/triggers/{triggerid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getTrigger({

});

Response

{
	success: true,
	results: undefined
}

Post Trigger

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
owner
Type
string
Description
Name
active
Type
boolean
Description
Name
name
Type
string
required
Description
Name
description
Type
string
Description
Name
timing
Type
string
required
Description
Name
event
Type
string
required
Description
Name
relatedTable
Type
string
required
Description
Name
forEach
Type
string
required
Description
Name
where
Type
string
Description
Name
relatedFunction
Type
string
required
Description

Request

POST

/api/rest/v1/applications/{appid}/triggers

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postTrigger({

});

Response

{
	success: true,
	results: undefined
}

Put Trigger

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
triggerid
Type
string
required
Description
Trigger ID
Name
owner
Type
string
required
Description
Name
active
Type
boolean
Description
Name
name
Type
string
required
Description
Name
description
Type
string
Description
Name
timing
Type
string
required
Description
Name
event
Type
string
required
Description
Name
relatedTable
Type
string
required
Description
Name
forEach
Type
string
required
Description
Name
where
Type
string
Description
Name
relatedFunction
Type
string
required
Description

Request

PUT

/api/rest/v1/applications/{appid}/triggers/{triggerid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putTrigger({

});

Response

{
	success: true,
	results: undefined
}

Delete Trigger

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
triggerid
Type
string
required
Description
Trigger ID

Request

DELETE

/api/rest/v1/applications/{appid}/triggers/{triggerid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteTrigger({

});

Response

{
	success: true,
	results: undefined
}

User Tokens

Get User Tokens

This endpoint allows you to query for all the user tokens for a given user.

Request Paramaters

Name
userid
Type
string
required
Description
The User ID of the user you wish to get their user tokens of.

Request

GET

/api/rest/v1/users/{userid}/tokens

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getUserTokens({

});

Response

{
	success: true,
	results: undefined
}

Get User Token

This endpoint allows you to query for a specific user token.

Request Paramaters

Name
tokenid
Type
string
required
Description
The User Token ID of the token you wish to query for.
Name
userid
Type
string
required
Description
The User ID of the user the token you are querying belongs to.

Request

GET

/api/rest/v1/users/{userid}/tokens/{tokenid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getUserToken({

});

Response

{
	success: true,
	results: undefined
}

Post User Token

This endpoint allows you to create a new user token.

Request Paramaters

Name
userid
Type
string
required
Description
The User ID of the user the token you wish to create belongs to.
Name
name
Type
string
required
Description
Name
description
Type
string
Description
Name
applications
Type
array
Description
Name
active
Type
boolean
required
Description

Request

POST

/api/rest/v1/users/{userid}/tokens

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postUserToken({

});

Response

{
	success: true,
	results: undefined
}

Put User Token

This endpoint allows you to update an existing user token.

Request Paramaters

Name
tokenid
Type
string
required
Description
The User ID of the user the token you wish to update belongs to.
Name
userid
Type
string
required
Description
The User Token ID of the token you wish to update.
Name
name
Type
string
Description
Name
description
Type
string
Description
Name
applications
Type
array
Description
Name
active
Type
boolean
Description

Request

PUT

/api/rest/v1/users/{userid}/tokens/{tokenid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putUserToken({

});

Response

{
	success: true,
	results: undefined
}

Delete User Token

This endpoint allows you to delete an existing user token.

Request Paramaters

Name
tokenid
Type
string
required
Description
The User Token ID of the token you wish to delete.
Name
userid
Type
string
required
Description
The User ID of the user the token you wish to delete belongs to.

Request

DELETE

/api/rest/v1/users/{userid}/tokens/{tokenid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteUserToken({

});

Response

{
	success: true,
	results: undefined
}

Users

Get Users

This endpoint allows you to query for all the users in the High Systems instance.

Request

GET

/api/rest/v1/users

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getUsers();

Response

{
	success: true,
	results: undefined
}

Get User

This endpoint allows you to query for a specific user by their user id.

Request Paramaters

Name
userid
Type
string
required
Description
The User ID of the user you wish to query for.

Request

GET

/api/rest/v1/users/{userid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getUser({

});

Response

{
	success: true,
	results: undefined
}

Post User

This endpoint allows you to create a new instance user.

Request Paramaters

Name
email
Type
string
required
Description
Name
password
Type
string
Description
Name
firstName
Type
string
Description
Name
middleName
Type
string
Description
Name
lastName
Type
string
Description
Name
isInstanceAdmin
Type
boolean
Description
Name
isInstanceLimitedAdmin
Type
boolean
Description
Name
reset
Type
boolean
Description
Name
valid
Type
boolean
Description
Name
twoFactorEnabled
Type
boolean
Description
Name
sendEmail
Type
boolean
Description
Default Value: true
If true, an email will be sent the user inviting them to the instance and/or application.

Request

POST

/api/rest/v1/users

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postUser({

});

Response

{
	success: true,
	results: undefined
}

Put User

This endpoint allows you to update an existing instance user.

Request Paramaters

Name
userid
Type
string
required
Description
The User ID of the user you wish to update.
Name
email
Type
string
Description
Name
password
Type
string
Description
Name
firstName
Type
string
Description
Name
middleName
Type
string
Description
Name
lastName
Type
string
Description
Name
isInstanceAdmin
Type
boolean
Description
Name
isInstanceLimitedAdmin
Type
boolean
Description
Name
reset
Type
boolean
Description
Name
valid
Type
boolean
Description
Name
twoFactorEnabled
Type
boolean
Description

Request

PUT

/api/rest/v1/users/{userid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putUser({

});

Response

{
	success: true,
	results: undefined
}

Delete User

This endpoint allows you to delete an existing instance user. This will remove them from all applications they've been invited to.

Request Paramaters

Name
userid
Type
string
required
Description
The User ID of the user you wish to delete.

Request

DELETE

/api/rest/v1/users/{userid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteUser({

});

Response

{
	success: true,
	results: undefined
}

Variables

Get Variables

Request Paramaters

Name
appid
Type
string
required
Description
Application ID

Request

GET

/api/rest/v1/applications/{appid}/variables

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getVariables({

});

Response

{
	success: true,
	results: undefined
}

Get Variable

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
variableid
Type
string
required
Description
Variable ID

Request

GET

/api/rest/v1/applications/{appid}/variables/{variableid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getVariable({

});

Response

{
	success: true,
	results: undefined
}

Post Variable

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
name
Type
string
required
Description
Name
value
Type
string
Description

Request

POST

/api/rest/v1/applications/{appid}/variables

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postVariable({

});

Response

{
	success: true,
	results: undefined
}

Put Variable

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
variableid
Type
string
required
Description
Variable ID
Name
relatedApplication
Type
string
Description
Name
name
Type
string
Description
Name
value
Type
string
Description

Request

PUT

/api/rest/v1/applications/{appid}/variables/{variableid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putVariable({

});

Response

{
	success: true,
	results: undefined
}

Delete Variable

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
variableid
Type
string
required
Description
Variable ID

Request

DELETE

/api/rest/v1/applications/{appid}/variables/{variableid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteVariable({

});

Response

{
	success: true,
	results: undefined
}

Webhooks

Get Webhooks

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID

Request

GET

/api/rest/v1/applications/{appid}/tables/{tableid}/webhooks

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getWebhooks({

});

Response

{
	success: true,
	results: undefined
}

Get Webhook

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
webhookid
Type
string
required
Description
Webhook ID

Request

GET

/api/rest/v1/applications/{appid}/tables/{tableid}/webhooks/{webhookid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.getWebhook({

});

Response

{
	success: true,
	results: undefined
}

Post Webhook

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
relatedOwner
Type
string
Description
Name
active
Type
boolean
Description
Name
name
Type
string
Description
Name
description
Type
string
Description
Name
type
Type
array
Description
Default Value: record-added,record-deleted,record-updated
Name
triggeringFields
Type
array
Description
Default Value:
Name
condition
Type
string
Description
Name
endpoint
Type
string
Description
Name
method
Type
string
Description
Default Value: GET
Name
headers
Type
array
Description
Default Value:
Name
body
Type
string
Description

Request

POST

/api/rest/v1/applications/{appid}/tables/{tableid}/webhooks

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.postWebhook({

});

Response

{
	success: true,
	results: undefined
}

Put Webhook

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
webhookid
Type
string
required
Description
Webhook ID
Name
relatedTable
Type
string
Description
Name
relatedOwner
Type
string
Description
Name
active
Type
boolean
Description
Name
name
Type
string
Description
Name
description
Type
string
Description
Name
type
Type
array
Description
Default Value: record-added,record-deleted,record-updated
Name
triggeringFields
Type
array
Description
Default Value:
Name
condition
Type
string
Description
Name
endpoint
Type
string
Description
Name
method
Type
string
Description
Default Value: GET
Name
headers
Type
array
Description
Default Value:
Name
body
Type
string
Description

Request

PUT

/api/rest/v1/applications/{appid}/tables/{tableid}/webhooks/{webhookid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.putWebhook({

});

Response

{
	success: true,
	results: undefined
}

Delete Webhook

Request Paramaters

Name
appid
Type
string
required
Description
Application ID
Name
tableid
Type
string
required
Description
Table ID
Name
webhookid
Type
string
required
Description
Webhook ID

Request

DELETE

/api/rest/v1/applications/{appid}/tables/{tableid}/webhooks/{webhookid}

import { HighSystems } from '@highsystems/client'

const api = new HighSystems({
	instance: '',
	userToken: ''
});

const results = await api.deleteWebhook({

});

Response

{
	success: true,
	results: undefined
}