list_devices
Retrieve tenant-linked devices with current registration and update values. Provide tenant ID to list devices, optionally including full format definitions and alert recipients.
Instructions
テナントに紐づく地点(端末)の一覧を取得します。
Web管理画面の地点編集一覧と同じ情報(登録・更新項目の現在値)が得られます。 tenant_id は list_tenants で取得してください。
必要な権限レベル: 制限なし(どのユーザーレベルでも実行できます)。
既定で間引く項目:
format_detail(項目定義。1フォーマットあたり数百件)→ format_detail_count のみ。 全量は include_format_detail=true
address(通知先。メールアドレスを含む)→ alert_count のみ。全量は include_alerts=true
periodic_collection は、項目追加前に作成された既存地点では null になることがあります。 欠損と「停止(stop)」を取り違えないよう、null はそのまま返します。
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ページ番号(1始まり)。0 を指定すると全件取得になるが、件数が多いと応答が非常に大きくなるため通常は指定しない | |
| per_page | No | 1ページあたりの件数(1〜999) | |
| group_cds | No | 現場CDによる絞り込み。複数指定時は OR 条件。list_groups で取得できる | |
| tenant_id | Yes | テナントID(UUID)。list_tenants で取得できる | |
| include_alerts | No | 地点の通知先(address)の全量を含める。メールアドレスを含む | |
| include_format_detail | No | フォーマット項目定義(format_detail)の全量を含める。1地点あたり数百件になりうる |