|
パラメータ名
|
説明
|
ベースタイプ
|
|---|---|---|
|
networkName
|
フィルタを適用するネットワークの名前。クエリーはそのネットワーク内の Thing で見つかった結果のみを返します。
|
STRING
|
|
networkParentNode
|
networkName で指定したネットワーク内の最上位ノードの名前。そのネットワーク内の指定された親ノードのすべての子が返されます。
|
STRING
|
|
networkMaxDepth
|
親ノードの子を検索するレベル。1 は直接の子を返し、2 は子の子を返します。0 または default/null に設定されている場合、子の完全な階層を返します。
|
INTEGER
|
|
offset
|
指定した値による結果のオフセット。たとえば、データベース内に 200 個の結果があり、オフセットが 5 に設定されている場合、5 から 200 までの結果 (合計 195) が返されます。
offset を maxItems と組み合わせることでページ付けをシミュレーションできます。クエリーで返される結果の数が多くなるほど、クエリー時間が長くなることがあります。
たとえば、Thing 1 から 1000 が存在し、maxItems が 5 の場合、各ページには結果が 5 つ表示されます。
• ページ 1: offset は 0。maxItems は 5 なので、最初の 5 つの結果が返されます。
• ページ 2: offset は 5。結果 6 から 10 が返されます。
• ページ 3: offset は 10。結果 11 から 15 が返されます。
• 以下同様。
この例では、返される結果の数が少ないので、クエリー時間は短くなります。
|
NUMBER
|
|
basicPropertyNames
|
基本プロパティの名前をリストします。
|
INFOTABLE
|
|
withPermissions
|
アクセス許可を考慮するかどうかを指定する BOOLEAN パラメータ (true または false)。true の場合、操作を実行する前にサービスによってアクセス許可がチェックされます。
|
BOOLEAN
|
|
nameMask
|
名前をフィルタするためのパターンまたはマスクを指定します。
|
STRING
|
|
propertyNames
|
取得または操作するプロパティの名前をリストします。
|
INFOTABLE
|
|
query
|
結果をフィルタするためのクエリーパラメータを定義します。
|
QUERY
|
|
networkName
|
ネットワークの名前を指定します。
|
STRING
|
|
maxItems
|
ページ付けのページサイズと同様に、必要なアイテムの最大数を指定します。これは、結果の 1 ページで返されるアイテムの数を制御するのに役立ちます。
|
NUMBER
|
|
tags
|
フィルタするデータタグ。
|
TAGS
|
// result: INFOTABLE dataShape: "RootEntityList"
let result = ThingTemplates["GenericThing"].QueryImplementingThingsOptimized({
networkParentNode: undefined /* STRING */,
networkMaxDepth: undefined /* INTEGER {"defaultValue":0} */,
maxItems: undefined /* NUMBER {"defaultValue":500} */,
basicPropertyNames: undefined /* INFOTABLE {"dataShape":"EntityList"} */,
withPermissions: undefined /* BOOLEAN {"defaultValue":false} */,
offset: undefined /* NUMBER {"defaultValue":0} */,
nameMask: undefined /* STRING */,
propertyNames: undefined /* INFOTABLE {"dataShape":"EntityList"} */,
query: undefined /* QUERY */,
networkName: undefined /* STRING */,
tags: undefined /* TAGS */
});