List Asset Types

GET 
/organizations/:organizationId/asset-types

List asset types

Request

Path Parameters

organizationId stringrequired

The ID of organization.

Query Parameters

maxResults number

Possible values: >= 10 and <= 25

The maximum number of results to return.

nextToken string

To retrieve the next set of results.

Responses

200

application/json

Schema

Schema

data object[]required
Data of the asset type.
Array [
id stringrequired
organizationId stringrequired
supportedAssetTypeId stringrequired
name stringrequired
description stringrequired
isIotDevice stringrequired
image stringrequired
encodeCodec stringrequired
decodeCodec stringrequired
properties object[]required
Array [
]
actions object[]required
Array [
]
createdBy stringrequired
createdAtDateString stringrequired
createdAt numberrequired
updatedBy stringrequired
updatedAtDateString stringrequired
updatedAt numberrequired
]

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "organizationId": "string",
      "supportedAssetTypeId": "string",
      "name": "string",
      "description": "string",
      "isIotDevice": "string",
      "image": "string",
      "encodeCodec": "string",
      "decodeCodec": "string",
      "properties": [
        {}
      ],
      "actions": [
        {}
      ],
      "createdBy": "string",
      "createdAtDateString": "string",
      "createdAt": 0,
      "updatedBy": "string",
      "updatedAtDateString": "string",
      "updatedAt": 0
    }
  ]
}

Example

{
  "data": [
    {
      "id": "at-assetTypeId",
      "organizationId": "o-organizationId",
      "supportedAssetTypeId": "Infodeck-NS300-ABC",
      "name": "IDT-Bot-AssetType-A",
      "description": "IDT-Bot-AssetType-A-Description",
      "isIotDevice": true,
      "image": "Asset-Type-A-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}",
      "properties": [
        {
          "key": "Power",
          "name": "Power",
          "type": "integer",
          "unit": "W"
        }
      ],
      "actions": [
        {
          "confirmed": true,
          "fPort": 85,
          "name": "Power On",
          "payload": "080100ff",
          "payloadDataType": "Hex"
        }
      ],
      "createdBy": "d6b0e137-xxxx-xxxx-xxxx-c944cc12a5f4",
      "createdAtDateString": "2024-01-01T00:00:00.000Z",
      "createdAt": 1704067200000,
      "updatedBy": "d6b0e137-xxxx-xxxx-xxxx-c944cc12a5f4",
      "updatedAtDateString": "2024-01-31T00:00:00.000Z",
      "updatedAt": 1706659200000
    }
  ]
}

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