Time Series Instances - Search

リファレンス

サービス:: Time Series Insights

API バージョン:: 2020-07-31

インスタンス属性に基づく時系列インスタンスの検索でのヒットの一部の一覧。

POST https://{environmentFqdn}/timeseries/instances/search?api-version=2020-07-31

URI パラメーター

名前	/	必須	型	説明
environmentFqdn	path	True	string	環境ごとの FQDN (たとえば、10000000-0000-0000-0000-100000000109.env.timeseries.azure.com)。このドメイン名は、Get Environments API、Azure portal、または Azure Resource Manager の応答から取得できます。
api-version	query	True	string	クライアント要求で使用する API のバージョン。現在サポートされているバージョンは "2020-07-31" です。

要求ヘッダー

名前	型	説明
x-ms-continuation	string	改ページをサポートする呼び出しで結果の次のページを取得する結果の前のページからの継続トークン。最初のページの結果を取得するには、null 継続トークンをパラメーター値として指定します。すべての結果が返され、結果の次のページがない場合、返される継続トークンは null です。
x-ms-client-request-id	string	オプションのクライアント要求 ID。サービスはこの値を記録します。サービスがサービス間で操作をトレースできるようにし、顧客が特定の要求に関してサポートに連絡できるようにします。
x-ms-client-session-id	string	オプションのクライアントセッション ID。サービスはこの値を記録します。サービスがサービス間で関連する操作のグループをトレースできるようにし、顧客が特定の要求グループに関するサポートに問い合わせることができます。

要求本文

名前	必須	型	説明
searchString	True	string	時系列インスタンスの属性に一致するクエリ検索文字列。例: "floor 100"。大文字と小文字を区別せず、存在する必要がありますが、空の文字列でもかまいません。
hierarchies		SearchInstancesHierarchiesParameters	時系列インスタンス階層を返す方法のパラメーター。 null の場合、階層は返されません。インスタンスパラメーターが null で、階層パラメーターが null でない場合は、インスタンスのない階層のみが返されます。
instances		SearchInstancesParameters	時系列インスタンスを返す方法のパラメーター。 null を指定できます。インスタンスと階層の両方のパラメーターが null の場合、インスタンスはパラメーターの既定値に基づいて結果で返され、階層は返されません。
path		string[]	時系列インスタンスの階層パスでフィルター処理します。パスは、文字列パスセグメントの配列として表されます。最初の要素は階層名にする必要があります。例: ["Location", "California"] 省略可能で、大文字と小文字が区別され、空になることがなく、null になる可能性があります。

応答

名前	型	説明
200 OK	SearchInstancesResponsePage	検索応答が成功しました。ヘッダー x-ms-request-id: string
Other Status Codes	TsiError	予期しないエラー。ヘッダー x-ms-request-id: string

名前

型

説明

200 OK

SearchInstancesResponsePage

検索応答が成功しました。

ヘッダー

x-ms-request-id: string

Other Status Codes

TsiError

予期しないエラー。

ヘッダー

x-ms-request-id: string

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

SearchInstancesDefault

SearchInstancesExpandHierarchiesOnly

SearchInstancesHierarchiesDefaultInputPage1

SearchInstancesHierarchiesDefaultInputPage2

SearchInstancesHierarchiesDefaultInputPage3

SearchInstancesOneLevel

SearchInstancesRecursive

SearchInstancesUntilChildren

SearchInstancesDefault

要求のサンプル

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100"
}

応答のサンプル

状態コード:: 200

{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1One",
          "Id2One",
          "1.0"
        ],
        "name": "instance1",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      },
      {
        "timeSeriesId": [
          "Id1Two",
          "Id2Two",
          "2.0"
        ],
        "name": "instance2",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      }
    ],
    "hitCount": 2,
    "continuationToken": null
  },
  "hierarchyNodes": null
}

SearchInstancesExpandHierarchiesOnly

要求のサンプル

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": [
    "Location"
  ],
  "instances": null,
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "Name"
    },
    "pageSize": 2
  }
}

応答のサンプル

状態コード:: 200

