List Assest from Location ID

GET 
/organizations/:organizationId/locations/:locationId/assets

List Assets From LocationId

Request

Path Parameters

organizationId stringrequired

The ID of organization.

locationId stringrequired

The ID of location.

Query Parameters

shadowNames string[]

Specify shadow names to fetch. (Default: DeviceUplink)

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 objectrequired
An array of assets within the specified location.
id stringrequired
organizationId stringrequired
name stringrequired
description stringrequired
devEui string
uuid string
shadows objectrequired
integrationServiceId stringrequired
assetTypeId stringrequired
locationId stringrequired
chatRoomId stringrequired
modelName stringrequired
nameOfManufacturer stringrequired
yearOfManufacture numberrequired
purchaseCost numberrequired
purchaseDate numberrequired
warrantyEndDate numberrequired
image stringrequired
files stringrequired
keepAlive number
connectionStatus boolean
status string
createdAtDateString stringrequired
createdAt numberrequired
updatedAtDateString stringrequired
updatedAt numberrequired

Example (from schema)

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

Example

{
  "data": {
    "id": "l-locationId",
    "organizationId": "o-organizationId",
    "name": "IDT-Location",
    "description": "IDT-Location-Description",
    "devEui": "24e124535b312345",
    "shadows": {},
    "integrationServiceId": "is-integrationServiceId",
    "assetTypeId": "at-assetTypeId",
    "locationId": "l-locationId",
    "chatRoomId": "ABCDE",
    "modelName": "Bot-Model-Name",
    "nameOfManufacturer": "Bot-Manufacturer",
    "yearOfManufacture": 2024,
    "purchaseCost": 12345,
    "purchaseDate": 1700000000000,
    "warrantyEndDate": 1800000000000,
    "image": "abc.png",
    "files": [
      "Infodeck-Bot-0001.pdf"
    ],
    "uuid": "24e124535b312345",
    "keepAlive": 2592000,
    "connectionStatus": false,
    "status": "Normal",
    "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...