Class HighSystems

constructor

• new HighSystems(options?): HighSystems

• Parameters

  • Optional options: Partial<{
        connectionLimit: number;
        connectionLimitPeriod: number;
        errorOnConnectionLimit: boolean;
        instance: string;
        proxy: false | {
            auth?: {
                password: string;
                username: string;
            };
            host: string;
            port: number;
        };
        userAgent: string;
        userToken: string;
    }>

  Returns HighSystems

Readonly CLASS_NAME

settings

Static Readonly CLASS_NAME

Static Readonly VERSION

Static defaults

calculateRecordFormulas

• calculateRecordFormulas(options): Promise<any>

• calculateRecordFormulas

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

  Parameters

  • options: HighSystemsRequest & {
        adHocData: any;
        appid: any;
        formulas: string[];
        recordid?: string;
        tableid: any;
    } & {
        returnAxios?: false;
    }

    calculateRecordFormulas method options object

  Returns Promise<any>
• calculateRecordFormulas(__namedParameters): Promise<AxiosResponse<HighSystemsResponseCalculateRecordFormulas, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        adHocData: any;
        appid: any;
        formulas: string[];
        recordid?: string;
        tableid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseCalculateRecordFormulas, any>>

deleteApplication

• deleteApplication(options): Promise<any>

• deleteApplication

  This endpoint allows you to delete an existing application.

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
    } & {
        returnAxios?: false;
    }

    deleteApplication method options object

  Returns Promise<any>
• deleteApplication(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteApplication, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteApplication, any>>

deleteApplicationMenu

• deleteApplicationMenu(options): Promise<any>

• deleteApplicationMenu

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        menuid: any;
    } & {
        returnAxios?: false;
    }

    deleteApplicationMenu method options object

  Returns Promise<any>
• deleteApplicationMenu(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteApplicationMenu, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        menuid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteApplicationMenu, any>>

deleteApplicationUser

• deleteApplicationUser(options): Promise<any>

• deleteApplicationUser

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        userid: any;
    } & {
        returnAxios?: false;
    }

    deleteApplicationUser method options object

  Returns Promise<any>
• deleteApplicationUser(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteApplicationUser, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        userid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteApplicationUser, any>>

deleteDashboard

• deleteDashboard(options): Promise<any>

• deleteDashboard

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        dashboardid: any;
        tableid?: any;
    } & {
        returnAxios?: false;
    }

    deleteDashboard method options object

  Returns Promise<any>
• deleteDashboard(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteDashboard, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        dashboardid: any;
        tableid?: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteDashboard, any>>

deleteField

• deleteField(options): Promise<any>

• deleteField

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        fieldid: any;
        tableid: any;
    } & {
        returnAxios?: false;
    }

    deleteField method options object

  Returns Promise<any>
• deleteField(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteField, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        fieldid: any;
        tableid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteField, any>>

deleteForm

• deleteForm(options): Promise<any>

• deleteForm

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        formid: any;
        tableid: any;
    } & {
        returnAxios?: false;
    }

    deleteForm method options object

  Returns Promise<any>
• deleteForm(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteForm, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        formid: any;
        tableid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteForm, any>>

deleteFunction

• deleteFunction(options): Promise<any>

• deleteFunction

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        functionid: any;
    } & {
        returnAxios?: false;
    }

    deleteFunction method options object

  Returns Promise<any>
• deleteFunction(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteFunction, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        functionid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteFunction, any>>

deleteNotification

• deleteNotification(options): Promise<any>

• deleteNotification

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        notificationid: any;
        tableid: any;
    } & {
        returnAxios?: false;
    }

    deleteNotification method options object

  Returns Promise<any>
• deleteNotification(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteNotification, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        notificationid: any;
        tableid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteNotification, any>>

deletePage

• deletePage(options): Promise<any>

• deletePage

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        pageid: any;
    } & {
        returnAxios?: false;
    }

    deletePage method options object

  Returns Promise<any>
• deletePage(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeletePage, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        pageid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeletePage, any>>

deleteRecord

• deleteRecord(options): Promise<any>

• deleteRecord

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

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        recordid: any;
        tableid: any;
    } & {
        returnAxios?: false;
    }

    deleteRecord method options object

  Returns Promise<any>
