Create Device Profile

POST 
/lns/tenants/:tenantId/device-profiles

Create device profile

Request

Path Parameters

tenantId stringrequired

The ID of tenant.

application/json

Body

required

name stringrequired

The name of device profile.

description string

The description of device profile.

region numberrequired

The region of device profile.

macVersion numberrequired

The mac version of device profile.

regionConfigId string

The region config ID of device profile.

regParamsRevision numberrequired

The reg params revision of device profile.

adrAlgorithmId stringrequired

The ADR algorithm ID of device profile.

flushQueueOnActivate boolean

The flush queue on activate of device profile.

uplinkInterval numberrequired

The uplink interval of device profile.

deviceStatusReqInterval number

The device status request interval of device profile.

supportsOtaa boolean

The supports OTAA of device profile.

abpRx1Delay number

The ABP Rx1 delay of device profile.

abpRx1DrOffset number

The ABP Rx1 DR offset of device profile.

abpRx2Dr number

The ABP Rx2 DR of device profile.

abpRx2Freq number

The ABP Rx2 frequency of device profile.

supportsClassB boolean

The supports Class B of device profile.

classBTimeout number

The Class B timeout of device profile.

classBPingSlotNbK number

The Class B ping slot number of device profile.

classBPingSlotDr number

The Class B ping slot DR of device profile.

classBPingSlotFreq number

The Class B ping slot frequency of device profile.

supportsClassC boolean

The supports Class C of device profile.

classCTimeout number

The Class C timeout of device profile.

isRelay boolean

The is relay of device profile.

relayEnabled boolean

The relay enabled of device profile.

relayDefaultChannelIndex number

The relay default channel index of device profile.

relaySecondChannelFreq number

The relay second channel frequency of device profile.

relaySecondChannelDr number

The relay second channel DR of device profile.

relaySecondChannelAckOffset number

The relay second channel ack offset of device profile.

relayCadPeriodicity number

The relay cad periodicity of device profile.

relayJoinReqLimitBucketSize number

The relay join request limit bucket size of device profile.

relayJoinReqLimitReloadRate number

The relay join request limit reload rate of device profile.

relayNotifyLimitBucketSize number

The relay notify limit bucket size of device profile.

relayNotifyLimitReloadRate number

The relay notify limit reload rate of device profile.

relayGlobalUplinkLimitBucketSize number

The relay overall limit bucket size of device profile.

relayGlobalUplinkLimitReloadRate number

The relay overall limit reload rate of device profile.

relayOverallLimitBucketSize number

The relay overall limit bucket size of device profile.

relayOverallLimitReloadRate number

The relay overall limit reload rate of device profile.

isRelayEd boolean

The is relay ED of device profile.

relayEdRelayOnly boolean

The relay ED relay only of device profile.

relayEdActivationMode number

The relay ED activation mode of device profile.

relayEdSmartEnableLevel number

The relay ED smart enable level of device profile.

relayEdBackOff number

The relay ED back off of device profile.

relayEdUplinkLimitBucketSize number

The relay ED uplink limit bucket size of device profile.

relayEdUplinkLimitReloadRate number

The relay ED uplink limit reload rate of device profile.

Responses

200

application/json

Schema

Schema

data object[]required
Data of the device profile.
Array [
tenantId stringrequired
id stringrequired
name stringrequired
description stringrequired
region numberrequired
regionConfigId stringrequired
macVersion numberrequired
regParamsRevision numberrequired
adrAlgorithmId stringrequired
flushQueueOnActivate booleanrequired
uplinkInterval booleanrequired
deviceStatusReqInterval numberrequired
supportsOtaa booleanrequired
abpRx1Delay numberrequired
abpRx1DrOffset numberrequired
abpRx2Dr numberrequired
abpRx2Freq numberrequired
supportsClassB booleanrequired
classBTimeout numberrequired
classBPingSlotNbK numberrequired
classBPingSlotDr numberrequired
classBPingSlotFreq numberrequired
supportsClassC booleanrequired
classCTimeout numberrequired
isRelay booleanrequired
relayEnabled booleanrequired
relayDefaultChannelIndex numberrequired
relaySecondChannelFreq numberrequired
relaySecondChannelDr numberrequired
relaySecondChannelAckOffset numberrequired
relayCadPeriodicity numberrequired
relayJoinReqLimitBucketSize numberrequired
relayJoinReqLimitReloadRate numberrequired
relayNotifyLimitBucketSize numberrequired
relayNotifyLimitReloadRate numberrequired
relayGlobalUplinkLimitBucketSize numberrequired
relayGlobalUplinkLimitReloadRate numberrequired
relayOverallLimitBucketSize numberrequired
relayOverallLimitReloadRate numberrequired
isRelayEd booleanrequired
relayEdRelayOnly booleanrequired
relayEdActivationMode numberrequired
relayEdSmartEnableLevel numberrequired
relayEdBackOff numberrequired
relayEdUplinkLimitBucketSize numberrequired
relayEdUplinkLimitReloadRate numberrequired
tagsMap object[]required
Array [
]
]

