FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [View Raw Code]   [Original HTTPS Page]

OmniCore-Sample-Apps/JavaScript/README.md at main · korewireless/OmniCore-Sample-Apps · GitHub

Latest commit

 

History

History
144 lines (116 loc) · 9.69 KB

File metadata and controls

144 lines (116 loc) · 9.69 KB

omni_core_model_and_state_management_api

OmniCoreModelAndStateManagementApi - JavaScript client for omni_core_model_and_state_management_api This is an OmniCore Model and State Management server. This SDK is automatically generated by the OpenAPI Generator project:

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

Installation

    npm install korewireless/OmniCore-JavaScript-SDK --save

Getting Started

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

  const OmniCoreModelAndStateManagementApi = require('omni_core_model_and_state_management_api');

  let defaultClient = OmnicoreModelAndStateManagementApi.ApiClient.instance;
  defaultClient.basePath = 'https://api.korewireless.com'
  // Configure API key authorization: apiKey
  let apiKey = defaultClient.authentications['apiKey'];
  apiKey.apiKey = 'YOUR API KEY'
  // Configure Bearer (JWT) access token for authorization: bearerAuth
  let bearerAuth = defaultClient.authentications['bearerAuth'];
  bearerAuth.accessToken = 'YOUR ACCESS TOKEN'

  let apiInstance = new OmnicoreModelAndStateManagementApi.RegistryApi();
  let subscriptionId = 'YOUR SUBSCRIPTION ID'; // String | Subscription ID
  let opts = {
    'pageNumber': 1, // Number | Page Number
    'pageSize': 10 // Number | Page Size
  };
  apiInstance.getRegistries(subscriptionId, opts, (error, data, response) => {
    if (error) {
      console.error(error);
    } else {
      console.log('\nAPI called successfully. Returned data: \n');
      console.log(" Registry Id: ",data.deviceRegistries[0].id)
      console.log(" Parent: ",data.deviceRegistries[0].parent)
      console.log(" Credentials: ",data.deviceRegistries[0].credentials)
      console.log(" eventNotificationConfigs:",data.deviceRegistries[0].eventNotificationConfigs)
      console.log(" httpConfig: ",data.deviceRegistries[0].httpConfig)
      console.log(" logLevel: ",data.deviceRegistries[0].logLevel)
      console.log(" logNotificationConfig: ",data.deviceRegistries[0].logNotificationConfig)
      console.log(" customOnboardEnabled: ",data.deviceRegistries[0].customOnboardEnabled)
      console.log(" customOnboardNotificationConfig: ",data.deviceRegistries[0].customOnboardNotificationConfig)
      console.log(" mqttConfig: ",data.deviceRegistries[0].mqttConfig)
      console.log(" name:",data.deviceRegistries[0].name)
      console.log(" numberOfDevices: ",data.deviceRegistries[0].numberOfDevices)
      console.log(" numberOfGateways: ",data.deviceRegistries[0].numberOfGateways)
      console.log(" stateNotificationConfig: ",data.deviceRegistries[0].stateNotificationConfig)
      console.log(" updatedOn: ",data.deviceRegistries[0].updatedOn)
    }
  });

Documentation for API Endpoints

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

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.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}

Documentation for Models

Documentation for Authorization

bearerAuth

  • Type: Bearer authentication (JWT)

apiKey

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

Back | FazBrowse Home | New Git URL