• deleteRecord(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteRecord, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        recordid: any;
        tableid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteRecord, any>>

deleteRecords

• deleteRecords(options): Promise<number>

• deleteRecords

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

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        query?: any;
        tableid: any;
    } & {
        returnAxios?: false;
    }

    deleteRecords method options object

  Returns Promise<number>
• deleteRecords(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteRecords, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        query?: any;
        tableid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteRecords, any>>

deleteReport

• deleteReport(options): Promise<any>

• deleteReport

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        reportid: any;
        tableid: any;
    } & {
        returnAxios?: false;
    }

    deleteReport method options object

  Returns Promise<any>
• deleteReport(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteReport, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        reportid: any;
        tableid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteReport, any>>

deleteRole

• deleteRole(options): Promise<any>

• deleteRole

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        roleid: any;
    } & {
        returnAxios?: false;
    }

    deleteRole method options object

  Returns Promise<any>
• deleteRole(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteRole, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        roleid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteRole, any>>

deleteTable

• deleteTable(options): Promise<any>

• deleteTable

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        tableid: any;
    } & {
        returnAxios?: false;
    }

    deleteTable method options object

  Returns Promise<any>
• deleteTable(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteTable, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        tableid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteTable, any>>

deleteTransaction

• deleteTransaction(options): Promise<any>

• deleteTransaction

  This endpoint allows you to rollback an existing transaction.

  Parameters

  • options: HighSystemsRequest & {
        id: any;
    } & {
        returnAxios?: false;
    }

    deleteTransaction method options object

  Returns Promise<any>
• deleteTransaction(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteTransaction, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        id: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteTransaction, any>>

deleteTrigger

• deleteTrigger(options): Promise<any>

• deleteTrigger

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        triggerid: any;
    } & {
        returnAxios?: false;
    }

    deleteTrigger method options object

  Returns Promise<any>
• deleteTrigger(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteTrigger, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        triggerid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteTrigger, any>>

deleteUser

• deleteUser(options): Promise<any>

• deleteUser

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

  Parameters

  • options: HighSystemsRequest & {
        userid: any;
    } & {
        returnAxios?: false;
    }

    deleteUser method options object

  Returns Promise<any>
• deleteUser(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteUser, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        userid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteUser, any>>

deleteUserToken

• deleteUserToken(options): Promise<any>

• deleteUserToken

  This endpoint allows you to delete an existing user token.

  Parameters

  • options: HighSystemsRequest & {
        tokenid: any;
        userid: any;
    } & {
        returnAxios?: false;
    }

    deleteUserToken method options object

  Returns Promise<any>
• deleteUserToken(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteUserToken, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        tokenid: any;
        userid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteUserToken, any>>

deleteVariable

• deleteVariable(options): Promise<any>

• deleteVariable

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        variableid: any;
    } & {
        returnAxios?: false;
    }

    deleteVariable method options object

  Returns Promise<any>
• deleteVariable(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteVariable, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        variableid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteVariable, any>>

deleteWebhook

• deleteWebhook(options): Promise<any>

• deleteWebhook

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        tableid: any;
        webhookid: any;
    } & {
        returnAxios?: false;
    }

    deleteWebhook method options object

  Returns Promise<any>
• deleteWebhook(__namedParameters): Promise<AxiosResponse<HighSystemsResponseDeleteWebhook, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        tableid: any;
        webhookid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseDeleteWebhook, any>>

finalizeFileUpload

• finalizeFileUpload(options): Promise<any>

• finalizeFileUpload

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

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        fieldid: any;
        filename: any;
        recordid: any;
        size: any;
        tableid: any;
        tmpLocation: any;
    } & {
        returnAxios?: false;
    }

    finalizeFileUpload method options object

  Returns Promise<any>
• finalizeFileUpload(__namedParameters): Promise<AxiosResponse<HighSystemsResponseFinalizeFileUpload, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        fieldid: any;
        filename: any;
        recordid: any;
        size: any;
        tableid: any;
        tmpLocation: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseFinalizeFileUpload, any>>

fromJSON

• fromJSON(json): HighSystems

• Rebuild the HighSystems instance from serialized JSON

  Parameters

  • json: string | Partial<{
        connectionLimit: number;
        connectionLimitPeriod: number;
        errorOnConnectionLimit: boolean;
        instance: string;
        proxy: false | {
            auth?: {
                password: string;
                username: string;
            };
            host: string;
            port: number;
        };
        userAgent: string;
        userToken: string;
    }>

    HighSystems class options

  Returns HighSystems

getApplication

• getApplication(options): Promise<{
      dateFormat: string;
      datetimeFormat: string;
      defaultCurrency?: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BOV" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHE" | "CHF" | "CHW" | "CLF" | "CLP" | "COP" | "COU" | "CRC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MXV" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "CNY" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "SSP" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "USN" | "UYI" | "UYU" | "UYW" | "UZS" | "VED" | "VES" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XBA" | "XBB" | "XBC" | "XBD" | "XCD" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "XSU" | "XTS" | "XUA" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWL";
      defaultMenu?: string;
      description?: string;
      icon?: "" | "AcademicCapIcon" | "AdjustmentsHorizontalIcon" | "AdjustmentsVerticalIcon" | "ArchiveBoxArrowDownIcon" | "ArchiveBoxXMarkIcon" | "ArchiveBoxIcon" | "ArrowDownCircleIcon" | "ArrowDownLeftIcon" | "ArrowDownOnSquareStackIcon" | "ArrowDownOnSquareIcon" | "ArrowDownRightIcon" | "ArrowDownTrayIcon" | "ArrowDownIcon" | "ArrowLeftCircleIcon" | "ArrowLeftOnRectangleIcon" | "ArrowLeftIcon" | "ArrowLongDownIcon" | "ArrowLongLeftIcon" | "ArrowLongRightIcon" | "ArrowLongUpIcon" | "ArrowPathRoundedSquareIcon" | "ArrowPathIcon" | "ArrowRightCircleIcon" | "ArrowRightOnRectangleIcon" | "ArrowRightIcon" | "ArrowSmallDownIcon" | "ArrowSmallLeftIcon" | "ArrowSmallRightIcon" | "ArrowSmallUpIcon" | "ArrowTopRightOnSquareIcon" | "ArrowTrendingDownIcon" | "ArrowTrendingUpIcon" | "ArrowUpCircleIcon" | "ArrowUpLeftIcon" | "ArrowUpOnSquareStackIcon" | "ArrowUpOnSquareIcon" | "ArrowUpRightIcon" | "ArrowUpTrayIcon" | "ArrowUpIcon" | "ArrowUturnDownIcon" | "ArrowUturnLeftIcon" | "ArrowUturnRightIcon" | "ArrowUturnUpIcon" | "ArrowsPointingInIcon" | "ArrowsPointingOutIcon" | "ArrowsRightLeftIcon" | "ArrowsUpDownIcon" | "AtSymbolIcon" | "BackspaceIcon" | "BackwardIcon" | "BanknotesIcon" | "Bars2Icon" | "Bars3BottomLeftIcon" | "Bars3BottomRightIcon" | "Bars3CenterLeftIcon" | "Bars3Icon" | "Bars4Icon" | "BarsArrowDownIcon" | "BarsArrowUpIcon" | "Battery0Icon" | "Battery100Icon" | "Battery50Icon" | "BeakerIcon" | "BellAlertIcon" | "BellSlashIcon" | "BellSnoozeIcon" | "BellIcon" | "BoltSlashIcon" | "BoltIcon" | "BookOpenIcon" | "BookmarkSlashIcon" | "BookmarkSquareIcon" | "BookmarkIcon" | "BriefcaseIcon" | "BugAntIcon" | "BuildingLibraryIcon" | "BuildingOffice2Icon" | "BuildingOfficeIcon" | "BuildingStorefrontIcon" | "CakeIcon" | "CalculatorIcon" | "CalendarDaysIcon" | "CalendarIcon" | "CameraIcon" | "ChartBarSquareIcon" | "ChartBarIcon" | "ChartPieIcon" | "ChatBubbleBottomCenterTextIcon" | "ChatBubbleBottomCenterIcon" | "ChatBubbleLeftEllipsisIcon" | "ChatBubbleLeftRightIcon" | "ChatBubbleLeftIcon" | "ChatBubbleOvalLeftEllipsisIcon" | "ChatBubbleOvalLeftIcon" | "CheckBadgeIcon" | "CheckCircleIcon" | "CheckIcon" | "ChevronDoubleDownIcon" | "ChevronDoubleLeftIcon" | "ChevronDoubleRightIcon" | "ChevronDoubleUpIcon" | "ChevronDownIcon" | "ChevronLeftIcon" | "ChevronRightIcon" | "ChevronUpDownIcon" | "ChevronUpIcon" | "CircleStackIcon" | "ClipboardDocumentCheckIcon" | "ClipboardDocumentListIcon" | "ClipboardDocumentIcon" | "ClipboardIcon" | "ClockIcon" | "CloudArrowDownIcon" | "CloudArrowUpIcon" | "CloudIcon" | "CodeBracketSquareIcon" | "CodeBracketIcon" | "Cog6ToothIcon" | "Cog8ToothIcon" | "CogIcon" | "CommandLineIcon" | "ComputerDesktopIcon" | "CpuChipIcon" | "CreditCardIcon" | "CubeTransparentIcon" | "CubeIcon" | "CurrencyBangladeshiIcon" | "CurrencyDollarIcon" | "CurrencyEuroIcon" | "CurrencyPoundIcon" | "CurrencyRupeeIcon" | "CurrencyYenIcon" | "CursorArrowRaysIcon" | "CursorArrowRippleIcon" | "DevicePhoneMobileIcon" | "DeviceTabletIcon" | "DocumentArrowDownIcon" | "DocumentArrowUpIcon" | "DocumentChartBarIcon" | "DocumentCheckIcon" | "DocumentDuplicateIcon" | "DocumentMagnifyingGlassIcon" | "DocumentMinusIcon" | "DocumentPlusIcon" | "DocumentTextIcon" | "DocumentIcon" | "EllipsisHorizontalCircleIcon" | "EllipsisHorizontalIcon" | "EllipsisVerticalIcon" | "EnvelopeOpenIcon" | "EnvelopeIcon" | "ExclamationCircleIcon" | "ExclamationTriangleIcon" | "EyeDropperIcon" | "EyeSlashIcon" | "EyeIcon" | "FaceFrownIcon" | "FaceSmileIcon" | "FilmIcon" | "FingerPrintIcon" | "FireIcon" | "FlagIcon" | "FolderArrowDownIcon" | "FolderMinusIcon" | "FolderOpenIcon" | "FolderPlusIcon" | "FolderIcon" | "ForwardIcon" | "FunnelIcon" | "GifIcon" | "GiftTopIcon" | "GiftIcon" | "GlobeAltIcon" | "GlobeAmericasIcon" | "GlobeAsiaAustraliaIcon" | "GlobeEuropeAfricaIcon" | "HandRaisedIcon" | "HandThumbDownIcon" | "HandThumbUpIcon" | "HashtagIcon" | "HeartIcon" | "HomeModernIcon" | "HomeIcon" | "IdentificationIcon" | "InboxArrowDownIcon" | "InboxStackIcon" | "InboxIcon" | "InformationCircleIcon" | "KeyIcon" | "LanguageIcon" | "LifebuoyIcon" | "LightBulbIcon" | "LinkIcon" | "ListBulletIcon" | "LockClosedIcon" | "LockOpenIcon" | "MagnifyingGlassCircleIcon" | "MagnifyingGlassMinusIcon" | "MagnifyingGlassPlusIcon" | "MagnifyingGlassIcon" | "MapPinIcon" | "MapIcon" | "MegaphoneIcon" | "MicrophoneIcon" | "MinusCircleIcon" | "MinusSmallIcon" | "MinusIcon" | "MoonIcon" | "MusicalNoteIcon" | "NewspaperIcon" | "NoSymbolIcon" | "PaintBrushIcon" | "PaperAirplaneIcon" | "PaperClipIcon" | "PauseCircleIcon" | "PauseIcon" | "PencilSquareIcon" | "PencilIcon" | "PhoneArrowDownLeftIcon" | "PhoneArrowUpRightIcon" | "PhoneXMarkIcon" | "PhoneIcon" | "PhotoIcon" | "PlayCircleIcon" | "PlayPauseIcon" | "PlayIcon" | "PlusCircleIcon" | "PlusSmallIcon" | "PlusIcon" | "PowerIcon" | "PresentationChartBarIcon" | "PresentationChartLineIcon" | "PrinterIcon" | "PuzzlePieceIcon" | "QrCodeIcon" | "QuestionMarkCircleIcon" | "QueueListIcon" | "RadioIcon" | "ReceiptPercentIcon" | "ReceiptRefundIcon" | "RectangleGroupIcon" | "RectangleStackIcon" | "RocketLaunchIcon" | "RssIcon" | "ScaleIcon" | "ScissorsIcon" | "ServerStackIcon" | "ServerIcon" | "ShareIcon" | "ShieldCheckIcon" | "ShieldExclamationIcon" | "ShoppingBagIcon" | "ShoppingCartIcon" | "SignalSlashIcon" | "SignalIcon" | "SparklesIcon" | "SpeakerWaveIcon" | "SpeakerXMarkIcon" | "Square2StackIcon" | "Square3Stack3DIcon" | "Squares2X2Icon" | "SquaresPlusIcon" | "StarIcon" | "StopCircleIcon" | "StopIcon" | "SunIcon" | "SwatchIcon" | "TableCellsIcon" | "TagIcon" | "TicketIcon" | "TrashIcon" | "TrophyIcon" | "TruckIcon" | "TvIcon" | "UserCircleIcon" | "UserGroupIcon" | "UserMinusIcon" | "UserPlusIcon" | "UserIcon" | "UsersIcon" | "VariableIcon" | "VideoCameraSlashIcon" | "VideoCameraIcon" | "ViewColumnsIcon" | "ViewfinderCircleIcon" | "WalletIcon" | "WifiIcon" | "WindowIcon" | "WrenchScrewdriverIcon" | "WrenchIcon" | "XCircleIcon" | "XMarkIcon";
      id: string;
      name: string;
      timeFormat: string;
  }>

• getApplication

  This endpoint allows you to query for a specific application.

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
    } & {
        returnAxios?: false;
    }

    getApplication method options object

  Returns Promise<{
      dateFormat: string;
      datetimeFormat: string;
      defaultCurrency?: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BOV" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHE" | "CHF" | "CHW" | "CLF" | "CLP" | "COP" | "COU" | "CRC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MXV" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "CNY" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLE" | "SLL" | "SOS" | "SRD" | "SSP" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "USN" | "UYI" | "UYU" | "UYW" | "UZS" | "VED" | "VES" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XBA" | "XBB" | "XBC" | "XBD" | "XCD" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "XSU" | "XTS" | "XUA" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWL";
      defaultMenu?: string;
      description?: string;
      icon?: "" | "AcademicCapIcon" | "AdjustmentsHorizontalIcon" | "AdjustmentsVerticalIcon" | "ArchiveBoxArrowDownIcon" | "ArchiveBoxXMarkIcon" | "ArchiveBoxIcon" | "ArrowDownCircleIcon" | "ArrowDownLeftIcon" | "ArrowDownOnSquareStackIcon" | "ArrowDownOnSquareIcon" | "ArrowDownRightIcon" | "ArrowDownTrayIcon" | "ArrowDownIcon" | "ArrowLeftCircleIcon" | "ArrowLeftOnRectangleIcon" | "ArrowLeftIcon" | "ArrowLongDownIcon" | "ArrowLongLeftIcon" | "ArrowLongRightIcon" | "ArrowLongUpIcon" | "ArrowPathRoundedSquareIcon" | "ArrowPathIcon" | "ArrowRightCircleIcon" | "ArrowRightOnRectangleIcon" | "ArrowRightIcon" | "ArrowSmallDownIcon" | "ArrowSmallLeftIcon" | "ArrowSmallRightIcon" | "ArrowSmallUpIcon" | "ArrowTopRightOnSquareIcon" | "ArrowTrendingDownIcon" | "ArrowTrendingUpIcon" | "ArrowUpCircleIcon" | "ArrowUpLeftIcon" | "ArrowUpOnSquareStackIcon" | "ArrowUpOnSquareIcon" | "ArrowUpRightIcon" | "ArrowUpTrayIcon" | "ArrowUpIcon" | "ArrowUturnDownIcon" | "ArrowUturnLeftIcon" | "ArrowUturnRightIcon" | "ArrowUturnUpIcon" | "ArrowsPointingInIcon" | "ArrowsPointingOutIcon" | "ArrowsRightLeftIcon" | "ArrowsUpDownIcon" | "AtSymbolIcon" | "BackspaceIcon" | "BackwardIcon" | "BanknotesIcon" | "Bars2Icon" | "Bars3BottomLeftIcon" | "Bars3BottomRightIcon" | "Bars3CenterLeftIcon" | "Bars3Icon" | "Bars4Icon" | "BarsArrowDownIcon" | "BarsArrowUpIcon" | "Battery0Icon" | "Battery100Icon" | "Battery50Icon" | "BeakerIcon" | "BellAlertIcon" | "BellSlashIcon" | "BellSnoozeIcon" | "BellIcon" | "BoltSlashIcon" | "BoltIcon" | "BookOpenIcon" | "BookmarkSlashIcon" | "BookmarkSquareIcon" | "BookmarkIcon" | "BriefcaseIcon" | "BugAntIcon" | "BuildingLibraryIcon" | "BuildingOffice2Icon" | "BuildingOfficeIcon" | "BuildingStorefrontIcon" | "CakeIcon" | "CalculatorIcon" | "CalendarDaysIcon" | "CalendarIcon" | "CameraIcon" | "ChartBarSquareIcon" | "ChartBarIcon" | "ChartPieIcon" | "ChatBubbleBottomCenterTextIcon" | "ChatBubbleBottomCenterIcon" | "ChatBubbleLeftEllipsisIcon" | "ChatBubbleLeftRightIcon" | "ChatBubbleLeftIcon" | "ChatBubbleOvalLeftEllipsisIcon" | "ChatBubbleOvalLeftIcon" | "CheckBadgeIcon" | "CheckCircleIcon" | "CheckIcon" | "ChevronDoubleDownIcon" | "ChevronDoubleLeftIcon" | "ChevronDoubleRightIcon" | "ChevronDoubleUpIcon" | "ChevronDownIcon" | "ChevronLeftIcon" | "ChevronRightIcon" | "ChevronUpDownIcon" | "ChevronUpIcon" | "CircleStackIcon" | "ClipboardDocumentCheckIcon" | "ClipboardDocumentListIcon" | "ClipboardDocumentIcon" | "ClipboardIcon" | "ClockIcon" | "CloudArrowDownIcon" | "CloudArrowUpIcon" | "CloudIcon" | "CodeBracketSquareIcon" | "CodeBracketIcon" | "Cog6ToothIcon" | "Cog8ToothIcon" | "CogIcon" | "CommandLineIcon" | "ComputerDesktopIcon" | "CpuChipIcon" | "CreditCardIcon" | "CubeTransparentIcon" | "CubeIcon" | "CurrencyBangladeshiIcon" | "CurrencyDollarIcon" | "CurrencyEuroIcon" | "CurrencyPoundIcon" | "CurrencyRupeeIcon" | "CurrencyYenIcon" | "CursorArrowRaysIcon" | "CursorArrowRippleIcon" | "DevicePhoneMobileIcon" | "DeviceTabletIcon" | "DocumentArrowDownIcon" | "DocumentArrowUpIcon" | "DocumentChartBarIcon" | "DocumentCheckIcon" | "DocumentDuplicateIcon" | "DocumentMagnifyingGlassIcon" | "DocumentMinusIcon" | "DocumentPlusIcon" | "DocumentTextIcon" | "DocumentIcon" | "EllipsisHorizontalCircleIcon" | "EllipsisHorizontalIcon" | "EllipsisVerticalIcon" | "EnvelopeOpenIcon" | "EnvelopeIcon" | "ExclamationCircleIcon" | "ExclamationTriangleIcon" | "EyeDropperIcon" | "EyeSlashIcon" | "EyeIcon" | "FaceFrownIcon" | "FaceSmileIcon" | "FilmIcon" | "FingerPrintIcon" | "FireIcon" | "FlagIcon" | "FolderArrowDownIcon" | "FolderMinusIcon" | "FolderOpenIcon" | "FolderPlusIcon" | "FolderIcon" | "ForwardIcon" | "FunnelIcon" | "GifIcon" | "GiftTopIcon" | "GiftIcon" | "GlobeAltIcon" | "GlobeAmericasIcon" | "GlobeAsiaAustraliaIcon" | "GlobeEuropeAfricaIcon" | "HandRaisedIcon" | "HandThumbDownIcon" | "HandThumbUpIcon" | "HashtagIcon" | "HeartIcon" | "HomeModernIcon" | "HomeIcon" | "IdentificationIcon" | "InboxArrowDownIcon" | "InboxStackIcon" | "InboxIcon" | "InformationCircleIcon" | "KeyIcon" | "LanguageIcon" | "LifebuoyIcon" | "LightBulbIcon" | "LinkIcon" | "ListBulletIcon" | "LockClosedIcon" | "LockOpenIcon" | "MagnifyingGlassCircleIcon" | "MagnifyingGlassMinusIcon" | "MagnifyingGlassPlusIcon" | "MagnifyingGlassIcon" | "MapPinIcon" | "MapIcon" | "MegaphoneIcon" | "MicrophoneIcon" | "MinusCircleIcon" | "MinusSmallIcon" | "MinusIcon" | "MoonIcon" | "MusicalNoteIcon" | "NewspaperIcon" | "NoSymbolIcon" | "PaintBrushIcon" | "PaperAirplaneIcon" | "PaperClipIcon" | "PauseCircleIcon" | "PauseIcon" | "PencilSquareIcon" | "PencilIcon" | "PhoneArrowDownLeftIcon" | "PhoneArrowUpRightIcon" | "PhoneXMarkIcon" | "PhoneIcon" | "PhotoIcon" | "PlayCircleIcon" | "PlayPauseIcon" | "PlayIcon" | "PlusCircleIcon" | "PlusSmallIcon" | "PlusIcon" | "PowerIcon" | "PresentationChartBarIcon" | "PresentationChartLineIcon" | "PrinterIcon" | "PuzzlePieceIcon" | "QrCodeIcon" | "QuestionMarkCircleIcon" | "QueueListIcon" | "RadioIcon" | "ReceiptPercentIcon" | "ReceiptRefundIcon" | "RectangleGroupIcon" | "RectangleStackIcon" | "RocketLaunchIcon" | "RssIcon" | "ScaleIcon" | "ScissorsIcon" | "ServerStackIcon" | "ServerIcon" | "ShareIcon" | "ShieldCheckIcon" | "ShieldExclamationIcon" | "ShoppingBagIcon" | "ShoppingCartIcon" | "SignalSlashIcon" | "SignalIcon" | "SparklesIcon" | "SpeakerWaveIcon" | "SpeakerXMarkIcon" | "Square2StackIcon" | "Square3Stack3DIcon" | "Squares2X2Icon" | "SquaresPlusIcon" | "StarIcon" | "StopCircleIcon" | "StopIcon" | "SunIcon" | "SwatchIcon" | "TableCellsIcon" | "TagIcon" | "TicketIcon" | "TrashIcon" | "TrophyIcon" | "TruckIcon" | "TvIcon" | "UserCircleIcon" | "UserGroupIcon" | "UserMinusIcon" | "UserPlusIcon" | "UserIcon" | "UsersIcon" | "VariableIcon" | "VideoCameraSlashIcon" | "VideoCameraIcon" | "ViewColumnsIcon" | "ViewfinderCircleIcon" | "WalletIcon" | "WifiIcon" | "WindowIcon" | "WrenchScrewdriverIcon" | "WrenchIcon" | "XCircleIcon" | "XMarkIcon";
      id: string;
      name: string;
      timeFormat: string;
  }>
• getApplication(__namedParameters): Promise<AxiosResponse<HighSystemsResponseGetApplication, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseGetApplication, any>>

getApplicationEntityRelationshipDiagram

• getApplicationEntityRelationshipDiagram(options): Promise<{
      id: string;
      layout: any;
      relatedApplication: string;
      relatedTable?: string;
      type: "table" | "application";
  }>

• getApplicationEntityRelationshipDiagram

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
    } & {
        returnAxios?: false;
    }

    getApplicationEntityRelationshipDiagram method options object

  Returns Promise<{
      id: string;
      layout: any;
      relatedApplication: string;
      relatedTable?: string;
      type: "table" | "application";
  }>