{
  "instances": {
    "hits": [],
    "hitCount": 0,
    "continuationToken": null
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "California",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "San Diego",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            },
            {
              "name": "San Francisco",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            }
          ],
          "hitCount": 2,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesHierarchiesDefaultInputPage1

要求のサンプル

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "Rank"
    },
    "highlights": true,
    "pageSize": 1
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "CumulativeInstanceCount"
    },
    "pageSize": 1
  }
}

応答のサンプル

状態コード:: 200

{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1Two",
          "Id2Two",
          "2.0"
        ],
        "name": "instance2",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": {
          "timeSeriesId": [
            "Id1Two",
            "Id2Two",
            "2.0"
          ],
          "typeName": "DefaultType",
          "name": "instance2",
          "description": "<hit>floor</hit> <hit>100</hit>",
          "hierarchyIds": [
            "1643004c-0a84-48a5-80e5-7688c5ae9295"
          ],
          "hierarchyNames": [
            "Location"
          ],
          "instanceFieldNames": [
            "state",
            "city"
          ],
          "instanceFieldValues": [
            "California",
            "San Francisco"
          ]
        }
      }
    ],
    "hitCount": 2,
    "continuationToken": "c3sic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNTE3MDUxOTg0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0="
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "Location",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "California",
              "cumulativeInstanceCount": 2,
              "hierarchyNodes": {
                "hits": [
                  {
                    "name": "San Francisco",
                    "cumulativeInstanceCount": 1,
                    "hierarchyNodes": null
                  }
                ],
                "hitCount": 2,
                "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0="
              }
            }
          ],
          "hitCount": 1,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesHierarchiesDefaultInputPage2

要求のサンプル

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "Rank"
    },
    "highlights": true,
    "pageSize": 1
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "CumulativeInstanceCount"
    },
    "pageSize": 1
  }
}

応答のサンプル

状態コード:: 200

{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1One",
          "Id2One",
          "1.0"
        ],
        "name": "instance1",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": {
          "timeSeriesId": [
            "Id1One",
            "Id2One",
            "1.0"
          ],
          "typeName": "DefaultType",
          "name": "instance1",
          "description": "<hit>floor</hit> <hit>100</hit>",
          "hierarchyIds": [
            "1643004c-0a84-48a5-80e5-7688c5ae9295"
          ],
          "hierarchyNames": [
            "Location"
          ],
          "instanceFieldNames": [
            "state",
            "city"
          ],
          "instanceFieldValues": [
            "California",
            "Los Angeles"
          ]
        }
      }
    ],
    "hitCount": 2,
    "continuationToken": null
  },
  "hierarchyNodes": null
}

SearchInstancesHierarchiesDefaultInputPage3

要求のサンプル

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "Rank"
    },
    "highlights": true,
    "pageSize": 1
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "CumulativeInstanceCount"
    },
    "pageSize": 1
  }
}

応答のサンプル

状態コード:: 200

{
  "instances": null,
  "hierarchyNodes": {
    "hits": [
      {
        "name": "Location",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "California",
              "cumulativeInstanceCount": 2,
              "hierarchyNodes": {
                "hits": [
                  {
                    "name": "San Diego",
                    "cumulativeInstanceCount": 1,
                    "hierarchyNodes": null
                  }
                ],
                "hitCount": 2,
                "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0="
              }
            }
          ],
          "hitCount": 1,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesOneLevel

要求のサンプル

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": false,
    "sort": {
      "by": "DisplayName"
    },
    "highlights": false,
    "pageSize": 2
  },
  "hierarchies": {
    "expand": {
      "kind": "OneLevel"
    },
    "sort": {
      "by": "Name"
    },
    "pageSize": 2
  }
}

応答のサンプル

状態コード:: 200

{
  "instances": {
    "hits": [],
    "hitCount": 0,
    "continuationToken": null
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "Location",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": null
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesRecursive

要求のサンプル

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "DisplayName"
    },
    "highlights": false,
    "pageSize": 2
  },
  "hierarchies": null
}

応答のサンプル

状態コード:: 200

{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1One",
          "Id2One",
          "1.0"
        ],
        "name": "instance1",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      },
      {
        "timeSeriesId": [
          "Id1Two",
          "Id2Two",
          "2.0"
        ],
        "name": "instance2",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      }
    ],
    "hitCount": 2,
    "continuationToken": null
  },
  "hierarchyNodes": null
}

