Sdílet prostřednictvím

Time Series Instances - Search

  • Reference
Služba:
Time Series Insights
Verze rozhraní API:
2020-07-31

Částečný seznam přístupů k vyhledávání instancí časových řad na základě atributů instance

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
environmentFqdn
 path True

string

Plně kvalifikovaný název domény prostředí, například 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Tento název domény můžete získat z odpovědi rozhraní API Get Environment, Azure Portal nebo Azure Resource Manager.
api-version
 query True

string

Verze rozhraní API, která se má použít s požadavkem klienta. Aktuálně podporovaná verze je "2020-07-31".

Hlavička požadavku

Name Vyžadováno Typ Description
x-ms-continuation

string

Token pokračování z předchozí stránky výsledků pro načtení další stránky výsledků ve voláních, která podporují stránkování. Pokud chcete získat výsledky první stránky, zadejte jako hodnotu parametru token pokračování null. Vrácený pokračovací token má hodnotu null, pokud byly vráceny všechny výsledky a není k dispozici žádná další stránka výsledků.
x-ms-client-request-id

string

Volitelné ID žádosti klienta. Služba tuto hodnotu zaznamenává. Umožňuje službě trasovat operace napříč službami a umožňuje zákazníkovi kontaktovat podporu ohledně konkrétní žádosti.
x-ms-client-session-id

string

Volitelné ID relace klienta. Služba tuto hodnotu zaznamenává. Umožňuje službě trasovat skupinu souvisejících operací mezi službami a umožňuje zákazníkovi kontaktovat podporu ohledně konkrétní skupiny žádostí.

Text požadavku

Name Vyžadováno Typ Description
searchString True

string

Vyhledávací řetězec dotazu, který bude odpovídat atributům instancí časových řad. Příklad: "floor 100". Nerozlišují se velká a malá písmena, musí existovat, ale může to být prázdný řetězec.
hierarchies

SearchInstancesHierarchiesParameters

Parametry vrácení hierarchií instancí časových řad Pokud je hodnota null, hierarchie se nevrátí. Pokud parametr instances má hodnotu null a parametr hierarchie nemá hodnotu null, vrátí se pouze hierarchie bez instancí.
instances

SearchInstancesParameters

Parametry, jak vracet instance časových řad Může mít hodnotu null. Pokud mají parametry instance i hierarchie hodnotu null, vrátí se instance ve výsledcích na základě výchozích hodnot parametrů a hierarchie se nevrátí.
path

string[]

Filtrujte hierarchii cesty instancí časových řad. Cesta je reprezentována jako pole segmentů cesty řetězce. První prvek by měl být název hierarchie. Příklad: ["Umístění", "Kalifornie"]. Volitelné s rozlišováním velkých a malých písmen, nikdy prázdné a může mít hodnotu null.

Odpovědi

Name Typ Description
200 OK

SearchInstancesResponsePage

Odpověď hledání byla úspěšná.

Hlavičky

x-ms-request-id: string
Other Status Codes

TsiError

Neočekávaná chyba.

Hlavičky

x-ms-request-id: string

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

SearchInstancesDefault
SearchInstancesExpandHierarchiesOnly
SearchInstancesHierarchiesDefaultInputPage1
SearchInstancesHierarchiesDefaultInputPage2
SearchInstancesHierarchiesDefaultInputPage3
SearchInstancesOneLevel
SearchInstancesRecursive
SearchInstancesUntilChildren

SearchInstancesDefault

Ukázkový požadavek

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

{
  "searchString": "floor 100"
}

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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
  }
}

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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
  }
}

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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
  }
}

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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
  }
}

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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
  }
}

Ukázková odpověď

Stavový kód:
200 
{
  "instances": {
    "hits": [],
    "hitCount": 0,
    "continuationToken": null
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "Location",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": null
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesRecursive

Ukázkový požadavek

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
}

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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
  }
}

Ukázková odpověď

Stavový kód:
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
  }
}

Definice

Name Description
HierarchiesExpandKind