• getApplicationEntityRelationshipDiagram(__namedParameters): Promise<AxiosResponse<HighSystemsResponseGetApplicationEntityRelationshipDiagram, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseGetApplicationEntityRelationshipDiagram, any>>

getApplicationFields

• getApplicationFields(options): Promise<any>

• getApplicationFields

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
    } & {
        returnAxios?: false;
    }

    getApplicationFields method options object

  Returns Promise<any>
• getApplicationFields(__namedParameters): Promise<AxiosResponse<HighSystemsResponseGetApplicationFields, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseGetApplicationFields, any>>

getApplicationForms

• getApplicationForms(options): Promise<{
      description?: string;
      id: string;
      layout: {
          md: {
              children?: any;
              h: number;
              id: string;
              w: number;
              x: number;
              y: number;
          }[];
          sm: {
              children?: any;
              h: number;
              id: string;
              w: number;
              x: number;
              y: number;
          }[];
          xs: {
              children?: any;
              h: number;
              id: string;
              w: number;
              x: number;
              y: number;
          }[];
      };
      name: string;
      properties: {
          addRedirect?: "record" | "referrer";
          displayCoreFields: boolean;
          displayOnMenu: boolean;
          editRedirect?: "record" | "referrer";
          useCustomLayouts: boolean;
      };
      relatedTable: string;
      rules: {
          actions: {
              fieldId?: string;
              type: "hide" | "show" | "require" | "readOnly" | "unrequire" | "editable" | "changeField" | "displayMessage";
              value?: any;
              valueType?: "value" | "fieldValue";
          }[];
          applyReverse?: boolean;
          when: string;
      }[];
      schema: {
          md: any;
          sm: any;
          xs: any;
      };
  }[]>

