List Assets

GET 
/organizations/:organizationId/assets

List assets

Request

Path Parameters

organizationId stringrequired

The ID of organization.

Query Parameters

devEui string

The devEui of device to filter assets.

uuid string

The uuid of device to filter assets.

isIotDevice string

List IoT devices assets only.

assetTypeId string

The ID of asset type to filter assets.

locationId string

The ID of location to filter assets.

maxResults number

The maximum number of results to return.

nextToken string

To retrieve the next set of results.

shadowNames string[]

Specify shadow names to fetch. (Default: DeviceUplink)

Responses

200

application/json

Schema

Schema

data object[]required
Data of the asset.
Array [
id stringrequired
organizationId stringrequired
assetTypeId stringrequired
locationId stringrequired
integrationServiceId stringrequired
name stringrequired
description stringrequired
chatRoomId stringrequired
serialNumber stringrequired
modelName stringrequired
nameOfManufacturer stringrequired
yearOfManufacture numberrequired
purchaseCost numberrequired
purchaseDate numberrequired
warrantyEndDate numberrequired
devEui string
uuid string
keepAlive number
connectionStatus boolean
status string
shadows objectrequired
createdAtDateString numberrequired
createdAt numberrequired
updatedAtDateString numberrequired
updatedAt numberrequired
]

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "organizationId": "string",
      "assetTypeId": "string",
      "locationId": "string",
      "integrationServiceId": "string",
      "name": "string",
      "description": "string",
      "chatRoomId": "string",
      "serialNumber": "string",
      "modelName": "string",
      "nameOfManufacturer": "string",
      "yearOfManufacture": 0,
      "purchaseCost": 0,
      "purchaseDate": 0,
      "warrantyEndDate": 0,
      "devEui": "string",
      "uuid": "string",
      "keepAlive": 0,
      "connectionStatus": true,
      "status": "string",
      "shadows": {},
      "createdAtDateString": 0,
      "createdAt": 0,
      "updatedAtDateString": 0,
      "updatedAt": 0
    }
  ]
}

Example

{
  "data": [
    {
      "id": "a-assetId",
      "organizationId": "o-organizationId",
      "assetTypeId": "at-assetTypeId",
      "locationId": "l-locationId",
      "integrationServiceId": "is-integrationServiceId",
      "name": "IDT-Bot-Asset",
      "description": "IDT-Bot-Asset-Description",
      "chatRoomId": "ABCDE",
      "serialNumber": "123456789",
      "modelName": "Bot-Model-Name",
      "nameOfManufacturer": "Bot-Manufacturer",
      "yearOfManufacture": 2024,
      "purchaseCost": 12345,
      "purchaseDate": 1700000000000,
      "warrantyEndDate": 1800000000000,
      "devEui": "24e124535b312345",
      "uuid": "24e124535b312345",
      "keepAlive": 2592000,
      "connectionStatus": false,
      "status": "Normal",
      "shadows": {
        "DeviceUplink": {
          "state": {
            "reported": {
              "Payload": {
                "Temperature": 25.4,
                "Humidity": 62,
                "CO2": 869,
                "rssi": -91,
                "timestamp": 1711341602287
              },
              "ExpiredAt": 1711341602287
            }
          },
          "metadata": {
            "reported": {
              "Payload": {
                "Temperature": {
                  "timestamp": 1711330802
                },
                "Humidity": {
                  "timestamp": 1711330802
                },
                "CO2": {
                  "timestamp": 1711330802
                },
                "rssi": {
                  "timestamp": 1711330802
                }
              },
              "ExpiredAt": {
                "timestamp": 1711330802
              }
            }
          },
          "version": 21415,
          "timestamp": 1711330849
        }
      },
      "createdAtDateString": "2024-01-01T00:00:00.000Z",
      "createdAt": 1704067200000,
      "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...