- SouthAmpliaREST Objects

OpenGate Documentation >
OpenGate Libraries >
OpenGate JS >
JS Reference >
util >
South Amplia REST

South Amplia REST

SouthAmpliaREST

SouthAmpliaREST Objects

class SouthAmpliaREST()

constructor

function constructor()

Arguments:

_options *
headers *

OpenGate Doc

18.1.0.2

Search

Home

Submenu Presenting OpenGatePresenting OpenGate
Submenu How toHow to
Submenu OpenGate APIOpenGate API
- Submenu ManagementManagement
  - Submenu OrganizationsOrganizations
    - Submenu Channels - Device GroupsChannels - Device Groups
      - Submenu EntitiesEntities
        
        Entity types & statuses
        
        Devices
        
        Subscriptions
        
        Subscribers
        
        Assets
        
        Submenu Bulk provisioningBulk provisioning
        
        Classic bulk provisioning
        
        Submenu Provision functions for bulk provisioningProvision functions for bulk provisioning
        
        JavaScript API
      - Submenu RulesRules
        
        Default rules catalog
    - Submenu Work groupsWork groups
      - Work groups relations
      - Geo-clusters
      - Software and configuration bundles
      - Submenu UsersUsers
        
        User login
        
        User profiles
    - Geo-areas
    - Submenu Manufacturers & ModelsManufacturers & Models
      - Manufacturers
      - Models
    - Submenu Data modelsData models
      - Default schemas
      - Default data models
    - Tags
    - Tickets
  - Submenu Manufacturer & Model CatalogManufacturer & Model Catalog
    - Manufacturers catalog API Spec
    - Models catalog API Spec
  - Usage plans
  - Certificates
  - Submenu Mobile operatorsMobile operators
    - APN
    - GGSN
- Submenu Data retrievalData retrieval
  - Submenu Data LakeData Lake
    - Filtering
    - Selecting
    - Sorting
    - Grouping
    - Pagination
    - Summary
  - Analytics
  - Notebook scheduler
  - Alarms
  - Data points
  - Data sets
  - Data streams
  - Submenu Time seriesTime series
    - Submenu Time Series FunctionsTime Series Functions
      - JavaScript API
- Submenu DebuggingDebugging
  - Functions Logger Service
  - JS Logging API
- Submenu OperationsOperations
  - Submenu Running operationsRunning operations
  - Custom operations
  - Default operations catalog
  - Submenu Operation examplesOperation examples
    - Update operation
- Submenu Device integrationDevice integration
  - Deployment Elements
  - Submenu HTTPHTTP
    - Data collection
    - Submenu OperationsOperations
  - Submenu MQTTMQTT
    - Data collection
    - Submenu OperationsOperations
      - Submenu ExamplesExamples
        
        Equipment diagnostic
        
        Reboot equipment
        
        Refresh info
  - Websocket
  - Topology
  - Submenu Connector FunctionsConnector Functions
- Submenu Artificial IntelligenceArtificial Intelligence
  - Guide
- Submenu SecuritySecurity
  - Submenu AuthenticationAuthentication
    - JWT
    - API key
  - User password reset