SearchInstancesUntilChildren

要求のサンプル

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": [
    "Location"
  ],
  "instances": {
    "recursive": false,
    "sort": {
      "by": "DisplayName"
    },
    "highlights": false,
    "pageSize": 2
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "Name"
    },
    "pageSize": 2
  }
}

応答のサンプル

状態コード:: 200

{
  "instances": {
    "hits": [],
    "hitCount": 0,
    "continuationToken": null
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "California",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "San Diego",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            },
            {
              "name": "San Francisco",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            }
          ],
          "hitCount": 2,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

定義

名前	説明
HierarchiesExpandKind	階層ノードの拡張の種類。 "UntilChildren" に設定すると、複数の子が存在するまで階層ノードが再帰的に展開されます。 "OneLevel" に設定すると、階層はパス検索インスタンスパラメーターに一致する単一レベルでのみ展開されます。省略可能。既定値は 'UntilChildren' です。
HierarchiesExpandParameter	同じ検索インスタンス呼び出しで階層ノードを展開するかどうかを定義します。
HierarchiesSortBy	階層ノードの並べ替えに使用する値。 "CumulativeInstanceCount" に設定すると、返される階層は、階層ノードとその子階層ノードに属するインスタンスの合計数に基づいて並べ替えられます。 "名前" に設定すると、返される階層は階層名に基づいて並べ替えられます。省略可能。既定値は 'CumulativeInstanceCount' です。
HierarchiesSortParameter	階層ノードの並べ替えの定義。
HierarchyHit	入力に基づいてクエリに一致するインスタンスを含む階層ノード。空または null の場合があります。
Highlights	ユーザーに表示する時系列インスタンスの強調表示されたテキスト。検索文字列と一致したテキストの部分で、挿入タグとタグを強調表示します。強調表示されているプロパティを使用して、さらに API 呼び出しを行わないでください。
InstanceHit	インスタンス検索呼び出しによって返される時系列インスタンス。返されたインスタンスが検索要求に一致し、'true' に設定されている場合にユーザーに表示される強調表示されたテキストが含まれています。
InstancesSortBy	検索インスタンス呼び出しによって返される前の時系列インスタンスの並べ替えに使用する値。 "Rank" に設定すると、返されるインスタンスは関連性に基づいて並べ替えられます。 'DisplayName' に設定すると、返される結果は表示名に基づいて並べ替えられます。表示名はインスタンスが存在する場合はインスタンスの名前、それ以外の場合は表示名は時系列 ID です。既定値は 'Rank' です。
InstancesSortParameter	検索インスタンス呼び出しによって返される前に時系列インスタンスを並べ替える方法の定義。
SearchHierarchyNodesResponse	入力に基づいてクエリに一致するインスタンスを含む階層ノード。空または null の場合があります。
SearchInstancesHierarchiesParameters	検索インスタンス呼び出しによって時系列インスタンス階層を返す方法のパラメーター。
SearchInstancesParameters	検索インスタンス呼び出しによって時系列インスタンスを返す方法のパラメーター。
SearchInstancesRequest	時系列インスタンスに対して検索クエリを実行し、一致する時系列インスタンスを返す要求。
SearchInstancesResponse	入力に基づいてクエリに一致するインスタンス。空または null の場合があります。
SearchInstancesResponsePage	検索結果の単一ページ。
TsiError	API エラーに関する情報。
TsiErrorBody	エラーコードとメッセージを含む特定の API エラー。
TsiErrorDetails	追加のエラー情報。

HierarchiesExpandKind

列挙

階層ノードの拡張の種類。 "UntilChildren" に設定すると、複数の子が存在するまで階層ノードが再帰的に展開されます。 "OneLevel" に設定すると、階層はパス検索インスタンスパラメーターに一致する単一レベルでのみ展開されます。省略可能。既定値は 'UntilChildren' です。

値	説明
OneLevel
UntilChildren

HierarchiesExpandParameter

Object

同じ検索インスタンス呼び出しで階層ノードを展開するかどうかを定義します。

