1. OpenGate Documentation > 
  2. OpenGate Libraries > 
  3. OpenGate JS > 
  4. JS Reference > 
  5. util > 
  6. South Amplia REST

South Amplia REST

v20.5.1-SNAPSHOT
  • Home
  • Presenting OpenGate
    • Introduction to OpenGate
    • OpenGate architecture
    • Main features
  • How to
    • 1. Accessing OpenGate
    • 2. Users and Roles
    • 3. Data Modeling
    • 4. Entity Provisioning
    • 5. Data Collection
    • 6. Connector Functions
    • 7. Workspaces & Dashboards
    • 8. Operations
    • 9. Easy mode rules
    • 10. Analytics and Datalab
  • OpenGate API
    • Management
      • Organizations
        • Channels - Device Groups
          • Entities
            • Entity types & statuses
            • Devices
            • Subscriptions
            • Subscribers
            • Assets
            • Bulk provisioning
              • Classic bulk provisioning
              • Provision functions for bulk provisioning
                • JavaScript API
                • Main Module
                • Entities Utils
                • Actions Utils
                • V8 Utils API
                • Error API
          • Rules
            • Advanced Rules Mode
            • Executing Actions
            • Alarm utils
            • Notifications utils
            • Operation utils
            • Provision utils
            • Datastreams and values
            • Dates manipulation
            • Logging utils
            • Cypher utils
            • Utils
            • Default rules catalog
        • Work groups
          • Work groups relations
          • Geo-clusters
          • Users
            • User login
            • User profiles
          • Software and configuration bundles
        • Geo-areas
        • Manufacturers & Models
          • Manufacturers
          • Models
        • Data models
          • Default schemas
          • Default data models
        • Tags
        • Tickets
      • Manufacturer & Model Catalog
        • Manufacturers catalog API Spec
        • Models catalog API Spec
      • Usage plans
      • Certificates
      • Mobile operators
        • APN
        • GGSN
    • Data retrieval
      • What you can query
      • Data Lake
        • Filtering
        • Selecting
        • Sorting
        • Grouping
        • Pagination
        • Summary
      • Query dialects
      • Alarms
      • Data points
      • Data sets
        • Defining a data set
        • Querying a data set
      • Data streams
      • Time series
        • Defining a time series
        • Querying a time series
        • Time Series Functions
          • JavaScript API
      • Analytics
      • Notebook scheduler
    • Operations
      • Jobs
      • Tasks
      • Operation parameters
      • Callbacks
      • Execution flows
      • Status reference
      • Operation types
      • Default operations catalog
      • Examples
        • Update operation
      • API reference
    • Debugging
      • Functions Logger Service
      • JS Logging API
    • Device integration
      • Supported protocols
      • HTTP
        • Data collection
        • Operations
          • Operations driven by platform
          • Operations driven by device
          • Security tips for operations
      • MQTT
        • Data collection
        • Operations
          • Examples
            • Refresh info
            • Reboot equipment
            • Equipment diagnostic
      • Websocket
      • CoAP
        • Data collection
        • Operations
      • Meter and industrial protocols
      • Remote access
      • RADIUS accounting
      • Topology
      • Deployment Elements
      • Connector Functions
        • Core JavaScript API
          • JavaScript API
          • Entity JavaScript API
          • Inner Collections API
          • Operation Steps API
          • Operation JavaScript API
          • Provision JavaScript API
          • Concatenated Connector Functions API
          • UTILS JavaScript API
          • Cryptography API
        • Protocol APIs
          • HTTP JavaScript API
          • MQTT JavaScript API
          • Websocket JavaScript API
          • CoAP API
          • DLMS JavaScript API
          • DLMS Gas JavaScript API
          • IEC102 JavaScript API
          • Kite Javascript API
          • SNMP JavaScript API
          • SSH JavaScript API
          • Telnet Javascript API
          • ICMP JavaScript API
          • ICMP Response Javascript
        • Catalog API
    • Security
      • Authentication
        • JWT
        • API key
      • User password reset
    • Catalogs
      • Operators
      • Response status and error messages
      • Time zones
  • OpenGate Libraries
    • OpenGate JS
      • JS Reference
        • alarms
          • actions
            • Alarm Action Builder
            • Alarm Attend Builder
            • Alarm Close Builder
            • Operation
          • Alarm Actions
        • areas
          • Area Finder
          • Areas
        • bulk
          • Bulk Execution Finder
          • Bulk Finder
        • bundles
          • Bundle Finder
          • Bundles
          • deployment
            • Deployment Element
        • channels
          • Channel Finder
          • Channels
        • collection
          • devices
            • collect
              • Comms Module Message
              • Datapoint
              • Datastream
              • Event
              • Hardware
              • Location
              • Mobile
              • Power Supply
              • Software
              • Storage
              • Subscriber
              • Subscription
              • Temperature
              • Usage
            • Device Message
        • connectorsFunctions
          • catalog
            • Connector Functions
            • Connector Functions Catalog
            • Connector Functions Catalog Finder
          • configuration
            • Connector Functions
            • Connector Functions Finder
            • Connector Functions Helper
        • datasets
          • Datasets
        • entities
          • Device Finder
          • Entity Finder
          • Subscribers Finder
          • Subscriptions Finder
          • Ticket Finder
        • Generic Finder
        • geocluster
          • Geocluster
          • Geocluster Finder
        • Internal Open Gate API
        • iot
          • catalog
            • Category
            • Datastream
            • Qrating
          • datamodels
            • Datamodels
            • Datamodels Finder
            • Datamodels Helper
        • manufacturers
          • Manufacturer Finder
          • Manufacturer Media
          • Manufacturers
          • Model Finder
          • Model Media
          • Models
        • notebookScheduler
          • Notebook Finder
          • Notebook Launcher
          • Notebook Scheduler
          • Scheduler Finder
        • operations
          • catalog
            • Append Entities By
            • Base Operation Builder
            • Operation
            • parameters
              • Base Parameter Builder With Parent
              • Parameter Builder Factory
            • period
              • Execute Each Builder
              • Execute Every Builder
              • pattern
                • By Generic
                • By Month
                • By Week
                • By Year
              • Periodicity Update Builder
          • Operation Actions
          • Operation Finder
          • Operations
          • Periodicity Actions
        • operationTypes
          • Operation Type
          • Operation Type Finder
          • Operation Types Catalog
        • organization_manufacturer
          • Manufacturer Finder
          • Manufacturers
          • Model Finder
          • Models
        • organization_software
          • Software Finder
          • Softwares
        • organizations
          • Domain Finder
          • Organization Finder
          • Organizations
        • plan
          • Device Plans
          • Device Plans Finder
          • Organization Plans
          • Organization Plans Finder
        • provision
          • Base Provision
          • bulk
            • Bulk Execution Builder
          • country
            • Countries Catalog
          • entities
            • 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
        • provisionProcessors
          • Provision Processors
          • provision Processors Finder
        • rulesConfiguration
          • Rule Configurations
          • Rule Configurations Actions
          • Rule Configurations Catalog
          • Rule Configurations Finder
          • Rule Configurations Helper
        • schedule
          • History Finder
          • Image Execution
          • Image Execution Finder
          • Pipeline
          • Pipeline Finder
          • Rest Request
          • Rest Request Finder
          • Schedule History Finder
        • searching
          • Asset Search
          • Base Search
          • builder
            • Administrative State Search Builder
            • Alarms Search Builder
            • Allowed Resource Type Search Builder
            • Areas Search Builder
            • Assets Search Builder
            • Basic Types Search Builder
            • Bulk Execution Search Builder
            • Bulk Search Builder
            • Bundles Search Builder
            • Certificates Search Builder
            • Channels Search Builder
            • Communications Module Type Search Builder
            • Country Codes Search Builder
            • Datamodels Search Builder
            • Datapoints Search Builder
            • Dataset Entities Search Builder
            • Dataset Search Builder
            • Datasets Catalog Search Builder
            • Datastreams Search Builder
            • Devices Search Builder
            • Entities Search Builder
            • Executions History Search Builder
            • Executions Search Builder
            • Feeds Search Builder
            • Fields Definition Search Builder
            • Flattened Search Builder
            • Io T Datastream Access Search Builder
            • Io T Datastream Period Search Builder
            • Io T Datastream Storage Period Search Builder
            • Mobile Phone Provider Search Builder
            • Operation Types Builder
            • Operational Status Search Builder
            • Operations Search Builder
            • Organizations Search Builder
            • Pre Filtered Search Builder
            • Raw Search Builder
            • Resource Type Search Builder
            • Rule Configuration Severity Search Builder
            • Rule Mode Search Builder
            • Rule Type Search Builder
            • Rules Search Builder
            • Search Builder
            • Search With Summary Builder
            • Service Group Search Builder
            • Softwares Search Builder
            • Subscribers Search Builder
            • Subscriptions Search Builder
            • Tasks Search Builder
            • Ticket Priority Search Builder
            • Ticket Severity Search Builder
            • Ticket Status Search Builder
            • Tickets Search Builder
            • Timeserie Dataset Builder
            • Timeserie Downsampler Builder
            • Timeserie Search Builder
            • Timezone Search Builder
            • User Languages Search Builder
            • User Profiles Search Builder
            • Users Search Builder
            • Workgroups Search Builder
          • Device Search
          • Entity Search
          • error
            • Search Builder Error
          • Filter Builder
          • Search
          • Search Without Limit
          • Select Builder
          • Static Search
          • WP Search
        • security
          • Certificate Finder
          • Certificates
          • Security
        • timeseries
          • Timeseries
          • Timeseries Finder
        • timeseriesFunctionsCatalog
          • Timeseries Function
          • Timeseries Function Finder
          • Timeseries Functions Helper
        • users
          • User
          • User Finder
        • util
          • Expression
          • North Amplia REST
          • Select Element
          • South Amplia REST
        • workgroups
          • Workgroup Finder
          • Workgroup Relations
          • Workgroup Relations Finder
          • Workgroups
    • OpenGate Data Python
      • Python Reference
        • AI Models
        • AI Pipelines
        • AI Transformers
        • Collection
        • Datasets
        • File Connector
        • OpenGate Client
        • Provision
        • Rules
        • Searching
        • Timeseries
        • Utils
  • OpenGate UX
    • Login
    • Workspaces
      • Dashboards
        • Widgets
          • Advanced
            • BIM/IFC Widget
              • Change Item Status by Battery Charge
              • All Entities Average Battery
            • Custom Action
              • Custom Action Example
              • Custom Action Entity Search Example
            • Custom Chart
              • Custom Chart Examples
              • Custom HeatMap Chart Example
            • Custom Table
              • Custom Table Example
              • External API (USGS Earthquakes)
              • Filtered Entity Retrieval
              • Server Pagination Example (Reqres)
              • Battery Level Pie Chart
            • Open HMI/Custom Image
              • Time-based SVG
          • Browsers
            • Certificates Browser
            • Configured Operations Navigator
            • Connector functions browser
            • Data models Browser
            • Data sets Browser
            • Device Plans Browser
            • Entities Software Browser
            • Image Execution Scheduler Browser
            • Manufacturers and Models Browser
            • Notebooks scheduler
            • Organization Plans Browser
            • Organizations Browser
            • Periodic Operations Browser
            • Periodic operations calendar
            • Pipeline Scheduler Browser
            • Provisioning Functions Navigator
            • Rest Request Scheduler Browser
            • Rules Configuration Browser
            • Specific types Browser
            • Time Series Browser
            • Time series function Browser
          • Charts
            • Data Stream history
            • Data Stream timeline
            • Devices data stream history
            • Multiple Time Series history
            • Summary Chart
            • Time Series data timeline
            • Time Series history
          • Entity 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
          • Listings
            • 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
            • Schedulers History List
            • Tickets List
            • Time Series data List
            • Users List
          • Maps
            • Areas Map
            • Maps
            • Tracking
          • Miscellaneous
            • Clock
            • Iframe
            • Markdown
        • Wizards
          • Administration
            • Create Manufacturer
            • Create manufacturer model
            • Create new Area
            • Create new Channel
            • Create new Data Model
            • Create new Device Plan
            • Create new notebook scheduler
            • Create new Organization
            • Create new Organization Plan
            • 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
          • Operations
            • Create new Operation
            • Data collection
            • Image Execution Scheduler
            • Pipeline Processor Scheduler
            • Rest Request Scheduler
          • Resources
            • 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
    • Administration
      • Entities
        • Assets Administration
        • Devices Administration
        • Specific Types Administration
        • Subscribers Administration
        • Subscriptions Administration
      • Organization
        • Advanced bulks administration
        • Areas Administration
        • Bulk Administration
        • Bundles Administration
        • Certificates Administration
        • Connector Functions Administration
        • Data models Administration
        • Data Sets Administration
        • Manufacturers Administration
        • Operation Types Administration
        • Organizations Administration
        • Provision Functions Administration
        • Rules Administration
        • Time series Administration
        • Time series functions Administration
        • User Administration
      • Workspaces & Dashboards
        • Custom Operations Views
        • Custom Organization Labels
        • Widgets Defaults
        • Workspaces templates
        • Collection Wizard
        • Organization Files
        • Provision Wizard
        • Scripts Formatters
        • Web Areas & Sections
        • Web Permissions
        • Web Preferences
    • Devices Emulator
      • Map
      • Operation
      • Sensors
      • System
    • Analytics
      • Analytics related
        • Data models Administration
        • Rules Administration
    • Operation System Support
      • Entities
        • Assets Administration
        • Devices Administration
        • Maps
        • Subscribers Administration
        • Subscriptions Administration
      • Notices and incidents
        • Alarms
        • Alarms Summary
        • Tickets
        • Tickets Summary
      • Operations
        • Operations List
        • Operations Summary
        • Periodic Operations
  • Legal