Get Asset
GET/organizations/:organizationId/assets/:assetId
Get asset
Request
Path Parameters
organizationId stringrequired
The ID of organization.
assetId stringrequired
The ID of asset
Query Parameters
shadowNames string[]
Specify shadow names to fetch. (Default: DeviceUplink)
Responses
- 200
- 401
- 403
- 404
- 422
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
data objectrequired
Data of the asset.
id stringrequired
organizationId stringrequired
assetId stringrequired
integrationService objectrequired
name stringrequired
description stringrequired
chatRoomId stringrequired
serialNumber numberrequired
modelName stringrequired
nameOfManufacturer stringrequired
yearOfManufacture numberrequired
purchaseCost numberrequired
purchaseDate stringrequired
warrantyEndDate stringrequired
assetType objectrequired
id stringrequired
name stringrequired
isIotDevice stringrequired
supportedAssetTypeId stringrequired
properties object[]required
location objectrequired
id stringrequired
name stringrequired
images stringrequired
files stringrequired
devEui string
uuid string
keepAlive number
connectionStatus boolean
status string
shadow objectrequired
createdAtDateString stringrequired
createdAt numberrequired
updatedAtDateString stringrequired
updatedAt numberrequired
{
"data": {
"id": "string",
"organizationId": "string",
"assetId": "string",
"integrationService": {},
"name": "string",
"description": "string",
"chatRoomId": "string",
"serialNumber": 0,
"modelName": "string",
"nameOfManufacturer": "string",
"yearOfManufacture": 0,
"purchaseCost": 0,
"purchaseDate": "string",
"warrantyEndDate": "string",
"assetType": {
"id": "string",
"name": "string",
"isIotDevice": "string",
"supportedAssetTypeId": "string",
"properties": [
{}
]
},
"location": {
"id": "string",
"name": "string"
},
"images": "string",
"files": "string",
"devEui": "string",
"uuid": "string",
"keepAlive": 0,
"connectionStatus": true,
"status": "string",
"shadow": {},
"createdAtDateString": "string",
"createdAt": 0,
"updatedAtDateString": "string",
"updatedAt": 0
}
}
{
"data": {
"id": "o-organizationId-a-assetId",
"organizationId": "o-organizationId",
"assetId": "a-assetId",
"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,
"assetType": {
"id": "at-assetType",
"name": "assetType",
"isIotDevice": true,
"supportedAssetTypeId": "Infodeck-NS300-ABC",
"properties": [
{
"name": "Battery",
"unit": "%",
"type": "integer",
"key": "Battery"
}
]
},
"location": {
"id": "l-location",
"name": "location"
},
"image": "Asset-Image.png",
"files": [
"Infodeck-Bot-0001.pdf"
],
"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
}
}
The request has not permission.
- application/json
- Schema
- Example (from schema)
- Example
Schema
error stringrequired
The request has not permission.
message stringrequired
The request has not permission message.
{
"error": "string",
"message": "string"
}
{
"error": "Unauthenticated",
"message": "Authentication is required and has failed or has not yet been provided."
}
The request has not permission.
- application/json
- Schema
- Example (from schema)
- Example
Schema
error stringrequired
The request has not permission.
message stringrequired
The request has not permission message.
{
"error": "string",
"message": "string"
}
{
"error": "Forbidden",
"message": "Access to the requested resource is forbidden."
}
The resource hasn't found.
- application/json
- Schema
- Example (from schema)
- Example
Schema
error stringrequired
The resource hasn't found.
message stringrequired
The resource hasn't found message.
{
"error": "string",
"message": "string"
}
{
"error": "ResourceNotFound",
"message": "The requested resource could not be found."
}
The input data has invalid.
- application/json
- Schema
- Example (from schema)
- Example
Schema
error stringrequired
The input data has invalid.
message stringrequired
The input data has invalid message.
{
"error": "string",
"message": "string"
}
{
"error": "ValidationError",
"message": "Input data validation failed."
}
Loading...