名前	型	説明
kind	HierarchiesExpandKind	階層ノードの拡張の種類。 "UntilChildren" に設定すると、複数の子が存在するまで階層ノードが再帰的に展開されます。 "OneLevel" に設定すると、階層はパス検索インスタンスパラメーターに一致する単一レベルでのみ展開されます。省略可能。既定値は 'UntilChildren' です。

HierarchiesSortBy

列挙

階層ノードの並べ替えに使用する値。 "CumulativeInstanceCount" に設定すると、返される階層は、階層ノードとその子階層ノードに属するインスタンスの合計数に基づいて並べ替えられます。 "名前" に設定すると、返される階層は階層名に基づいて並べ替えられます。省略可能。既定値は 'CumulativeInstanceCount' です。

値	説明
CumulativeInstanceCount
Name

HierarchiesSortParameter

Object

階層ノードの並べ替えの定義。

名前	型	説明
by	HierarchiesSortBy	階層ノードの並べ替えに使用する値。 "CumulativeInstanceCount" に設定すると、返される階層は、階層ノードとその子階層ノードに属するインスタンスの合計数に基づいて並べ替えられます。 "名前" に設定すると、返される階層は階層名に基づいて並べ替えられます。省略可能。既定値は 'CumulativeInstanceCount' です。

HierarchyHit

Object

入力に基づいてクエリに一致するインスタンスを含む階層ノード。空または null の場合があります。

名前	型	説明
cumulativeInstanceCount	integer (int32)	このノードに属し、クエリに一致するサブツリーであるインスタンスの合計数。
hierarchyNodes	SearchHierarchyNodesResponse	このノードの子階層ノード。空または null の場合があります。
name	string	階層ノードの名前。空の場合があります。null にすることはできません。

Highlights

Object

ユーザーに表示する時系列インスタンスの強調表示されたテキスト。検索文字列と一致したテキストの部分で、挿入タグとタグを強調表示します。強調表示されているプロパティを使用して、さらに API 呼び出しを行わないでください。

名前	型	説明
description	string	時系列インスタンスの強調表示された説明。 null を指定できます。
hierarchyIds	string[]	時系列インスタンスが属する強調表示された時系列階層 ID の一覧。階層の参照には使用できません。 null を指定できます。
hierarchyNames	string[]	時系列インスタンスが属する強調表示された時系列階層名の一覧。階層の参照には使用できません。 null を指定できます。
instanceFieldNames	string[]	強調表示されている時系列インスタンスフィールド名の一覧。 null を指定できます。
instanceFieldValues	string[]	強調表示された時系列インスタンスフィールド値の一覧。 null を指定できます。
name	string	時系列インスタンスの強調表示された名前。 null を指定できます。
timeSeriesId	string[]	表示するタイムシリーズ ID の強調表示された文字列値の一覧。インスタンスの参照には使用できません。
typeName	string	このインスタンスが属している時系列型の名前が強調表示されています。

InstanceHit

Object

インスタンス検索呼び出しによって返される時系列インスタンス。返されたインスタンスが検索要求に一致し、'true' に設定されている場合にユーザーに表示される強調表示されたテキストが含まれています。

名前	型	説明
hierarchyIds	string[]	検索要求に一致した時系列インスタンスが属する時系列階層 ID の一覧。階層の参照には使用できません。 null を指定できます。
highlights	Highlights	ユーザーに表示する時系列インスタンスの強調表示されたテキスト。検索文字列と一致したテキストの部分で、挿入タグとタグを強調表示します。強調表示されているプロパティを使用して、さらに API 呼び出しを行わないでください。
name	string	検索要求に一致した時系列インスタンスの名前。 null を指定できます。
timeSeriesId	TimeSeriesId[]	検索要求に一致した時系列インスタンスの時系列 ID。
typeId	string	検索要求に一致した時系列インスタンスが属する型を表します。 null を指定しないでください。

InstancesSortBy

列挙

検索インスタンス呼び出しによって返される前の時系列インスタンスの並べ替えに使用する値。 "Rank" に設定すると、返されるインスタンスは関連性に基づいて並べ替えられます。 'DisplayName' に設定すると、返される結果は表示名に基づいて並べ替えられます。表示名はインスタンスが存在する場合はインスタンスの名前、それ以外の場合は表示名は時系列 ID です。既定値は 'Rank' です。

