3.1.4.2 特定のデバイスを検索する

現在のアプリケーションに関連付けられているすべてのデバイスから、特定のデバイスを検索します。

リクエスト URL

POST {base_url}/device/openapi/v1/devices/search

リクエストパラメータ

表 1. ヘッダーパラメータ
パラメータ 必須 タイプ 説明
Authorization Yes 文字列 API 呼び出しを行うための有効なアクセストークン。

形式は Bearer {access_token} である必要があります。

表 2. ボディパラメータ
パラメータ 必須 タイプ 説明
pageSize Yes 整数 1 ページあたりのレコード数を定義します。
pageNumber Yes  整数

表示するページを定義します。

sorts No Array<Object> ソートフィールドと表示順を定義します。
direction No 文字列 表示順を定義します。
有効な値

  • asc: 昇順
  • desc: 降順
property No 文字列 ソートフィールドを定義します。
有効な値デバイス詳細既存のフィールド。
sn No 文字列 検索するデバイスの SN (シリアル番号) を指定します。
devEUI No 文字列 検索するデバイスの EUI (拡張一意識別子) を指定します。
imei No 文字列 検索するデバイスの IMEI (国際移動体装置識別番号) を指定します。
rpsStatus No Array<String> 検索するデバイスの RPS サービスステータスを指定します。
有効な値

  • ACTIVATE: RPS サービスが有効になっているデバイス。
  • UNACTIVATED: RPS サービスが有効になっていないデバイス。
connectStatus No Array<String> 検索するデバイスの接続ステータスを指定します。
有効な値

  • ONLINE: Milesight 開発プラットフォームにアクティブに接続しているデバイス。
  • OFFLINE: 現在 Milesight 開発プラットフォームに接続していないデバイス。
  • DISCONNECT: Milesight 開発プラットフォームから切断されたデバイス。
name No 文字列 検索するデバイス名を指定します。
model No 文字列 検索するデバイスのモデルを指定します。
hardwareVersion No 文字列 検索するデバイスのハードウェアバージョンを指定します。
firmwareVersion No 文字列 検索するデバイスのファームウェアバージョンを指定します。
electricityMin No Integer 検索対象の最小バッテリーレベルを指定します。
例:このパラメーターを 80に設定した場合、バッテリー残量が80%以上のデバイスが表示されます。
electricityMax No Integer 検索対象の最大バッテリーレベルを指定します。例:このパラメーターを 5に設定した場合、バッテリー残量が5%未満のデバイスが表示されます。

ヒント: 低バッテリー閾値を設定し、このパラメーターで低バッテリーレベルのデバイスをフィルタリングできます。

project No 文字列 検索対象のデバイスのプロジェクトタグを指定します。
description No 文字列 検索対象のデバイスの説明を指定します。
tag No Array<String> 検索対象のデバイスのタグを指定します。
deviceType No Array<String> 検索するデバイスのタイプを指定します。
有効な値

  • GATEWAY: サブデバイスと Milesight 開発プラットフォーム間の通信を設定するゲートウェイデバイス。
  • SUB_DEVICE: Milesight 開発プラットフォームに接続するためにゲートウェイを必要とする、インターネットにアクセスできないデバイス。
  • COMMON: Milesight 開発プラットフォームに直接接続できる、インターネットにアクセスできるデバイス。
licenseStatus No Array<String> 検索するデバイスのライセンスステータスを指定します。
有効な値

  • VALID: デバイスを使用できます。
  • INVALID: プロプランの有効期限が切れたため、デバイスは使用できません。

応答パラメータ

 
パラメータ タイプ 説明
data Object<Search_Result> 検索結果。
status String API リクエストの結果。

  • Success
  • Failed
requestId String リクエストの一意の ID。リクエストをすばやく見つけるために使用できます。
Search_Result
 
パラメータ タイプ 説明
pageSize
整数
各ページに表示されるレコードの数。
pageNumber
整数
表示するページ
total
整数
レコードの総数
content Array<Device_Details>
検索条件に一致するデバイスの詳細。
Device_Details
 
パラメータ タイプ 説明
sn 文字列
このデバイスの国際移動体装置識別番号
imei 文字列
このデバイスの国際移動体装置識別番号 (IMEI)。
rpsStatus 文字列
デバイスのRPSサービス状態。
  • ACTIVATE: このデバイスのRPSが有効です。
  • UNACTIVATED: このデバイスのRPSが無効または未対応です。
name 文字列
デバイスの名前
model 文字列
デバイスのモデル。
hardwareVersion 文字列
デバイスのハードウェアバージョン
firmwareVersion 文字列
デバイスのファームウェアバージョン
electricity Integer
デバイスのバッテリーレベル
lastUpdateTime Long
デバイスの最新のレポートのタイムスタンプ。
application Object
デバイスに関連付けられたアプリケーションの情報。
applicationId Long
このアプリケーションのユニークID
applicationName 文字列
このアプリケーションの名前
project 文字列
デバイスのプロジェクトタグ。
description 文字列
デバイスの説明
deviceId Long
このデバイスの一意の ID
devEUI 文字列
このデバイスの EUI (Extended Unique Identifier)。
connectStatus String
デバイスの接続ステータス
  • ONLINE: デバイスは Milesight Development Platform にアクティブに接続されています。
  • OFFLINE: デバイスは現在 Milesight Development Platform に接続されていません。
  • DISCONNECT: デバイスは Milesight 開発プラットフォームから切断されています。
licenseStatus 文字列 デバイスのライセンスステータス

  • VALID: デバイスを使用できます
  • INVALID: プロプランの有効期限が切れたため、デバイスは使用できません。