Example (from schema)

{
  "data": [
    {
      "tenantId": "string",
      "id": "string",
      "name": "string",
      "description": "string",
      "region": 0,
      "regionConfigId": "string",
      "macVersion": 0,
      "regParamsRevision": 0,
      "adrAlgorithmId": "string",
      "flushQueueOnActivate": true,
      "uplinkInterval": true,
      "deviceStatusReqInterval": 0,
      "supportsOtaa": true,
      "abpRx1Delay": 0,
      "abpRx1DrOffset": 0,
      "abpRx2Dr": 0,
      "abpRx2Freq": 0,
      "supportsClassB": true,
      "classBTimeout": 0,
      "classBPingSlotNbK": 0,
      "classBPingSlotDr": 0,
      "classBPingSlotFreq": 0,
      "supportsClassC": true,
      "classCTimeout": 0,
      "isRelay": true,
      "relayEnabled": true,
      "relayDefaultChannelIndex": 0,
      "relaySecondChannelFreq": 0,
      "relaySecondChannelDr": 0,
      "relaySecondChannelAckOffset": 0,
      "relayCadPeriodicity": 0,
      "relayJoinReqLimitBucketSize": 0,
      "relayJoinReqLimitReloadRate": 0,
      "relayNotifyLimitBucketSize": 0,
      "relayNotifyLimitReloadRate": 0,
      "relayGlobalUplinkLimitBucketSize": 0,
      "relayGlobalUplinkLimitReloadRate": 0,
      "relayOverallLimitBucketSize": 0,
      "relayOverallLimitReloadRate": 0,
      "isRelayEd": true,
      "relayEdRelayOnly": true,
      "relayEdActivationMode": 0,
      "relayEdSmartEnableLevel": 0,
      "relayEdBackOff": 0,
      "relayEdUplinkLimitBucketSize": 0,
      "relayEdUplinkLimitReloadRate": 0,
      "tagsMap": [
        {}
      ]
    }
  ]
}

Example

{
  "data": {
    "tenantId": "b004ebe0-xxxx-xxxx-xxxx-dacd251b6f00",
    "id": "ff7684e4-xxxx-xxxx-xxxx-6f42763591d1",
    "name": "AS923-ClassC",
    "description": "",
    "region": 7,
    "macVersion": 3,
    "regionConfigId": "as923",
    "regParamsRevision": 0,
    "adrAlgorithmId": "default",
    "flushQueueOnActivate": true,
    "uplinkInterval": 3600,
    "deviceStatusReqInterval": 30,
    "supportsOtaa": true,
    "abpRx1Delay": 0,
    "abpRx1DrOffset": 0,
    "abpRx2Dr": 0,
    "abpRx2Freq": 0,
    "supportsClassB": false,
    "classBTimeout": 0,
    "classBPingSlotNbK": 0,
    "classBPingSlotDr": 0,
    "classBPingSlotFreq": 0,
    "supportsClassC": true,
    "classCTimeout": 0,
    "isRelay": false,
    "relayEnabled": false,
    "relayDefaultChannelIndex": 0,
    "relaySecondChannelFreq": 0,
    "relaySecondChannelDr": 0,
    "relaySecondChannelAckOffset": 0,
    "relayCadPeriodicity": 0,
    "relayJoinReqLimitBucketSize": 0,
    "relayJoinReqLimitReloadRate": 0,
    "relayNotifyLimitBucketSize": 0,
    "relayNotifyLimitReloadRate": 0,
    "relayGlobalUplinkLimitBucketSize": 0,
    "relayGlobalUplinkLimitReloadRate": 0,
    "relayOverallLimitBucketSize": 0,
    "relayOverallLimitReloadRate": 0,
    "isRelayEd": false,
    "relayEdRelayOnly": false,
    "relayEdActivationMode": 0,
    "relayEdSmartEnableLevel": 0,
    "relayEdBackOff": 0,
    "relayEdUplinkLimitBucketSize": 0,
    "relayEdUplinkLimitReloadRate": 0,
    "tagsMap": [
      {
        "key": "Rooftop",
        "value": "Weather monitoring"
      }
    ]
  }
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...