Druh rozšíření uzlů hierarchie. Pokud je nastavena na 'UntilChildren', uzly hierarchie jsou rozbaleny rekurzivně, dokud existuje více než jeden podřízený. Pokud je nastavena na "OneLevel", hierarchie jsou rozbalené pouze na jedné úrovni odpovídající parametr instance vyhledávání cest. Volitelné, výchozí hodnota je UntilChildren.
HierarchiesExpandParameter

Definice, zda rozbalit uzly hierarchie ve stejném volání instance vyhledávání.
HierarchiesSortBy

Hodnota, která se má použít pro řazení uzlů hierarchie. Pokud je nastavena na Hodnotu CumulativeInstanceCount, jsou vrácené hierarchie seřazeny na základě celkového počtu instancí patřících do uzlu hierarchie a jeho podřízených uzlů hierarchie. Když je nastavená na Název, vrácené hierarchie se seřadí na základě názvu hierarchie. Volitelné, výchozí hodnota je CumulativeInstanceCount.
HierarchiesSortParameter

Definice řazení uzlů hierarchie
HierarchyHit

Uzel hierarchie, který obsahuje instance odpovídající dotazu na základě vstupu. Může být prázdný nebo null.
Highlights

Zvýrazněný text instance časové řady, který se má zobrazit uživateli. Zvýraznění vložení a značky v částech textu, které odpovídaly hledanému řetězci K dalším voláním rozhraní API nepoužívejte žádnou ze zvýrazněných vlastností.
InstanceHit

Instance časové řady, která je vrácena voláním vyhledávání instancí. Vrácená instance odpovídala požadavku hledání a obsahuje zvýrazněný text, který se má uživateli zobrazit, pokud je nastaven na hodnotu true.
InstancesSortBy

Hodnota, která se má použít pro řazení instancí časové řady před vrácením voláním instancí vyhledávání. Pokud je nastavena na "Rank", vrácené instance jsou seřazeny podle relevance. Pokud je nastavená hodnota DisplayName, vrácené výsledky se seřadí podle zobrazovaného názvu. Zobrazovaný název je název instance, pokud existuje, jinak je zobrazovaný název ID časové řady. Výchozí hodnota je Rank (Pořadí).
InstancesSortParameter

Definice způsobu řazení instancí časové řady před vrácením pomocí volání instancí vyhledávání.
SearchHierarchyNodesResponse

Uzly hierarchie, které obsahují instance odpovídající dotazu na základě vstupu. Může být prázdný nebo null.
SearchInstancesHierarchiesParameters

Parametr pro vrácení hierarchií instancí časových řad voláním instancí vyhledávání.
SearchInstancesParameters

Parametry, jak vrátit instance časových řad voláním instancí vyhledávání.
SearchInstancesRequest

Požadavek na spuštění vyhledávacího dotazu na instance časové řady a vrácení odpovídajících instancí časové řady
SearchInstancesResponse

Instance odpovídající dotazu na základě vstupu. Může být prázdný nebo null.
SearchInstancesResponsePage

Jedna stránka výsledků hledání
TsiError

Informace o chybě rozhraní API
TsiErrorBody

Konkrétní chyba rozhraní API s kódem chyby a zprávou
TsiErrorDetails

Další informace o chybě

HierarchiesExpandKind

Druh rozšíření uzlů hierarchie. Pokud je nastavena na 'UntilChildren', uzly hierarchie jsou rozbaleny rekurzivně, dokud existuje více než jeden podřízený. Pokud je nastavena na "OneLevel", hierarchie jsou rozbalené pouze na jedné úrovni odpovídající parametr instance vyhledávání cest. Volitelné, výchozí hodnota je UntilChildren.

Name Typ Description
OneLevel

string

UntilChildren

string

HierarchiesExpandParameter

Definice, zda rozbalit uzly hierarchie ve stejném volání instance vyhledávání.

Name Typ Description
kind

HierarchiesExpandKind

Druh rozšíření uzlů hierarchie. Pokud je nastavena na 'UntilChildren', uzly hierarchie jsou rozbaleny rekurzivně, dokud existuje více než jeden podřízený. Pokud je nastavena na "OneLevel", hierarchie jsou rozbalené pouze na jedné úrovni odpovídající parametr instance vyhledávání cest. Volitelné, výchozí hodnota je UntilChildren.