値	説明
DisplayName
Rank

InstancesSortParameter

Object

検索インスタンス呼び出しによって返される前に時系列インスタンスを並べ替える方法の定義。

名前	型	説明
by	InstancesSortBy	検索インスタンス呼び出しによって返される前の時系列インスタンスの並べ替えに使用する値。 "Rank" に設定すると、返されるインスタンスは関連性に基づいて並べ替えられます。 'DisplayName' に設定すると、返される結果は表示名に基づいて並べ替えられます。表示名はインスタンスが存在する場合はインスタンスの名前、それ以外の場合は表示名は時系列 ID です。既定値は 'Rank' です。

SearchHierarchyNodesResponse

Object

入力に基づいてクエリに一致するインスタンスを含む階層ノード。空または null の場合があります。

名前	型	説明
continuationToken	string	返された場合、現在の結果は部分的な結果を表します。継続トークンを使用すると、結果の次のページを取得できます。クエリ結果の次のページを取得するには、"x-ms-continuation" HTTP ヘッダーに継続トークンパラメーターを指定して同じ要求を送信します。
hitCount	integer (int32)	入力に基づいてクエリに一致するインスタンスを含む階層ノードの合計数。
hits	HierarchyHit[]	入力に基づいてクエリに一致するインスタンスを含む階層ノードの一覧。空の場合があります。

SearchInstancesHierarchiesParameters

Object

検索インスタンス呼び出しによって時系列インスタンス階層を返す方法のパラメーター。

名前	型	説明
expand	HierarchiesExpandParameter	同じ検索インスタンス呼び出しで階層ノードを展開するかどうかを定義します。省略可能。既定値は 'UntilChildren' です。
pageSize	integer (int32)	同じページで返される同じレベルの階層の最大数。省略可能。既定値は、設定されていない場合は 10 です。範囲は 1 から 100 です。ページサイズを超える結果がある場合は、継続トークンを使用して次のページをフェッチできます。
sort	HierarchiesSortParameter	階層ノードの並べ替えの定義。省略可能。既定値は 'CumulativeInstanceCount' です。

SearchInstancesParameters

Object

検索インスタンス呼び出しによって時系列インスタンスを返す方法のパラメーター。

名前	型	説明
highlights	boolean	強調表示された検索結果の定義かどうか。 'true' に設定すると、強調表示された検索結果が返されます。 'false' に設定されている場合、強調表示された検索結果は返されません。既定値は 'true' です。
pageSize	integer (int32)	結果の各ページで予想されるインスタンスの最大数。既定値は、設定されていない場合は 10 です。範囲は 1 から 100 です。ページサイズを超える結果がある場合、ユーザーは継続トークンを使用して次のページをフェッチできます。
recursive	boolean	返されるインスタンスの定義。 recursive が 'true' に設定されている場合、path パラメーターで始まるパスを持つすべてのインスタンスが返されます。 recursive が 'false' に設定されている場合、path パラメーターと正確に一致するパスを持つインスタンスのみが返されます。再帰検索を使用すると、検索ユーザーエクスペリエンスを実装できます。一方、非再帰検索を使用すると、ナビゲーションエクスペリエンスを実装できます。省略可能。既定値は 'true' です。
sort	InstancesSortParameter	検索インスタンス呼び出しによって返される前に時系列インスタンスを並べ替える方法の定義 (関連性またはアルファベット順)。省略可能。既定値は "Rank" です。

SearchInstancesRequest

Object

時系列インスタンスに対して検索クエリを実行し、一致する時系列インスタンスを返す要求。