• getApplicationForms

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
    } & {
        returnAxios?: false;
    }

    getApplicationForms method options object

  Returns Promise<{
      description?: string;
      id: string;
      layout: {
          md: {
              children?: any;
              h: number;
              id: string;
              w: number;
              x: number;
              y: number;
          }[];
          sm: {
              children?: any;
              h: number;
              id: string;
              w: number;
              x: number;
              y: number;
          }[];
          xs: {
              children?: any;
              h: number;
              id: string;
              w: number;
              x: number;
              y: number;
          }[];
      };
      name: string;
      properties: {
          addRedirect?: "record" | "referrer";
          displayCoreFields: boolean;
          displayOnMenu: boolean;
          editRedirect?: "record" | "referrer";
          useCustomLayouts: boolean;
      };
      relatedTable: string;
      rules: {
          actions: {
              fieldId?: string;
              type: "hide" | "show" | "require" | "readOnly" | "unrequire" | "editable" | "changeField" | "displayMessage";
              value?: any;
              valueType?: "value" | "fieldValue";
          }[];
          applyReverse?: boolean;
          when: string;
      }[];
      schema: {
          md: any;
          sm: any;
          xs: any;
      };
  }[]>
• getApplicationForms(__namedParameters): Promise<AxiosResponse<HighSystemsResponseGetApplicationForms, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseGetApplicationForms, any>>

