create Device

Create a device under a registry

POSThttps://api.korewireless.com/omnicore/subscriptions/{subscriptionId}/registries/{registryId}/devices

Path parameters

subscriptionId*string

Subscription ID

registryId*string

Registry ID

Body

application/json

application/json

id*string

namestring

numIdstring

parentstring

registrystring

blockedboolean

capresentboolean

subscriptionstring

createdOnstring

updatedOnstring

credentialsarray of DeviceCredential (object)

gatewayarray of string

gatewayConfigGatewayConfig (object)

isGatewayboolean

deviceErrorsstring

clientOnlineboolean

lastConfigAckTimestring

lastConfigSendTimestring

lastErrorStatusErrorStatus (object)

lastErrorTimestring

lastEventTimestring

lastHeartbeatTimestring

lastStateTimestring

logLevelLogLevel (enum)

INFOERROR

metadataobject

configDeviceConfig (object)

stateDeviceState (object)

policypolicy (object)

Response

200400404500

OK

Body

application/json

id*string

namestring

numIdstring

parentstring

registrystring

blockedboolean

capresentboolean

subscriptionstring

createdOnstring

updatedOnstring

credentialsarray of DeviceCredential (object)

gatewayarray of string

gatewayConfigGatewayConfig (object)

isGatewayboolean

deviceErrorsstring

clientOnlineboolean

lastConfigAckTimestring

lastConfigSendTimestring

lastErrorStatusErrorStatus (object)

lastErrorTimestring

lastEventTimestring

lastHeartbeatTimestring

lastStateTimestring

logLevelLogLevel (enum)

INFOERROR

metadataobject

configDeviceConfig (object)

stateDeviceState (object)

policypolicy (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.korewireless.com/omnicore/subscriptions/{subscriptionId}/registries/{registryId}/devices', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text"
    }),
});
const data = await response.json();

Response

200400404500

{
  "id": "text",
  "name": "text",
  "numId": "text",
  "parent": "text",
  "registry": "text",
  "blocked": false,
  "capresent": false,
  "subscription": "text",
  "createdOn": "text",
  "updatedOn": "text",
  "credentials": [
    {
      "expirationTime": "text",
      "id": "text",
      "publicKey": {
        "format": "RSA_PEM",
        "key": "text"
      }
    }
  ],
  "gateway": [
    "text"
  ],
  "gatewayConfig": {
    "gatewayAuthMethod": "GATEWAY_AUTH_METHOD_UNSPECIFIED",
    "gatewayType": "NON_GATEWAY"
  },
  "isGateway": false,
  "deviceErrors": "text",
  "clientOnline": false,
  "lastConfigAckTime": "text",
  "lastConfigSendTime": "text",
  "lastErrorStatus": {
    "details": "text",
    "message": "text"
  },
  "lastErrorTime": "text",
  "lastEventTime": "text",
  "lastHeartbeatTime": "text",
  "lastStateTime": "text",
  "logLevel": "INFO",
  "config": {
    "acknowledged": false,
    "binaryData": "text",
    "cloudUpdateTime": "text",
    "deviceAckTime": "text"
  },
  "state": {
    "binaryData": "text",
    "updateTime": "text"
  },
  "policy": {
    "Connect": false,
    "PublishState": false,
    "PublishEvents": false,
    "PublishEventsRegex": "text",
    "PublishLoopback": false,
    "SubscribeCommand": false,
    "SubscribeCommandRegex": "text",
    "SubscribeBroadcast": false,
    "SubscribeBroadcastRegex": "text",
    "SubscribeConfig": false
  }
}

Authorization: apiKey

name: x-api-key
in: header
type: apiKey

Curl

curl -L -X POST 'https://api.korewireless.com/omnicore/subscriptions/:subscriptionId/registries/:registryId/devices' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-H 'x-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "id": "string",
  "blocked": true,
  "credentials": [
    {
      "expirationTime": "string",
      "publicKey": {
        "format": "RSA_PEM",
        "key": "string"
      }
    }
  ],
  "gateway": [
    "string"
  ],
  "gatewayConfig": {
    "gatewayAuthMethod": "GATEWAY_AUTH_METHOD_UNSPECIFIED",
    "gatewayType": "NON_GATEWAY"
  },
  "lastErrorStatus": {},
  "logLevel": "INFO",
  "metadata": {},
  "config": {
    "binaryData": "string",
    "version": 0
  },
  "state": {
    "binaryData": "string",
    "updateTime": "string"
  },
  "policy": {
    "Connect": true,
    "PublishState": true,
    "PublishEvents": true,
    "PublishEventsRegex": "string",
    "PublishLoopback": true,
    "SubscribeCommand": true,
    "SubscribeCommandRegex": "string",
    "SubscribeBroadcast": true,
    "SubscribeBroadcastRegex": "string",
    "SubscribeConfig": true
  }
}'

