Usage plans

API specification

OpenGate Doc

17.2.0

Search

Home

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 UXOpenGate UX
- Login
- Submenu WorkspacesWorkspaces
  - Submenu DashboardsDashboards
    - Submenu WidgetsWidgets
      - Submenu AdvancedAdvanced
        
        BIM/IFC Widget
        
        Custom Action
        
        Custom Chart
        
        Custom Table
        
        Open HMI
      - Submenu BrowsersBrowsers
        
        Certificates Browser
        
        Configured Operations Navigator
        
        Connector functions browser
        
        Data models Browser
        
        Data sets Browser
        
        Data transformers
        
        Manufacturers and Models Browser
        
        Organizations Browser
        
        Periodic Operations Browser
        
        Periodic operations calendar
        
        Pipeline processors
        
        Predictive models
        
        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 Organization
        
        Create new pipeline processor
        
        Create new Provision Function
        
        Create new WorkGroup
        
        Dataset creation 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 EntitiesEntities
  - Submenu OrganizationOrganization
  - Submenu Workspaces & DashboardsWorkspaces & Dashboards
- Submenu Devices EmulatorDevices Emulator
  - Map
  - Operation
  - Sensors
  - System
- Submenu AnalyticsAnalytics
  - Submenu Artificial IntelligenceArtificial Intelligence
  - 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