- Submenu CatalogsCatalogs
Submenu OpenGate LibrariesOpenGate Libraries
- Submenu OpenGate JSOpenGate JS
  - Submenu JS ReferenceJS Reference
    - Submenu alarmsalarms
      - Submenu actionsactions
        
        Alarm Action Builder
        
        Alarm Attend Builder
        
        Alarm Close Builder
        
        Operation
      - Alarm Actions
    - Submenu areasareas
      - Area Finder
      - Areas
    - Submenu bulkbulk
      - Bulk Execution Finder
      - Bulk Finder
    - Submenu bundlesbundles
      - Bundle Finder
      - Bundles
      - Submenu deploymentdeployment
        
        Deployment Element
    - Submenu channelschannels
      - Channel Finder
      - Channels
    - Submenu collectioncollection
      - Submenu devicesdevices
        
        Submenu collectcollect
        
        Comms Module Message
        
        Datapoint
        
        Datastream
        
        Event
        
        Hardware
        
        Location
        
        Mobile
        
        Power Supply
        
        Software
        
        Storage
        
        Subscriber
        
        Subscription
        
        Temperature
        
        Usage
        
        Device Message
    - Submenu connectorsFunctionsconnectorsFunctions
      - Submenu catalogcatalog
        
        Connector Functions
        
        Connector Functions Catalog
        
        Connector Functions Catalog Finder
      - Submenu configurationconfiguration
        
        Connector Functions
        
        Connector Functions Finder
        
        Connector Functions Helper
    - Submenu datasetsdatasets
      - Datasets
    - Submenu domainsdomains
      - Domain Finder
      - Domains
    - Submenu entitiesentities
    - Generic Finder
    - Submenu geoclustergeocluster
      - Geocluster
      - Geocluster Finder
    - Internal Open Gate API
    - Submenu iotiot
      - Submenu catalogcatalog
        
        Category
        
        Datastream
        
        Qrating
      - Submenu datamodelsdatamodels
        
        Datamodels
        
        Datamodels Finder
        
        Datamodels Helper
    - Submenu manufacturersmanufacturers
    - Submenu notebookSchedulernotebookScheduler
    - Submenu operationsoperations
      - Submenu catalogcatalog
        
        Append Entities By
        
        Base Operation Builder
        
        Operation
        
        Submenu parametersparameters
        
        Base Parameter Builder With Parent
        
        Parameter Builder Factory
        
        Submenu periodperiod
        
        Execute Each Builder
        
        Execute Every Builder
        
        Submenu patternpattern
        
        By Generic
        
        By Month
        
        By Week
        
        By Year
        
        Periodicity Update Builder
      - Operation Actions
      - Operation Finder
      - Operations
      - Periodicity Actions
    - Submenu operationTypesoperationTypes
    - Submenu organization_manufacturerorganization_manufacturer
    - Submenu organization_softwareorganization_software
      - Software Finder
      - Softwares
    - Submenu organizationsorganizations
      - Organization Finder
      - Organizations
    - Submenu provisionprovision
      - Base Provision
      - Submenu bulkbulk
        
        Bulk Execution Builder
      - Submenu countrycountry
        
        Countries Catalog
      - Submenu entitiesentities
        
        Asset Builder
        
        Bulk Builder
        
        Complex Builder
        
        Csv Bulk Builder
        
        Device Builder
        
        Entity Builder
        
        Json Bulk Builder
        
        Json Flattened Bulk Builder
        
        Simple Builder
        
        Subscriber Builder
        
        Subscription Builder
        
        Ticket Builder
    - Provision Generic Finder
    - Submenu provisionProcessorsprovisionProcessors
      - Provision Processors
      - provision Processors Finder
    - Submenu rulesConfigurationrulesConfiguration
    - Submenu scheduleschedule
    - Submenu searchingsearching
    - Submenu securitysecurity
    - Submenu timeseriestimeseries
      - Timeseries
      - Timeseries Finder
    - Submenu timeseriesFunctionsCatalogtimeseriesFunctionsCatalog
    - Submenu usersusers
      - User
      - User Finder
    - Submenu utilutil
    - Submenu workgroupsworkgroups
- Submenu OpenGate Data PythonOpenGate Data Python
  - Submenu Python ReferencePython Reference
    - AI Models
    - AI Pipelines
    - AI Transformers
    - Collection
    - Datasets
    - File Connector
    - OpenGate Client
    - Provision
    - Rules
    - Searching
    - Timeseries
    - Utils