HierarchiesSortBy

Hodnota, která se má použít pro řazení uzlů hierarchie. Pokud je nastavena na Hodnotu CumulativeInstanceCount, jsou vrácené hierarchie seřazeny na základě celkového počtu instancí patřících do uzlu hierarchie a jeho podřízených uzlů hierarchie. Když je nastavená na Název, vrácené hierarchie se seřadí na základě názvu hierarchie. Volitelné, výchozí hodnota je CumulativeInstanceCount.

Name Typ Description
CumulativeInstanceCount

string

Name

string

HierarchiesSortParameter

Definice řazení uzlů hierarchie

Name Typ Description
by

HierarchiesSortBy

Hodnota, která se má použít pro řazení uzlů hierarchie. Pokud je nastavena na Hodnotu CumulativeInstanceCount, vrácené hierarchie jsou seřazeny na základě celkového počtu instancí patřících do uzlu hierarchie a jeho podřízených uzlů hierarchie. Pokud je nastavena na "Název", vrácené hierarchie jsou seřazeny podle názvu hierarchie. Volitelné, výchozí hodnota je CumulativeInstanceCount.

HierarchyHit

Uzel hierarchie, který obsahuje instance odpovídající dotazu na základě vstupu. Může být prázdný nebo null.

Name Typ Description
cumulativeInstanceCount

integer

Celkový počet instancí, které patří k tomuto uzlu, a jeho podstromy, které odpovídají dotazu.
hierarchyNodes

SearchHierarchyNodesResponse

Podřízené uzly hierarchie tohoto uzlu. Může být prázdný nebo null.
name

string

Název uzlu hierarchie Může být prázdný, nesmí mít hodnotu null.

Highlights

Zvýrazněný text instance časové řady, který se má zobrazit uživateli. Zvýraznění vložení a značky v částech textu, které odpovídaly hledanému řetězci K dalším voláním rozhraní API nepoužívejte žádnou ze zvýrazněných vlastností.

Name Typ Description
description

string

Zvýrazněný popis instance časové řady Může mít hodnotu null.
hierarchyIds

string[]

Seznam zvýrazněných ID hierarchie časových řad, ke kterým instance časové řady patří. Nelze použít k vyhledávání hierarchií. Může mít hodnotu null.
hierarchyNames

string[]

Seznam zvýrazněných názvů hierarchií časových řad, ke kterým instance časové řady patří. Nelze použít k vyhledávání hierarchií. Může mít hodnotu null.
instanceFieldNames

string[]

Seznam zvýrazněných názvů polí instancí časových řad Může mít hodnotu null.
instanceFieldValues

string[]

Seznam zvýrazněných hodnot polí instancí časové řady Může mít hodnotu null.
name

string

Zvýrazněný název instance časové řady Může mít hodnotu null.
timeSeriesId

string[]

Seznam zvýrazněných řetězcových hodnot ID časové řady pro zobrazení Nelze použít k vyhledávání instance.
typeName

string

Zvýrazněný název typu časové řady, ke kterému tato instance patří.

InstanceHit

Instance časové řady, která je vrácena voláním vyhledávání instancí. Vrácená instance odpovídala požadavku hledání a obsahuje zvýrazněný text, který se má uživateli zobrazit, pokud je nastaven na hodnotu true.

Name Typ Description
hierarchyIds

string[]

Seznam ID hierarchie časových řad, do kterých patří instance časové řady odpovídající požadavku hledání Nelze použít k vyhledávání hierarchií. Může mít hodnotu null.
highlights

Highlights

Zvýrazněný text instance časové řady, který se má zobrazit uživateli. Zvýraznění vložení a značky v částech textu, které odpovídaly hledanému řetězci K dalším voláním rozhraní API nepoužívejte žádnou ze zvýrazněných vlastností.
name

string

Název instance časové řady, která odpovídala požadavku hledání. Může mít hodnotu null.
timeSeriesId

TimeSeriesId[]

ID časové řady instance časové řady, která odpovídala požadavku hledání.
typeId

string

Představuje typ instance časové řady, která odpovídá požadavku vyhledávání. Nikdy null.

