Create Asset

POST 
/organizations/:organizationId/assets

Create asset

Request

Path Parameters

organizationId stringrequired

The ID of organization.

application/json

Body

required

assetTypeId stringrequired

The asset type ID.

locationId stringrequired

The location ID.

integrationServiceId string

The integration service ID of asset.

linkIds string[]

The IDs of asset.

name stringrequired

The name of asset.

description string

The description of asset.

chatRoomId string

The ID of chat room.

serialNumber string

The serial number of asset.

modelName string

The model of name.

nameOfManufacturer string

The name of manufacturer.

yearOfManufacture number

The year of manufacture of asset.

purchaseCost number

The purchase cost of asset.

purchaseDate number

The purchase date of asset.

warrantyEndDate number

The warranty end date of asset.

uuid string

The uuid of device to filter assets.

image string

The image of asset.

files string[]

The files of asset.

keepAlive number

The interval of keep alive.

Responses

200

application/json

Schema

Schema

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

Example (from schema)

{
  "data": {
    "id": "string",
    "organizationId": "string",
    "assetTypeId": "string",
    "locationId": "string",
    "integrationServiceId": "string",
    "linkIds": "string",
    "name": "string",
    "description": "string",
    "chatRoomId": "string",
    "serialNumber": "string",
    "modelName": "string",
    "nameOfManufacturer": "string",
    "yearOfManufacture": 0,
    "purchaseCost": 0,
    "purchaseDate": 0,
    "warrantyEndDate": 0,
    "assetType": {
      "id": "string",
      "name": "string",
      "isIotDevice": "string",
      "supportedAssetTypeId": "string",
      "properties": [
        {}
      ]
    },
    "location": {
      "id": "string",
      "name": "string"
    },
    "devEui": "string",
    "uuid": "string",
    "image": "string",
    "files": {},
    "keepAlive": 0,
    "connectionStatus": true,
    "status": "string",
    "shadows": {},
    "createdAtDateString": 0,
    "createdAt": 0
  }
}

Example

{
  "data": {
    "id": "o-organizationId-a-assetId",
    "organizationId": "o-organizationId",
    "assetTypeId": "at-assetTypeId",
    "locationId": "l-locationId",
    "integrationServiceId": "is-integrationServiceId",
    "linkIds": [
      "a-assetId"
    ],
    "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": "locationId",
      "name": "location"
    },
    "devEui": "24e124535b312345",
    "uuid": "24e124535b312345",
    "image": "Asset-Image.png",
    "files": [
      "Infodeck-Bot-0001.pdf"
    ],
    "keepAlive": 2592000,
    "connectionStatus": false,
    "status": "Normal",
    "shadows": {},
    "createdAtDateString": "2024-01-01T00:00:00.000Z",
    "createdAt": 1704067200000
  }
}

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

409

The resource already exists.

application/json

Schema

Schema

error stringrequired

The resource already exists.

message stringrequired

The resource already exists message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ResourceAlreadyExistsError",
  "message": "The operation cannot be completed because a resource with the specified identifier already exists."
}

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