omni_core_model_and_state_management_apis

OmniCoreModelAndStateManagementApi - JavaScript client for omni_core_model_and_state_management_apis This is an OmniCore Model and State Management server.

• API version: 1.8.1
• Package version: 1.8.1
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit http://www.korewireless.com

Installation

For Node.js

npm

npm install omni_core_model_and_state_management_apis --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var OmniCoreModelAndStateManagementApi = require('omni_core_model_and_state_management_apis');

var defaultClient = OmniCoreModelAndStateManagementApi.ApiClient.instance;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['x-api-key'] = "Token"
// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new OmniCoreModelAndStateManagementApi.DeviceApi()
var subscriptionId = "subscriptionId_example"; // {String} Subscription ID
var registryId = "registryId_example"; // {String} Registry ID
var bind = new OmniCoreModelAndStateManagementApi.BindRequest(); // {BindRequest} application/json
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.bindDevice(subscriptionId, registryId, bind, callback);

Documentation for API Endpoints

All URIs are relative to https://api.korewireless.com/omnicore

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- OmniCoreModelAndStateManagementApi.DeviceApi | bindDevice | POST /subscriptions/{subscriptionId}/registries/{registryId}/bindDeviceToGateway | OmniCoreModelAndStateManagementApi.DeviceApi | bindDevices | POST /subscriptions/{subscriptionId}/registries/{registryId}/bindDevicesToGateway | OmniCoreModelAndStateManagementApi.DeviceApi | blockDeviceCommuncation | PUT /subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/communication | OmniCoreModelAndStateManagementApi.DeviceApi | createDevice | POST /subscriptions/{subscriptionId}/registries/{registryId}/devices | OmniCoreModelAndStateManagementApi.DeviceApi | deleteDevice | DELETE /subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} | OmniCoreModelAndStateManagementApi.DeviceApi | getConfig | GET /subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/configVersions | OmniCoreModelAndStateManagementApi.DeviceApi | getDevice | GET /subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} | OmniCoreModelAndStateManagementApi.DeviceApi | getDevices | GET /subscriptions/{subscriptionId}/registries/{registryId}/devices | OmniCoreModelAndStateManagementApi.DeviceApi | getStates | GET /subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/states | OmniCoreModelAndStateManagementApi.DeviceApi | sendCommandToDevice | POST /subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/sendCommandToDevice | OmniCoreModelAndStateManagementApi.DeviceApi | unBindDevice | POST /subscriptions/{subscriptionId}/registries/{registryId}/unbindDeviceFromGateway | OmniCoreModelAndStateManagementApi.DeviceApi | unBindDevices | POST /subscriptions/{subscriptionId}/registries/{registryId}/unbindDevicesFromGateway | OmniCoreModelAndStateManagementApi.DeviceApi | updateConfigurationToDevice | POST /subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/updateConfigurationToDevice | OmniCoreModelAndStateManagementApi.DeviceApi | updateCustomOnboardRequest | POST /subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/updateCustomOnboardRequest | OmniCoreModelAndStateManagementApi.DeviceApi | updateDevice | PATCH /subscriptions/{subscriptionId}/registries/{registryId}/devices/{deviceId} | OmniCoreModelAndStateManagementApi.MetricsApi | getMetrics | GET /subscriptions/{subscriptionId}/metrics | OmniCoreModelAndStateManagementApi.RegistryApi | createRegistry | POST /subscriptions/{subscriptionId}/registries | OmniCoreModelAndStateManagementApi.RegistryApi | deleteRegistry | DELETE /subscriptions/{subscriptionId}/registries/{registryId} | OmniCoreModelAndStateManagementApi.RegistryApi | getRegistries | GET /subscriptions/{subscriptionId}/registries | OmniCoreModelAndStateManagementApi.RegistryApi | getRegistry | GET /subscriptions/{subscriptionId}/registries/{registryId} | OmniCoreModelAndStateManagementApi.RegistryApi | sendBroadcastToDevices | POST /subscriptions/{subscriptionid}/registries/{registryId}/sendBroadcastToDevice | OmniCoreModelAndStateManagementApi.RegistryApi | updateRegistry | PATCH /subscriptions/{subscriptionId}/registries/{registryId} | OmniCoreModelAndStateManagementApi.SinkApi | createSink | POST /subscriptions/{subscriptionId}/sinks | OmniCoreModelAndStateManagementApi.SinkApi | deleteSink | DELETE /subscriptions/{subscriptionId}/sinks/{sinkId} | OmniCoreModelAndStateManagementApi.SinkApi | getASink | GET /subscriptions/{subscriptionId}/sinks/{sinkId} | OmniCoreModelAndStateManagementApi.SinkApi | getSinks | GET /subscriptions/{subscriptionId}/sinks | Get All Sinks

Documentation for Models

• OmniCoreModelAndStateManagementApi.BindRequest
• OmniCoreModelAndStateManagementApi.BindRequestIdsGateway
• OmniCoreModelAndStateManagementApi.BlockCommunicationBody
• OmniCoreModelAndStateManagementApi.Config
• OmniCoreModelAndStateManagementApi.CustomOnboard
• OmniCoreModelAndStateManagementApi.Device
• OmniCoreModelAndStateManagementApi.DeviceCommand
• OmniCoreModelAndStateManagementApi.DeviceConfig
• OmniCoreModelAndStateManagementApi.DeviceConfiguration
• OmniCoreModelAndStateManagementApi.DeviceCredential
• OmniCoreModelAndStateManagementApi.DeviceRegistry
• OmniCoreModelAndStateManagementApi.DeviceState
• OmniCoreModelAndStateManagementApi.ErrorFrame
• OmniCoreModelAndStateManagementApi.ErrorStatus
• OmniCoreModelAndStateManagementApi.EventNotificationConfig
• OmniCoreModelAndStateManagementApi.GatewayConfig
• OmniCoreModelAndStateManagementApi.GenericErrorResponse
• OmniCoreModelAndStateManagementApi.HttpConfig
• OmniCoreModelAndStateManagementApi.Info
• OmniCoreModelAndStateManagementApi.ListDeviceConfigVersionsResponse
• OmniCoreModelAndStateManagementApi.ListDeviceRegistries
• OmniCoreModelAndStateManagementApi.ListDeviceStatesResponse
• OmniCoreModelAndStateManagementApi.ListDevicesResponse
• OmniCoreModelAndStateManagementApi.ListSinks
• OmniCoreModelAndStateManagementApi.LogLevel
• OmniCoreModelAndStateManagementApi.Metrics
• OmniCoreModelAndStateManagementApi.MetricsDetails
• OmniCoreModelAndStateManagementApi.MqttConfig
• OmniCoreModelAndStateManagementApi.NotificationConfig
• OmniCoreModelAndStateManagementApi.Policy
• OmniCoreModelAndStateManagementApi.PublicKeyCertificate
• OmniCoreModelAndStateManagementApi.PublicKeyCredential
• OmniCoreModelAndStateManagementApi.RegistryCredential
• OmniCoreModelAndStateManagementApi.Sink
• OmniCoreModelAndStateManagementApi.X509CertificateDetails

Documentation for Authorization

bearerAuth

• Type: Bearer authentication (JWT)

apiKey

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header