名前	型	説明
hierarchies	SearchInstancesHierarchiesParameters	時系列インスタンス階層を返す方法のパラメーター。 null の場合、階層は返されません。インスタンスパラメーターが null で、階層パラメーターが null でない場合は、インスタンスのない階層のみが返されます。
instances	SearchInstancesParameters	時系列インスタンスを返す方法のパラメーター。 null を指定できます。インスタンスと階層の両方のパラメーターが null の場合、インスタンスはパラメーターの既定値に基づいて結果で返され、階層は返されません。
path	string[]	時系列インスタンスの階層パスでフィルター処理します。パスは、文字列パスセグメントの配列として表されます。最初の要素は階層名にする必要があります。例: ["Location", "California"] 省略可能で、大文字と小文字が区別され、空になることがなく、null になる可能性があります。
searchString	string	時系列インスタンスの属性に一致するクエリ検索文字列。例: "floor 100"。大文字と小文字を区別せず、存在する必要がありますが、空の文字列でもかまいません。

SearchInstancesResponse

Object

入力に基づいてクエリに一致するインスタンス。空または null の場合があります。

名前	型	説明
continuationToken	string	返された場合、現在の結果は部分的な結果を表します。継続トークンを使用すると、結果の次のページを取得できます。クエリ結果の次のページを取得するには、"x-ms-continuation" HTTP ヘッダーに継続トークンパラメーターを指定して同じ要求を送信します。
hitCount	integer (int32)	入力に基づいてクエリに一致するインスタンスの合計数。
hits	InstanceHit[]	入力に基づいてクエリに一致するインスタンスの一覧。空の場合があります。

SearchInstancesResponsePage

Object

検索結果の単一ページ。

名前	型	説明
hierarchyNodes	SearchHierarchyNodesResponse	入力に基づいてクエリに一致するインスタンスを含む階層ノード。空または null の場合があります。
instances	SearchInstancesResponse	入力に基づいてクエリに一致するインスタンス。空または null の場合があります。

TsiError

Object

API エラーに関する情報。

名前	型	説明
error	TsiErrorBody	エラーコードとメッセージを含む特定の API エラー。

TsiErrorBody

Object

エラーコードとメッセージを含む特定の API エラー。

名前	型	説明
code	string	サービス固有のエラーコードを定義する、言語に依存しない人間が判読できる文字列。このコードは、応答で指定された HTTP エラーコードのより具体的なインジケーターとして機能します。特定のエラーケースをプログラムで処理するために使用できます。
details	TsiErrorDetails[]	追加のエラー情報が含まれています。 null を指定できます。
innerError	TsiErrorBody	原因を絞り込む、より具体的なエラーが含まれています。 null を指定できます。
message	string	エラーの人間が判読できる、言語に依存しない表現。これは開発者の支援を目的としており、エンドユーザーへの公開には適していません。
target	string	特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。 null を指定できます。

TsiErrorDetails

Object

追加のエラー情報。

名前	型	説明
code	string	サービス固有のエラーコードを定義する、言語に依存しない人間が判読できる文字列。このコードは、応答で指定された HTTP エラーコードのより具体的なインジケーターとして機能します。特定のエラーケースをプログラムで処理するために使用できます。
message	string	エラーの人間が判読できる、言語に依存しない表現。これは開発者の支援を目的としており、エンドユーザーへの公開には適していません。

次の方法で共有

Time Series Instances - Search

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

スコープ

例

SearchInstancesDefault

要求のサンプル

応答のサンプル

SearchInstancesExpandHierarchiesOnly

要求のサンプル

応答のサンプル

SearchInstancesHierarchiesDefaultInputPage1

要求のサンプル

応答のサンプル

SearchInstancesHierarchiesDefaultInputPage2

要求のサンプル

応答のサンプル

SearchInstancesHierarchiesDefaultInputPage3

要求のサンプル

応答のサンプル

SearchInstancesOneLevel

要求のサンプル

応答のサンプル

SearchInstancesRecursive

要求のサンプル

応答のサンプル

SearchInstancesUntilChildren

要求のサンプル

応答のサンプル

定義

HierarchiesExpandKind

HierarchiesExpandParameter

HierarchiesSortBy

HierarchiesSortParameter

HierarchyHit

Highlights

InstanceHit

InstancesSortBy

InstancesSortParameter

SearchHierarchyNodesResponse

SearchInstancesHierarchiesParameters

SearchInstancesParameters

SearchInstancesRequest

SearchInstancesResponse

SearchInstancesResponsePage

TsiError

TsiErrorBody

TsiErrorDetails