Python

import requests
import json

url = "https://api.korewireless.com/omnicore/subscriptions/:subscriptionId/registries/:registryId/devices"

payload = json.dumps({
  "id": "string",
  "blocked": True,
  "credentials": [
    {
      "expirationTime": "string",
      "publicKey": {
        "format": "RSA_PEM",
        "key": "string"
      }
    }
  ],
  "gateway": [
    "string"
  ],
  "gatewayConfig": {
    "gatewayAuthMethod": "GATEWAY_AUTH_METHOD_UNSPECIFIED",
    "gatewayType": "NON_GATEWAY"
  },
  "lastErrorStatus": {},
  "logLevel": "INFO",
  "metadata": {},
  "config": {
    "binaryData": "string",
    "version": 0
  },
  "state": {
    "binaryData": "string",
    "updateTime": "string"
  },
  "policy": {
    "Connect": True,
    "PublishState": True,
    "PublishEvents": True,
    "PublishEventsRegex": "string",
    "PublishLoopback": True,
    "SubscribeCommand": True,
    "SubscribeCommandRegex": "string",
    "SubscribeBroadcast": True,
    "SubscribeBroadcastRegex": "string",
    "SubscribeConfig": True
  }
})
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer <TOKEN>',
  'x-api-key': '<API_KEY_VALUE>'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.korewireless.com/omnicore/subscriptions/:subscriptionId/registries/:registryId/devices"
  method := "POST"

  payload := strings.NewReader(`{
  "id": "string",
  "blocked": true,
  "credentials": [
    {
      "expirationTime": "string",
      "publicKey": {
        "format": "RSA_PEM",
        "key": "string"
      }
    }
  ],
  "gateway": [
    "string"
  ],
  "gatewayConfig": {
    "gatewayAuthMethod": "GATEWAY_AUTH_METHOD_UNSPECIFIED",
    "gatewayType": "NON_GATEWAY"
  },
  "lastErrorStatus": {},
  "logLevel": "INFO",
  "metadata": {},
  "config": {
    "binaryData": "string",
    "version": 0
  },
  "state": {
    "binaryData": "string",
    "updateTime": "string"
  },
  "policy": {
    "Connect": true,
    "PublishState": true,
    "PublishEvents": true,
    "PublishEventsRegex": "string",
    "PublishLoopback": true,
    "SubscribeCommand": true,
    "SubscribeCommandRegex": "string",
    "SubscribeBroadcast": true,
    "SubscribeBroadcastRegex": "string",
    "SubscribeConfig": true
  }
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer <TOKEN>")
  req.Header.Add("x-api-key", "<API_KEY_VALUE>")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

JS

const axios = require('axios');
let data = JSON.stringify({
  "id": "string",
  "blocked": true,
  "credentials": [
    {
      "expirationTime": "string",
      "publicKey": {
        "format": "RSA_PEM",
        "key": "string"
      }
    }
  ],
  "gateway": [
    "string"
  ],
  "gatewayConfig": {
    "gatewayAuthMethod": "GATEWAY_AUTH_METHOD_UNSPECIFIED",
    "gatewayType": "NON_GATEWAY"
  },
  "lastErrorStatus": {},
  "logLevel": "INFO",
  "metadata": {},
  "config": {
    "binaryData": "string",
    "version": 0
  },
  "state": {
    "binaryData": "string",
    "updateTime": "string"
  },
  "policy": {
    "Connect": true,
    "PublishState": true,
    "PublishEvents": true,
    "PublishEventsRegex": "string",
    "PublishLoopback": true,
    "SubscribeCommand": true,
    "SubscribeCommandRegex": "string",
    "SubscribeBroadcast": true,
    "SubscribeBroadcastRegex": "string",
    "SubscribeConfig": true
  }
});

let config = {
  method: 'post',
  url: 'https://api.korewireless.com/omnicore/subscriptions/:subscriptionId/registries/:registryId/devices',
  headers: { 
    'Content-Type': 'application/json', 
    'Accept': 'application/json', 
    'Authorization': 'Bearer <TOKEN>', 
    'x-api-key': '<API_KEY_VALUE>'
  },
  data : data
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});