From b3799cef3e3c3a78b73aa6971737bd60280b43f1 Mon Sep 17 00:00:00 2001 From: Kazuhito Suda Date: Fri, 3 Nov 2023 21:16:30 +0900 Subject: [PATCH] (JP) [Doc] Add geofencing subscription example (#4431) --- doc/manuals.jp/orion-api.md | 38 +++++++++++++++++++++++++++++++++---- 1 file changed, 34 insertions(+), 4 deletions(-) diff --git a/doc/manuals.jp/orion-api.md b/doc/manuals.jp/orion-api.md index 2653b3fd81..347963a9cc 100644 --- a/doc/manuals.jp/orion-api.md +++ b/doc/manuals.jp/orion-api.md @@ -3698,7 +3698,7 @@ _**レスポンス・ペイロード**_ | パラメータ | オプション | タイプ | 説明 | |-------------------|------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `attrs` | ✓ | array | 通知をトリガーする属性名の配列。空のリストは許可されていません | -| `expression` | ✓ | object | `q`, `mq`, `georel`, `geometry`, `coords` で構成される式 (このフィールドについては、上記の [エンティティをリスト](#list-entities-get-v2entities)操作を参照してください)。`expression` とサブ要素 (つまり `q`) にはコンテンツが必要です。つまり、`{}` または `""` は許可されません | +| `expression` | ✓ | object | `q`, `mq`, `georel`, `geometry`, `coords` で構成される式 (このフィールドについては、上記の [エンティティをリスト](#list-entities-get-v2entities)操作を参照してください)。`expression` とサブ要素 (つまり `q`) にはコンテンツが必要です。つまり、`{}` または `""` は許可されません。`georel`, `geometry`, および `coords` は一緒に使用する必要があります (つまり、"全てか無しか")。 geoquery を式として使用する例は下記(#create-subscription-post-v2subscriptions) を確認してください | | `alterationTypes` | ✓ | array | サブスクリプションがトリガーされる変更 (エンティティの作成、エンティティの変更など) を指定します ([変更タイプに基づくサブスクリプション](#subscriptions-based-in-alteration-type)のセクションを参照) | | `notifyOnMetadataChange` | ✓ | boolean | `true` の場合、メタデータは通知のコンテキストで属性の値の一部と見なされるため、値が変更されずにメタデータが変更された場合、通知がトリガーされます。`false` の場合、メタデータは通知のコンテキストで属性の値の一部と見なされないため、値が変更されずにメタデータが変更された場合、通知はトリガーされません。デフォルト値は `true` です | @@ -3927,7 +3927,7 @@ _**リクエスト・ペイロード**_ ペイロードは、JSON サブスクリプション表現形式 ([サブスクリプション・ペイロード・データモデル](#subscription-payload-datamodel) セクションで説明されています) に従うサブスクリプションを含む JSON オブジェクトです。 -例: +属性フィルタを使用した例: ```json { @@ -3952,8 +3952,38 @@ _**リクエスト・ペイロード**_ }, "attrs": ["temperature", "humidity"] }, - "expires": "2025-04-05T14:00:00.00Z", - "throttling": 5 + "expires": "2025-04-05T14:00:00.00Z" +} +``` + +条件としてジオクエリを使用する例: + +```json +{ + "description": "One subscription to rule them all", + "subject": { + "entities": [ + { + "idPattern": ".*", + "type": "Room" + } + ], + "condition": { + "attrs": [ "temperature" ], + "expression": { + "georel": "near;maxDistance:15000", + "geometry": "point", + "coords": "37.407804,-6.004552" + } + } + }, + "notification": { + "http": { + "url": "http://localhost:1234" + }, + "attrs": ["temperature", "humidity"] + }, + "expires": "2025-04-05T14:00:00.00Z" } ```