InstancesSortBy

Hodnota, která se má použít pro řazení instancí časové řady před vrácením voláním instancí vyhledávání. Pokud je nastavena na "Rank", vrácené instance jsou seřazeny podle relevance. Pokud je nastavená hodnota DisplayName, vrácené výsledky se seřadí podle zobrazovaného názvu. Zobrazovaný název je název instance, pokud existuje, jinak je zobrazovaný název ID časové řady. Výchozí hodnota je Rank (Pořadí).

Name Typ Description
DisplayName

string

Rank

string

InstancesSortParameter

Definice způsobu řazení instancí časové řady před vrácením pomocí volání instancí vyhledávání.

Name Typ Description
by

InstancesSortBy

Hodnota, která se má použít pro řazení instancí časové řady před vrácením voláním instancí vyhledávání. Pokud je nastavena na "Rank", vrácené instance jsou seřazeny podle relevance. Pokud je nastavená hodnota DisplayName, vrácené výsledky se seřadí podle zobrazovaného názvu. Zobrazovaný název je název instance, pokud existuje, jinak je zobrazovaný název ID časové řady. Výchozí hodnota je Rank (Pořadí).

SearchHierarchyNodesResponse

Uzly hierarchie, které obsahují instance odpovídající dotazu na základě vstupu. Může být prázdný nebo null.

Name Typ Description
continuationToken

string

Pokud se vrátí, znamená to, že aktuální výsledky představují částečný výsledek. Pokračovací token umožňuje získat další stránku výsledků. Pokud chcete získat další stránku výsledků dotazu, odešlete stejný požadavek s parametrem tokenu pro pokračování v hlavičce http x-ms-continuation.
hitCount

integer

Celkový počet uzlů hierarchie, které obsahují instance odpovídající dotazu na základě vstupu.
hits

HierarchyHit[]

Seznam uzlů hierarchie, který obsahuje instance odpovídající dotazu na základě vstupu. Může být prázdný.

SearchInstancesHierarchiesParameters

Parametr pro vrácení hierarchií instancí časových řad voláním instancí vyhledávání.

Name Typ Description
expand

HierarchiesExpandParameter

Definice, zda rozbalit uzly hierarchie ve stejném volání instance vyhledávání. Volitelné, výchozí hodnota je UntilChildren.
pageSize

integer

Maximální počet hierarchií na stejné úrovni, které se mají vrátit na stejné stránce. Volitelné, výchozí hodnota je 10, pokud není nastavená. Rozsah je od 1 do 100. Pokud jsou výsledky nad rámec velikosti stránky, můžete k načtení další stránky použít pokračovací token.
sort

HierarchiesSortParameter

Definice řazení uzlů hierarchie Volitelné, výchozí hodnota je CumulativeInstanceCount.

SearchInstancesParameters

Parametry, jak vrátit instance časových řad voláním instancí vyhledávání.

Name Typ Description
highlights

boolean

Definice zvýrazněných výsledků hledání nebo ne. Pokud je nastavená na true, vrátí se zvýrazněné výsledky hledání. Pokud je nastavena na false, zvýrazněné výsledky hledání se nevrátí. Výchozí hodnota je true.
pageSize

integer

Maximální počet očekávaných instancí na každé stránce výsledku Výchozí hodnota je 10, pokud není nastavená. Rozsahy od 1 do 100. Pokud existují výsledky nad rámec velikosti stránky, může uživatel k načtení další stránky použít pokračovací token.
recursive

boolean

Definice, které instance jsou vráceny. Pokud je rekurzivní nastavena na hodnotu true, vrátí se všechny instance, které mají cestu začínající cestou parametru path. Pokud je rekurzivní nastavena na hodnotu false, vrátí se pouze instance, které mají cestu, která přesně odpovídá parametru path. Použití rekurzivního vyhledávání umožňuje implementovat uživatelské prostředí vyhledávání, zatímco použití nerekurzivního vyhledávání umožňuje implementovat navigační prostředí. Volitelné, výchozí hodnota je true.
sort

InstancesSortParameter

