IoT Platform
Concepts and Terms
Application
Product
Device
Event/Reading
Alarm
Dashboard
Tenant
Sub-tenant
Master Application
How does the IoT Platform work?
IoT Platform Portal
REST API
Device SDK
IoT Platform Server
IoT Platform Manifests in detail
Using filters
Overview
Login Window
Main Window
Application Logo
Logged-in User Options
Filtering the view
How To – Quick Reference
Creating an Application
Logging in
Adding a Product
Adding a Device
Real Devices
Virtual Devices
Defining Rules
Creating a Dashboard
Dashboards
Default Dashboard
Device Pane
Detailed Pane
Application Overview
Creating a New Customized Dashboard
Rearranging dashboards
Adding Widgets
Floor Plan
Configuration
Widget Settings
Viewing Widget Data
Utilization Dashboards
Devices
Viewing Device and Group Details
Overview Tab
Properties Tab
Charts Tab
Chart Legend
Readings Tab
Commands Tab
Location Tab
Adding a Real Device
Adding a Group
Updating Firmware on a Device
Things
Views
Adding Things
Adding a Device
Adding a Group
Adding a Digital Twin
Adding a Virtual Device
Deleting a Thing
Templates
Defining a Product
Deleting a Product
Managing Device Firmware
IoT Platform CloudGateway™
How the IoT Platform CloudGatewaytm works
Group Templates
Custom Events
Custom Events Overview
Order of processing custom events
Event Field descriptions
Rules
Adding a Rule
Rules & Alarms
Understanding Rule 'Behavior'
Duplicating a Rule
Deleting a Rule
Alarms
Viewing Alarm Details
Dismissing an Alarm
Pausing an Alarm
Alarm Indications on the Map
Users
Understanding Users
User Access Hierarchy
Adding a User
Viewing User Details
Roles
Assigning a Role to Multiple Users
Profiles
Audits
Reports
Defining a Report
Defining a Filter
Managing Reports
Custom Reports
Alarms Count Report
Readings History Report
Usability Report
Communication Report
Tenant Usage Report
Data Source Usage Report
Configuring a Custom Report
Duplicating a Report
Unsubscribing From Report Emails
Applications
Adding an Application
Viewing Application Details
Deleting an Application
Changing the Application Country Code
Changing the Application Language
Settings
Creating an Application – Developer Workflow
IoT Platform Prerequisites
Logging In
Adding a Product – Developer Workflow
Adding a Product Using the REST API
Adding a Device ‒ Developer Workflow
Setting Up Real Device Connectivity
IoT Platform REST API ‒ Placing the Device’s Unique Identifier on the Device
Getting Device Access Credentials – Portal
Getting Device Access Credentials – API
Defining the Device Event Manifest
Defining a Device Event Manifest
Defining Rules – Developer Workflow
Defining Users – Developer Workflow
Defining Device Operations
Activating the IoT Platform Device SDK
IoT Platform Device SDK ‒ Sending Events to IoT Platform Server
IoT Platform Device SDK ‒ Receiving an Endpoint from the IoT Platform API
Getting Started – IoT Platform API
API Reference List
API Environment
Authentication/Request Headers
Using an Authorization Token
Using API Keys
Which Application(s) Can a User Access?
Entities
Accessing API Details
API Response Codes
Timestamps
Common Response Properties
Login – Auth
Request Properties
Response Properties
Logging In Using Multi-factor Authentication
Troubleshooting Login Problems
Gateways Endpoints
Gateways/Post
Gateways/Get(List)
Example JSON Gateways/Get (List) Request
Example JSON Gateways/Get (List) Response
Gateways/Get (Specific)
Request ‒ gateways/Get (Specific)
Gateways/Delete
Gateways/Patch or Gateways/Put
Gateways/Update Service
Gateways/Install Service
Gateways/Delete Service
Gateways/Create and install
Schema Definition Endpoints
Schema Definitions/Post
Example JSON Devices/Post
Schema Definitions/Get (List)
Example JSON Devices/Get (List) Response
Schema Definitions/Get (Specific)
Example JSON SchemaDefinitions/Get (Specific)
Schema Definitions/Delete
Request – SchemaDefinitions/Delete
SchemaDefinitions/Patch or SchemaDefinitions/put
Example JSON SchemaDefinitions/Patch
Schema Definitions/ Parse
Example JSON – parse
Tenants Endpoints
Tenants/Post
Request ‒ Tenants/Post
Response ‒ Tenants/Post
Tenants/Get (List)
Request ‒ Tenants/Get (List)
Response ‒ Tenants/Get (List)
Tenants/Get (Specific)
Request ‒ Tenants/Get (Specific)
Response ‒ Tenants/Get (Specific)
Tenants/Delete
Request ‒ Tenants/Delete
Response ‒ Tenants/Delete
Tenants/Patch or Tenants/Put
Request ‒ Tenants/Patch or Put
Response ‒ Tenants/Patch or Put
Applications Endpoints
Applications/Post
Request ‒ Applications/Post
Response ‒ Applications/Post
Applications/Get (List)
Request ‒ Applications/Get (List)
Response ‒ Applications/Get (List)
Applications/Get (Specific)
Request ‒ Applications/Get (Specific)
Response ‒ Applications/Get (Specific)
Applications/Delete
Request ‒ Applications/Delete
Response ‒ Applications/Delete
Applications/Patch or Applications/Put
Request ‒ Applications/Patch or Put
Response ‒ Applications/Patch or Put
Applications/GetAppSecret
Request ‒ Applications/GetAppSecret
Response ‒ Applications/GetAppSecret
Applications/SetDefaultPhoneCountryCode
Request ‒ Applications/SetDefaultPhoneCountryCode
Response ‒ Applications/SetDefaultPhoneCountryCode
Products Endpoints
Products/Post
Request ‒ Products/Post
Request – Products/Post – Products (General) Properties
Request ‒ Products/Post – serviceCommand Properties
Request – Products/Post – serviceEvent Properties
Request – Products/Post – serviceProperty Properties
Request – Products/Post – mediaSettings Properties
Request – Products/Post – tooltipElement Properties
Request – Products/Post – commandArgument Properties
Request – Products/Post – valueRange Properties
Request – Products/Post – eventLoggingSettings Properties
Request – Products/Post – aggregatedEventSettings Properties
Request – Products/Post – commandServiceProperty Properties
Request – Products/Post – additionalProperty Properties
Response ‒ Products/Post
Products/Get (List)
Request ‒ Products/Get (List)
Response ‒ Products/Get (List)
Products/Get (Specific)
Request ‒ Products/Get (Specific)
Response ‒ Products/Get (Specific)
Products/Delete
Request ‒ Products/Delete
Response ‒ Products/Delete
Products/Patch or Products/Put
Request ‒ Products/Patch or Put
Response ‒ Products/Patch or Put
Products/UploadFirmwareFile
Request ‒ Products/UploadFirmwareFile
Response ‒ Products/UploadFirmwareFile
Products/RemoveFirmwareFile
Request ‒ Products/RemoveFirmwareFile
Response ‒ Products/RemoveFirmwareFile
Groups Endpoints
Groups/Post
Request ‒ Groups/Post
Response ‒ Groups/Post
Groups/Get (List)
Request ‒ Groups/Get (List)
Response ‒ Groups/Get (List)
Groups/Get (Specific)
Request ‒ Groups/Get (Specific)
Response ‒ Groups/Get (Specific)
Groups/Delete
Request ‒ Groups/Delete
Response ‒ Groups/Delete
Groups/Patch or Groups/Put
Request ‒ Groups/Patch or Put
Response ‒ Groups/Patch or Put
Devices Endpoints
Devices/Post
Request ‒ Devices/Post
Response ‒ Devices/Post
Devices/Get (List)
Request ‒ Devices/Get (List)
Response ‒ Devices/Get (List)
Devices/Get (Specific)
Request ‒ Devices/Get (Specific)
Response ‒ Devices/Get (Specific)
Devices/Delete
Request ‒ Devices/Delete
Response ‒ Devices/Delete
Devices/Patch or Devices/Put
Request ‒ Devices/Patch or Put
Response ‒ Devices/Patch or Put
Devices/UpdateSettings
Request ‒ Devices/UpdateSettings
Response ‒ Devices/UpdateSettings
Devices/RemoveSetting
Request ‒ Devices/RemoveSetting
Response ‒ Devices/RemoveSetting
Devices/GetFullReading
Request ‒ Devices/GetFullReading
Response ‒ Devices/GetFullReading
Devices/Get FullReadingForMultipleDevices
Request ‒ Devices/GetFullReadingForMultipleDevices
Response ‒ Devices/GetFullReadingForMultipleDevices
Devices/GenerateSASToken
Request ‒ Devices/GenerateSASToken
Response ‒ Devices/GenerateSASToken
Devices/createVirtualDevice
Request ‒ Devices/createVirtualDevice
Response ‒ Devices/createVirtualDevice
Devices/stopVirtualDevice
Request ‒ Devices/stopVirtualDevice
Response ‒ Devices/stopVirtualDevice
Devices/UpdateDeviceFirmware
Request ‒ Devices/UpdateDeviceFirmware
Response ‒ Devices/UpdateDeviceFirmware
Things Endpoints
Things/Get (List)
Response ‒ Things/Get (List)
Things/Get (Specific)
Response ‒ Things/Get (Id)
Things Templates Endpoints
ThingsTemplates/Get (List)
Request ‒ ThingsTemplates/Get
ThingsTemplates/Get (Id)
Response ‒ ThingsTemplates/Get (Id)
Users Endpoints
Users/Post
Request ‒ Users/Post
Response ‒ Users/Post
Users/Get (List)
Request ‒ Users/Get (List)
Response ‒ Users/Get (List)
Users/Get (Specific)
Request ‒ Users/Get (Specific)
Response ‒ Users/Get (Specific)
Users/Delete
Request ‒ Users/Delete
Response ‒ Users/Delete
Users/Patch or Users/Put
Request ‒ Users/Patch or Put
Response ‒ Users/Patch or Put
Users/ResetPassword
Request ‒ Users/resetPassword
Response ‒ Users/resetPassword
Users/UnblockUser
Request ‒ Users/UnblockUser
Response ‒ Users/UnblockUser
Users/ForgotPassword
Request ‒ Users/ForgotPassword
Response ‒ Users/ForgotPassword
Users/UpdatePassword
Request ‒ Users/UpdatePassword
Response ‒ Users/UpdatePassword
Users/ChangePassword
Request ‒ Users/ChangePassword
Response ‒ Users/ChangePassword
Users/Invite
Request ‒ Users/Invite
Response ‒ Users/Invite
Users/ValidateEmail
Request ‒ Users/ValidateEmail
Response ‒ Users/ValidateEmail
Users/Me
Request ‒ Users/Me
Response ‒ Users/Me
Roles Endpoints
Roles/Post
Request ‒ Roles/Post
Response ‒ Roles/Post
Roles/Get(List)
Request ‒ Roles/Get (List)
Response ‒ Roles/Get (List)
Roles/Get(Specific)
Request ‒ Roles/Get (Specific)
Response ‒ Roles/Get (Specific)
Roles/Delete
Request ‒ Roles/Delete
Response ‒ Roles/Delete
Roles/Patch
Request ‒ Roles/Patch
Response ‒ Roles/Patch
Roles/ Get/[roleId]/Tasks
Request ‒ Roles/Get/[roleId]/Tasks
Response ‒ Roles/Get/[roleId]/Tasks
Roles/ Get/[roleId]/Endpoints
Request ‒ Roles/Get/[roleId]/Endpoints
Response ‒ Roles/Get/[roleId]/Endpoints
Roles/ Get/[roleId]/addTask
Request ‒ Roles/Post/[roleId]/addTask
Response ‒ Roles/Post/[roleId]/addTask
Roles/ Get/[roleId]/putTask
Request ‒ Roles/Post/[roleId]/putTask
Response ‒ Roles/Post/[roleId]/putTask
Roles/ Get/[roleId]/removeTask
Request ‒ Roles/Post/[roleId]/removeTask
Response ‒ Roles/Post/[roleId]/removeTask
Roles/ Get/[roleId]/Tasks
Request ‒ Roles/Get/[roleId]/Tasks
Response ‒ Roles/Get/[roleId]/Tasks
Profiles
Profiles/Post
Request ‒ Profiles/Post
Response -Profiles/Post
Profiles/Get (List)
Request ‒ Profiles/Get (List)
Response ‒ Profiles/Get (List)
Profiles/Get (Specific)
Request ‒ Profiles/Get (List)
Response – Profiles/Get (specific)
Profiles/Patch
Request ‒ Profiles/Patch
Response -Profiles/Patch
Profiles/Delete
Request ‒ Profiles/Delete
Response -Profiles/Delete
Audits Endpoints
Audits/Post
Request ‒ Audits/Post
Response ‒ Audits/Post
Audits/Get (List)
Request ‒ Audits/Get (List)
Response ‒ Audits/Get (List)
Audits/Delete
Request ‒ Audits/Delete
Response ‒ Audits/Delete
Audits/Patch or Audits/Put
Request ‒ Audits/Patch or Put
Response ‒ Audits/Patch or Put
Rules Endpoints
Instantaneous Rules, Conditions and Events
Limitations
Rules/Post
Request ‒ Rules/Post
Request – Rules/Post – Rules (General) Properties
Request – Rules/Post – Actions (General) Properties
Request – Rules/Post – emailProperties
Request – Rules/Post – smsProperties
Request – Rules/Post – phoneCallProperties
Request – Rules/Post – alarmInstanceProperties
Request – Rules/Post – eventLogEntryProperties
Request – Rules/Post – commandProperties
Request – Rules/Post – webServiceProperties
Request – Rules/Post – additionalPropertyProperties
Request – Rules/Post –propertyOperationProperties
Request – Rules/Post – ruleRecurrenceSettings Properties
Request – Rules/Post – conditions Properties
Request – Rules/Post – ConditionSettings Properties
Request – Rules/Post – readingCondition Properties
Request – Rules/Post – relativeMeetingSchedule Properties
Response ‒ Rules/Post
Rules/Get (List)
Request ‒ Rules/Get (List)
Response ‒ Rules/Get (List)
Rules/Get (Specific)
Request ‒ Rules/Get (Specific)
Response ‒ Rules/Get (Specific)
Rules/Delete
Request ‒ Rules/Delete
Response ‒ Rules/Delete
Rules/Patch or Rules/Put
Request ‒ Rules/Patch or Put
Response ‒ Rules/Patch or Put
Alarm Instances Endpoints
AlarmInstances/Get (List)
Request ‒ AlarmInstances/Get (List)
Response ‒ AlarmInstances/Get (List)
AlarmInstances/Post
Request ‒ AlarmInstances/Post
Response ‒ AlarmInstances/Post
AlarmInstances/Delete
Request ‒ AlarmInstances/Delete
Response ‒ AlarmInstances/Delete
AlarmInstances/Get (Specific)
Request ‒ AlarmInstances/Get (Specific)
Response ‒ AlarmInstances/Get (Specific)
AlarmInstances/Patch or AlarmInstances/Put
Request ‒ AlarmInstances/Patch or Put
Response ‒ AlarmInstances/Patch or Put
AlarmInstances/Clear
Request ‒ AlarmInstances/Clear
Response ‒ AlarmInstances/Clear
AlarmInstances/Snooze
Request ‒ AlarmInstances/Snooze
Response ‒ AlarmInstances/Snooze
Alarm Instances/Dismiss
Request ‒ AlarmInstances/Dismiss
Response ‒ AlarmInstances/Dismiss
Alarm Instances/DeleteAll
Request ‒ AlarmInstances/DeleteAll
Response ‒ AlarmInstances/DeleteAll
Alarm Instances/Dismiss All
Request ‒ AlarmInstances/DismissAll
Response ‒ AlarmInstances/DismissAll
Reports Endpoints
Reports/Post
Request ‒ Reports/Post
Response ‒ Reports/Post
Reports/Get (List)
Request ‒ Reports/Get (List)
Response ‒ Reports/Get (List)
Reports/Get (Specific)
Request ‒ Reports/Get (Specific)
Response ‒ Reports/Get (Specific)
Reports/Delete
Request ‒ Reports/Delete
Response ‒ Reports/Delete
Reports/Patch or Reports/Put
Request ‒ Reports/Patch or Put
Response ‒ Reports/Patch or Put
Reports/[id]/share
Request ‒ Reports/{id}/share
Response ‒ Reports/[id]/share