Create Supported Asset Type

POST 
/supported-asset-types

Create Supported asset type

Request

Path Parameters

organizationId string

application/json

Body

required

name stringrequired

The name of asset type

description string

The description of asset type

image string

The custom image of asset type

encodeCodec string

The encode codec of asset type

decodeCodec string

The decode codec of asset type

brand stringrequired

The brand of asset type

model stringrequired

The model of asset type

isIotDevice booleanrequired

Is the asset an IoT device?

properties object[]
The properties of asset type
Array [
]
actions object[]
The actions of asset type
Array [
]

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the supported asset type.
id stringrequired
name stringrequired
description stringrequired
isIotDevice stringrequired
image stringrequired
brand stringrequired
model stringrequired
encodeCodec stringrequired
decodeCodec stringrequired
properties object[]required
Array [
]

Example (from schema)

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "isIotDevice": "string",
    "image": "string",
    "brand": "string",
    "model": "string",
    "encodeCodec": "string",
    "decodeCodec": "string",
    "properties": [
      {}
    ]
  }
}

Example

{
  "data": {
    "id": "Infodeck-NS300-ABC",
    "organizationid": "o-organizationId",
    "name": "IDT-Bot-SupportedAssetType",
    "description": "IDT-SupportedAssetType-Description",
    "image": "Supported-Asset-Type-Image.png",
    "encodeCodec": "function encodeDownlink(input) {\n  const bytes = [];\n\n  return {\n    bytes,\n  };\n}",
    "decodeCodec": "function decodeUplink(input) {\n  const bytes = input.bytes;\n  const data = {};\n\n  return {\n    data,\n  };\n}",
    "brand": "Infodeck",
    "model": "NS330-PSU",
    "isIotDevice": true,
    "properties": [
      {
        "key": "Power",
        "name": "Power",
        "type": "integer",
        "unit": "W"
      }
    ],
    "actions": [
      {
        "confirmed": true,
        "fPort": 85,
        "name": "Power On",
        "payload": "080100ff",
        "payloadDataType": "Hex"
      }
    ]
  }
}

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