getApplicationMenu

• getApplicationMenu(options): Promise<{
      groups: any;
      id: string;
      name: string;
      relatedApplication: string;
  }>

• getApplicationMenu

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

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
        menuid: any;
    } & {
        returnAxios?: false;
    }

    getApplicationMenu method options object

  Returns Promise<{
      groups: any;
      id: string;
      name: string;
      relatedApplication: string;
  }>
• getApplicationMenu(__namedParameters): Promise<AxiosResponse<HighSystemsResponseGetApplicationMenu, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
        menuid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseGetApplicationMenu, any>>

getApplicationMenus

• getApplicationMenus(options): Promise<{
      groups: any;
      id: string;
      name: string;
      relatedApplication: string;
  }[]>

• getApplicationMenus

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

  Parameters

  • options: HighSystemsRequest & {
        appid: any;
    } & {
        returnAxios?: false;
    }

    getApplicationMenus method options object

  Returns Promise<{
      groups: any;
      id: string;
      name: string;
      relatedApplication: string;
  }[]>
• getApplicationMenus(__namedParameters): Promise<AxiosResponse<HighSystemsResponseGetApplicationMenus, any>>

• Parameters

  • __namedParameters: HighSystemsRequest & {
        appid: any;
    } & {
        returnAxios: true;
    }

  Returns Promise<AxiosResponse<HighSystemsResponseGetApplicationMenus, any>>