deviceType 文字列 このデバイスのタイプ。

  • GATEWAY: サブデバイスと Milesight 開発プラットフォーム間の通信を設定するゲートウェイデバイス。
  • SUB_DEVICE: Milesight Development Platform に接続するためにゲートウェイを必要とする、インターネットにアクセスできないデバイス
  • COMMON: Milesight Development Platform に直接接続できる、インターネットにアクセスできるデバイス。
tag Array<String> このデバイスのタグ

リクエスト例
自動プロビジョニングステータスが有効になっていないデバイスを検索します。
POST /device/openapi/v1/devices/search HTTP/1.1
Host: demo.milesight.com
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InllYXN0b25lLWRlZmF1bHQta2V5LWlkIn0.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsib3BlbmFwaSJdLCJjbGllbnRfZXh0Ijp7ImFwcF9pZCI6IjE3MzY5NTQ4MDE3MTMzMjgxMzAifSwiZXhwIjoxNzAzMjEzMDk4LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJiYjJjN2U4Yy03NGQwLTQ4NjEtODE3MS1iYTc0NWRlMGY0NmQiLCJjbGllbnRfaWQiOiI4OTNkNzdjNy1mMGNiLTRmMzQtOWNhMS03YzJhNGNmMTEzNDgiLCJ0cyI6MTcwMzIwOTQ5ODMzNH0
Content-Type: application/json

{
    "pageSize": 2,
    "pageNumber": 1,
    "autopStatus": [
        "DISABLE"
    ]
}
レスポンス例
HTTP/1.1 200 OK
{
    "data": {
        "pageSize": 2,
        "pageNumber": 1,
        "total": 2,
        "content": [
            {
                "sn": "6785C3807364xxxx",
                "rpsStatus": "UNACTIVATED",
                "name": "Comfort Sensor Room-3D",
                "model": "AM308",
                "application": {
                    "applicationId": "1734475086466600962",
                    "applicationName": "Demo"
                },
                "project": "Workplace",
                "description": "Comfort Sensor of Room-3D",
                "licenseStatus": "VALID",
                "deviceType": "SUB-DEVICE",
                "tag": [],
                "deviceId": "1742010610312101890",
                "devEUI": "24E124785C38xxxx",
                "connectStatus": "DISCONNECT"
            },
            {
                "sn": "6791D1970467xxxx",
                "rpsStatus": "UNACTIVATED",
                "name": "Demo Device",
                "model": "TH-Motion Sensor",
                "hardwareVersion": "v1.0",
                "firmwareVersion": "v1.1",
                "electricity": 97,
                "lastUpdateTime": 1704180118083,
                "application": {
                    "applicationId": "1734475086466600962",
                    "applicationName": "Demo"
                },
                "project": "Workspace",
                "description": "TH-Motion Sensor of Room 4A",
                "licenseStatus": "VALID",
                "deviceType": "SUB-DEVICE",
                "tag": [],
                "deviceId": "1739930666380779522",
                "devEUI": "24E124791D19xxxx",
                "connectStatus": "ONLINE"
            }
        ]
    },
    "status": "Success",
    "requestId": "63abfe424fa8c7d273e36d74d87b56b0"
}

関連記事

ソリューション / IoT サポート

  • ▢3. Milesight開発プラットフォームAPIの概要
    システムをサードパーティのアプリケーションと統合するためのアプリケーションプログラミングインターフェース (API) を提供しています
  • 3.1.1.1 APIリクエスト構造
    Milesight Development Platform APIのリクエスト構造について説明します
  • 3.1.1.2 API レスポンス結果
    APIリクエストを受信すると、Milesight Development Platformはリクエストの結果を示すHTTPステータスコードと、API呼び出しで要求された情報を含むJSONレスポンスボディを返します。
  • 3.1.2 API インターフェース一覧
    このトピックでは、Milesight Development Platform API のインターフェースの要約リストを提供します。
  • 3.1.3.1 API 認証ルール
    Milesight Development Platform APIは、OAuth 2.0を使用して認証を行い、アプリケーションがMilesight Development Platform上のリソースにアクセスするためのセキュアなトークンを発行します。
  • 3.1.3.2 API アクセス トークンの取得
    アクセス トークンは、認証された API 呼び出しを検証するために使用されます。アプリケーションはまずアクセス トークンをリクエストし、その後、Milesight Development Platform API にアクセスするすべてのリクエストにそのトークンを含める必要があります。
  • 3.1.3.3 API アクセス トークンの更新
    Milesight Development Platformとアプリケーション間の安全でスムーズな通信を確保するため、アクセス トークンが有効期限切れになる前に更新する必要があります。
  • 3.1.4.1 デバイスを追加する
    Milesight Development Platform にデバイスを追加し、現在のアプリケーションに関連付けます。
  • 3.1.4.2 特定のデバイスを検索する
    現在のアプリケーションに関連付けられているすべてのデバイスから、特定のデバイスを検索します。

Milesight製品

ウェーブクレスト株式会社が運営するMilesight製品特設サイトです

居住者の健康を確保

お知らせ

  1. 2025-4-3

    ピープル・センシング 駆動型スマートビルディング

    People Sensing Insights を通じてビルインテリジェンスに革命をもたらします。…
  2. 2023-7-21

    LoRaWANの説明: 理論から実践へのガイド

    この包括的なビデオでは、LoRaWANを深く掘り下げ、その仕組み、利点、アプリケーションについて説明…
  3. 2023-4-6

    センシング・インサイト Milesight リブランディングのお知らせ

    https://youtu.be/r40DK40DjIY …
ページ上部へ戻る