Definice způsobu řazení instancí časových řad před vrácením podle volání instancí vyhledávání – podle relevance nebo abecedy. Volitelné, výchozí hodnota je "Rank" (Pořadí).

SearchInstancesRequest

Požadavek na spuštění vyhledávacího dotazu na instance časové řady a vrácení odpovídajících instancí časové řady

Name Typ Description
hierarchies

SearchInstancesHierarchiesParameters

Parametry, jak vracet hierarchie instancí časových řad Pokud je hodnota null, hierarchie se nevrátí. Pokud parametr instances má hodnotu null a parametr hierarchie nemá hodnotu null, vrátí se pouze hierarchie bez instancí.
instances

SearchInstancesParameters

Parametry, jak vracet instance časových řad Může mít hodnotu null. Pokud mají parametry instance i hierarchie hodnotu null, instance se vrátí ve výsledcích na základě výchozích hodnot parametrů a hierarchie se nevrátí.
path

string[]

Vyfiltrujte hierarchii instancí časových řad. Cesta je reprezentována jako pole segmentů cesty řetězce. Prvním prvkem by měl být název hierarchie. Příklad: ["Location", "California"]. Volitelné, rozlišují se malá a velká písmena, nikdy prázdné a může mít hodnotu null.
searchString

string

Vyhledávací řetězec dotazu, který se bude shodovat s atributy instancí časové řady. Příklad: "podlaha 100". Nerozlišují se malá a velká písmena, musí existovat, ale může to být prázdný řetězec.

SearchInstancesResponse

Instance odpovídající dotazu na základě vstupu. Může být prázdný nebo null.

Name Typ Description
continuationToken

string

Pokud se vrátí, znamená to, že aktuální výsledky představují částečný výsledek. Pokračovací token umožňuje získat další stránku výsledků. Pokud chcete získat další stránku výsledků dotazu, odešlete stejný požadavek s parametrem tokenu pro pokračování v hlavičce http x-ms-continuation.
hitCount

integer

Celkový počet instancí odpovídajících dotazu na základě vstupu
hits

InstanceHit[]

Seznam instancí odpovídajících dotazu na základě vstupu. Může být prázdný.

SearchInstancesResponsePage

Jedna stránka výsledků hledání

Name Typ Description
hierarchyNodes

SearchHierarchyNodesResponse

Uzly hierarchie, které obsahují instance odpovídající dotazu na základě vstupu. Může být prázdný nebo null.
instances

SearchInstancesResponse

Instance odpovídající dotazu na základě vstupu. Může být prázdný nebo null.

TsiError

Informace o chybě rozhraní API

Name Typ Description
error

TsiErrorBody

Konkrétní chyba rozhraní API s kódem chyby a zprávou

TsiErrorBody

Konkrétní chyba rozhraní API s kódem chyby a zprávou

Name Typ Description
code

string

Jazykově nezávislý řetězec čitelný pro člověka, který definuje kód chyby specifické pro službu. Tento kód slouží jako konkrétnější indikátor pro kód chyby HTTP zadaný v odpovědi. Dá se použít ke zpracování konkrétních případů chyb prostřednictvím kódu programu.
details

TsiErrorDetails[]

Obsahuje další informace o chybách. Může mít hodnotu null.
innerError

TsiErrorBody

Obsahuje konkrétnější chybu, která zpřesní příčinu. Může mít hodnotu null.
message

string

Člověkem čitelná reprezentace chyby nezávislá na jazyce. Je určena jako pomoc vývojářům a není vhodná pro vystavení koncovým uživatelům.
target

string

Cíl konkrétní chyby (například název vlastnosti v chybě). Může mít hodnotu null.

TsiErrorDetails

Další informace o chybě

Name Typ Description
code

string

Jazykově nezávislý řetězec čitelný pro člověka, který definuje kód chyby specifické pro službu. Tento kód slouží jako konkrétnější indikátor pro kód chyby HTTP zadaný v odpovědi. Dá se použít k programovému zpracování konkrétních chybových případů.
message

string

Čitelné, jazykově nezávislé znázornění chyby. Je určen jako pomoc vývojářům a není vhodný pro vystavení koncovým uživatelům.