Creates a Device Type

post

https://api.edgeiq.io/api/v1/platform/device_types

Body Params

name

string

required

The name of the Device Type. Must be unique among the owner's Device Types.

manufacturer

string

required

Used to describe the Device Type manufacturer.

model

string

required

Used to describe the Device Type model.

type

string

enum

required

Gives an indication of the greater classification. This is usually associated with a specific translator for inbound reports and outbound commands.

Allowed:

long_description

string

Paragraph-form description of the Device Type.

capabilities

object

Capabilities allow Device Types with gateway capabilities to self document what the gateway provides for interfaces, etc.

ingestor_ids

array of strings

IDs of associated Ingestors (deprecated, optional).

ingestor_ids

command_ids

array of strings

IDs of associated Commands (deprecated, optional).

command_ids

device_integration_id

string

The _id of the device Integration to be associated with the Device Profile.

cloud_native_integration_id

string

The _id of the cloud native Integration to be associated with the Device Profile.

default_thing_groups

array of objects

The default AWS Thing Groups to be associated with the Device Profile (only applicable, if it has an AWS Integration).

default_thing_groups

Responses

401

You are not authorized

404

The item you were looking for does not exist

500

An unexpected error was encountered.

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created