Submenu OpenGate UXOpenGate UX
- Login
- Submenu WorkspacesWorkspaces
  - Submenu DashboardsDashboards
    - Submenu WidgetsWidgets
      - Submenu AdvancedAdvanced
        
        Submenu BIM/IFC WidgetBIM/IFC Widget
        
        Change Item Status by Battery Charge
        
        All Entities Average Battery
        
        Submenu Custom ActionCustom Action
        
        Custom Action Example
        
        Custom Action Entity Search Example
        
        Submenu Custom ChartCustom Chart
        
        Custom Chart Examples
        
        Custom HeatMap Chart Example
        
        Submenu Custom TableCustom Table
        
        Custom Table Example
        
        External API (USGS Earthquakes)
        
        Filtered Entity Retrieval
        
        Server Pagination Example (Reqres)
        
        Battery Level Pie Chart
        
        Submenu Open HMI/Custom ImageOpen HMI/Custom Image
        
        Time-based SVG
      - Submenu BrowsersBrowsers
        
        Certificates Browser
        
        Configured Operations Navigator
        
        Connector functions browser
        
        Data models Browser
        
        Data sets Browser
        
        Entities Software Browser
        
        Manufacturers and Models Browser
        
        Notebooks scheduler
        
        Organizations Browser
        
        Periodic Operations Browser
        
        Periodic operations calendar
        
        Provisioning Functions Navigator
        
        Rules Configuration Browser
        
        Specific types Browser
        
        Time Series Browser
        
        Time series function Browser
      - Submenu ChartsCharts
        
        Data Stream history
        
        Data Stream timeline
        
        Devices data stream history
        
        Multiple Time Series history
        
        Summary Chart
        
        Time Series data timeline
        
        Time Series history
      - Submenu Entity DetailsEntity Details
        
        Asset Related
        
        Data stream Last Value
        
        Device Hierarchy Graph
        
        Entity Information Details
        
        Image Widget
        
        Ticket Data stream Last value
        
        Ticket Information Details
        
        Time series last value
      - Submenu ListingsListings
        
        Areas List
        
        Bulk List
        
        Bulk List (Advanced)
        
        Bundles List
        
        Data Points List
        
        Data Set data List
        
        Entities Alarms List
        
        Entities List
        
        Executions List
        
        Operations List
        
        Tickets List
        
        Time Series data List
        
        Users List
      - Submenu MapsMaps
        
        Areas Map
        
        Maps
        
        Tracking
      - Submenu MiscellaneousMiscellaneous
        
        Clock
        
        Iframe
        
        Markdown
    - Submenu WizardsWizards
      - Submenu AdministrationAdministration
        
        Create Manufacturer
        
        Create manufacturer model
        
        Create new Area
        
        Create new Channel
        
        Create new Data Model
        
        Create new notebook scheduler
        
        Create new Organization
        
        Create new pipeline processor
        
        Create new Provision Function
        
        Create new WorkGroup
        
        Dataset creation wizard
        
        Entities software wizard
        
        Operations Management
        
        Provision Wizards
        
        Rules
        
        Time Series
        
        Time series functions wizard
        
        Upload new data transformer
        
        Upload new predictive model
        
        User
      - Submenu OperationsOperations
        
        Create new Operation
        
        Data collection
      - Submenu ResourcesResources
        
        Connector Functions
        
        Create new Asset
        
        Create new Bundle
        
        Create new Certificate
        
        Create new Entity
        
        Create new Subscriber
        
        Create new Subscription
        
        Create new Ticket
        
        Upload Bulk File
        
        Upload bulk file (Advanced)
    - Templates
- Submenu AdministrationAdministration
- Submenu Devices EmulatorDevices Emulator
  - Map
  - Operation
  - Sensors
  - System
- Submenu AnalyticsAnalytics
  - Submenu Analytics relatedAnalytics related
    - Data models Administration
    - Rules Administration
- Submenu Operation System SupportOperation System Support
  - Submenu EntitiesEntities
  - Submenu Notices and incidentsNotices and incidents
  - Submenu OperationsOperations
Legal

Language
Theme

Built with by Hugo