Udostępnij za pośrednictwem

Time Series Instances - Search

  • Odwołanie
Usługa:
Time Series Insights
Wersja interfejsu API:
2020-07-31

Częściowa lista trafień w wyszukiwaniu wystąpień szeregów czasowych na podstawie atrybutów wystąpienia.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
environmentFqdn
 path True

string

Na nazwę FQDN środowiska, na przykład 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Tę nazwę domeny można uzyskać z odpowiedzi interfejsu API pobierania środowisk, Azure Portal lub usługi Azure Resource Manager.
api-version
 query True

string

Wersja interfejsu API do użycia z żądaniem klienta. Obecnie obsługiwana wersja to "2020-07-31".

Nagłówek żądania

Nazwa Wymagane Typ Opis
x-ms-continuation

string

Token kontynuacji z poprzedniej strony wyników, aby pobrać następną stronę wyników w wywołaniach obsługujących stronicowanie. Aby uzyskać wyniki pierwszej strony, określ token kontynuacji o wartości null jako wartość parametru. Zwrócony token kontynuacji ma wartość null, jeśli wszystkie wyniki zostały zwrócone i nie ma następnej strony wyników.
x-ms-client-request-id

string

Opcjonalny identyfikator żądania klienta. Usługa rejestruje tę wartość. Umożliwia usłudze śledzenie operacji między usługami i umożliwia klientowi skontaktowanie się z pomocą techniczną dotyczącą konkretnego żądania.
x-ms-client-session-id

string

Opcjonalny identyfikator sesji klienta. Usługa rejestruje tę wartość. Umożliwia usłudze śledzenie grupy powiązanych operacji między usługami i umożliwia klientowi kontaktowanie się z pomocą techniczną dotyczącą określonej grupy żądań.

Treść żądania

Nazwa Wymagane Typ Opis
searchString True

string

Ciąg wyszukiwania zapytań, który będzie zgodny z atrybutami wystąpień szeregów czasowych. Przykład: "floor 100". Bez uwzględniania wielkości liter musi być obecny, ale może być pusty ciąg.
hierarchies

SearchInstancesHierarchiesParameters

Parametry sposobu zwracania hierarchii wystąpień szeregów czasowych. Jeśli ma wartość null, hierarchie nie są zwracane. Jeśli parametr instances ma wartość null, a parametr hierarchii nie ma wartości null, zwracane są tylko hierarchie bez wystąpień.
instances

SearchInstancesParameters

Parametry sposobu zwracania wystąpień szeregów czasowych. Może mieć wartość null. Gdy zarówno wystąpienia, jak i parametry hierarchii mają wartość null, wystąpienia są zwracane w wynikach na podstawie domyślnych wartości parametrów, a hierarchie nie są zwracane.
path

string[]

Filtruj według ścieżki hierarchii wystąpień szeregów czasowych. Ścieżka jest reprezentowana jako tablica segmentów ścieżki ciągu. Pierwszym elementem powinna być nazwa hierarchii. Przykład: ["Location", "California"]. Opcjonalnie, rozróżniana wielkość liter nigdy nie jest pusta i może mieć wartość null.

Odpowiedzi

Nazwa Typ Opis
200 OK

SearchInstancesResponsePage

Pomyślna odpowiedź wyszukiwania.

Nagłówki

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

TsiError

Nieoczekiwany błąd.

Nagłówki

x-ms-request-id: string

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

SearchInstancesDefault
SearchInstancesExpandHierarchiesOnly
SearchInstancesHierarchiesDefaultInputPage1
SearchInstancesHierarchiesDefaultInputPage2
SearchInstancesHierarchiesDefaultInputPage3
SearchInstancesOneLevel
SearchInstancesRecursive
SearchInstancesUntilChildren

SearchInstancesDefault

Przykładowe żądanie

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

{
  "searchString": "floor 100"
}

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

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

SearchInstancesRecursive

Przykładowe żądanie

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
}

Przykładowa odpowiedź

Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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
  }
}

Definicje

Nazwa Opis
HierarchiesExpandKind

Rodzaj rozszerzenia węzłów hierarchii. Gdy jest ustawiona na wartość "UntilChildren", węzły hierarchii są powtarzane rekursywnie, dopóki nie będzie więcej niż jednego elementu podrzędnego. Gdy jest ustawiona na wartość "OneLevel", hierarchie są rozwijane tylko na jednym poziomie pasującego parametru wystąpień wyszukiwania ścieżki. Opcjonalnie wartość domyślna to "UntilChildren".
HierarchiesExpandParameter

Definicja tego, czy węzły hierarchii mają być rozwijane w tym samym wywołaniu wystąpień wyszukiwania.
HierarchiesSortBy

Wartość do użycia do sortowania węzłów hierarchii. Po ustawieniu wartości "CumulativeInstanceCount" zwracane hierarchie są sortowane na podstawie łącznych wystąpień należących do węzła hierarchii i węzłów hierarchii podrzędnej. Po ustawieniu wartości "Nazwa" zwracane hierarchie są sortowane na podstawie nazwy hierarchii. Opcjonalnie wartość domyślna to "CumulativeInstanceCount".
HierarchiesSortParameter

Definicja sortowania węzłów hierarchii.
HierarchyHit

Węzeł hierarchii zawierający wystąpienia pasujące do zapytania na podstawie danych wejściowych. Może być pusty lub null.
Highlights

Wyróżniony tekst wystąpienia szeregów czasowych, który ma być wyświetlany użytkownikowi. Wyróżnianie wstawień i tagów w fragmentach tekstu pasujących do ciągu wyszukiwania. Nie używaj żadnych wyróżnionych właściwości do wykonywania dalszych wywołań interfejsu API.
InstanceHit

Wystąpienie szeregów czasowych zwracane przez wywołanie wyszukiwania wystąpień. Zwrócone wystąpienie pasuje do żądania wyszukiwania i zawiera wyróżniony tekst, który ma być wyświetlany użytkownikowi, jeśli jest ustawiony na wartość "true".
InstancesSortBy

Wartość do użycia do sortowania wystąpień szeregów czasowych przed zwróceniem przez wywołanie wystąpień wyszukiwania. Po ustawieniu wartości "Rank" zwracane wystąpienia są sortowane na podstawie istotności. Po ustawieniu wartości "DisplayName" zwracane wyniki są sortowane na podstawie nazwy wyświetlanej. Nazwa wyświetlana to nazwa wystąpienia, jeśli istnieje, w przeciwnym razie nazwa wyświetlana jest identyfikatorem szeregów czasowych. Wartość domyślna to "Rank".
InstancesSortParameter

Definicja sposobu sortowania wystąpień szeregów czasowych przed zwróceniem przez wywołanie wystąpień wyszukiwania.
SearchHierarchyNodesResponse

Węzły hierarchii zawierające wystąpienia pasujące do zapytania na podstawie danych wejściowych. Może być pusty lub ma wartość null.
SearchInstancesHierarchiesParameters

Parametr sposobu zwracania hierarchii wystąpień szeregów czasowych przez wywołanie wystąpień wyszukiwania.
SearchInstancesParameters

Parametry sposobu zwracania wystąpień szeregów czasowych przez wywołanie wystąpień wyszukiwania.
SearchInstancesRequest

Żądanie wykonania zapytania wyszukiwania względem wystąpień szeregów czasowych i zwrócenia pasujących wystąpień szeregów czasowych.
SearchInstancesResponse

Wystąpienia pasujące do zapytania na podstawie danych wejściowych. Może być pusty lub ma wartość null.
SearchInstancesResponsePage

Pojedyncza strona wyników wyszukiwania.
TsiError

Informacje o błędzie interfejsu API.
TsiErrorBody

Określony błąd interfejsu API z kodem błędu i komunikatem.
TsiErrorDetails

Dodatkowe informacje o błędzie.

HierarchiesExpandKind

Enumeration

Rodzaj rozszerzenia węzłów hierarchii. Gdy jest ustawiona na wartość "UntilChildren", węzły hierarchii są powtarzane rekursywnie, dopóki nie będzie więcej niż jednego elementu podrzędnego. Gdy jest ustawiona na wartość "OneLevel", hierarchie są rozwijane tylko na jednym poziomie pasującego parametru wystąpień wyszukiwania ścieżki. Opcjonalnie wartość domyślna to "UntilChildren".

Wartość Opis
OneLevel
UntilChildren

HierarchiesExpandParameter

Object

Definicja tego, czy węzły hierarchii mają być rozwijane w tym samym wywołaniu wystąpień wyszukiwania.

Nazwa Typ Opis
kind

HierarchiesExpandKind

Rodzaj rozszerzenia węzłów hierarchii. Gdy jest ustawiona na wartość "UntilChildren", węzły hierarchii są powtarzane rekursywnie, dopóki nie będzie więcej niż jednego elementu podrzędnego. Gdy jest ustawiona na wartość "OneLevel", hierarchie są rozwijane tylko na jednym poziomie pasującego parametru wystąpień wyszukiwania ścieżki. Opcjonalnie wartość domyślna to "UntilChildren".

HierarchiesSortBy

Enumeration

Wartość do użycia do sortowania węzłów hierarchii. Po ustawieniu wartości "CumulativeInstanceCount" zwracane hierarchie są sortowane na podstawie łącznych wystąpień należących do węzła hierarchii i węzłów hierarchii podrzędnej. Po ustawieniu wartości "Nazwa" zwracane hierarchie są sortowane na podstawie nazwy hierarchii. Opcjonalnie wartość domyślna to "CumulativeInstanceCount".

Wartość Opis
CumulativeInstanceCount
Name

HierarchiesSortParameter

Object

Definicja sortowania węzłów hierarchii.

Nazwa Typ Opis
by

HierarchiesSortBy

Wartość do użycia do sortowania węzłów hierarchii. Gdy jest ustawiona na wartość "CumulativeInstanceCount", zwracane hierarchie są sortowane na podstawie łącznej liczby wystąpień należących do węzła hierarchii hierarchii i węzłów hierarchii podrzędnej. Gdy jest ustawiona na wartość "Nazwa", zwracane hierarchie są sortowane na podstawie nazwy hierarchii. Opcjonalnie wartość domyślna to "CumulativeInstanceCount".

HierarchyHit

Object

Węzeł hierarchii zawierający wystąpienia pasujące do zapytania na podstawie danych wejściowych. Może być pusty lub null.

Nazwa Typ Opis
cumulativeInstanceCount

integer

Łączna liczba wystąpień należących do tego węzła i poddrzew zgodnych z zapytaniem.
hierarchyNodes

SearchHierarchyNodesResponse

Podrzędne węzły hierarchii tego węzła. Może być pusty lub null.
name

string

Nazwa węzła hierarchii. Może być pusty, nie może mieć wartości null.

Highlights

Object

Wyróżniony tekst wystąpienia szeregów czasowych, który ma być wyświetlany użytkownikowi. Wyróżnianie wstawień i tagów w fragmentach tekstu pasujących do ciągu wyszukiwania. Nie używaj żadnych wyróżnionych właściwości do wykonywania dalszych wywołań interfejsu API.

Nazwa Typ Opis
description

string

Wyróżniony opis wystąpienia szeregów czasowych. Może mieć wartość null.
hierarchyIds

string[]

Lista wyróżnionych identyfikatorów hierarchii szeregów czasowych, do których należy wystąpienie szeregów czasowych. Nie można używać do hierarchii odnośników. Może mieć wartość null.
hierarchyNames

string[]

Lista wyróżnionych nazw hierarchii szeregów czasowych, do których należy wystąpienie szeregów czasowych. Nie można używać do hierarchii odnośników. Może mieć wartość null.
instanceFieldNames

string[]

Lista wyróżnionych nazw pól wystąpień szeregów czasowych. Może mieć wartość null.
instanceFieldValues

string[]

Lista wyróżnionych wartości pól wystąpienia szeregów czasowych. Może mieć wartość null.
name

string

Wyróżniona nazwa wystąpienia szeregów czasowych. Może mieć wartość null.
timeSeriesId

string[]

Lista wyróżnionych wartości ciągów identyfikatora szeregów czasowych do wyświetlenia. Nie można użyć do wyszukiwania wystąpienia.
typeName

string

Wyróżniona nazwa typu szeregów czasowych, do którego należy to wystąpienie.

InstanceHit

Object

Wystąpienie szeregów czasowych zwracane przez wywołanie wyszukiwania wystąpień. Zwrócone wystąpienie pasuje do żądania wyszukiwania i zawiera wyróżniony tekst, który ma być wyświetlany użytkownikowi, jeśli jest ustawiony na wartość "true".

Nazwa Typ Opis
hierarchyIds

string[]

Lista identyfikatorów hierarchii szeregów czasowych, do których należy wystąpienie szeregów czasowych pasujących do żądania wyszukiwania. Nie można używać do hierarchii odnośników. Może mieć wartość null.
highlights

Highlights

Wyróżniony tekst wystąpienia szeregów czasowych, który ma być wyświetlany użytkownikowi. Wyróżnianie wstawień i tagów w fragmentach tekstu pasujących do ciągu wyszukiwania. Nie używaj żadnych wyróżnionych właściwości do wykonywania dalszych wywołań interfejsu API.
name

string

Nazwa wystąpienia szeregów czasowych pasujących do żądania wyszukiwania. Może mieć wartość null.
timeSeriesId

TimeSeriesId[]

Identyfikator szeregów czasowych wystąpienia szeregów czasowych pasujących do żądania wyszukiwania.
typeId

string

Reprezentuje typ wystąpienia szeregów czasowych pasujących do żądania wyszukiwania. Nigdy nie ma wartości null.

InstancesSortBy

Enumeration

Wartość do użycia do sortowania wystąpień szeregów czasowych przed zwróceniem przez wywołanie wystąpień wyszukiwania. Po ustawieniu wartości "Rank" zwracane wystąpienia są sortowane na podstawie istotności. Po ustawieniu wartości "DisplayName" zwracane wyniki są sortowane na podstawie nazwy wyświetlanej. Nazwa wyświetlana to nazwa wystąpienia, jeśli istnieje, w przeciwnym razie nazwa wyświetlana jest identyfikatorem szeregów czasowych. Wartość domyślna to "Rank".

Wartość Opis
DisplayName
Rank

InstancesSortParameter

Object

Definicja sposobu sortowania wystąpień szeregów czasowych przed zwróceniem przez wywołanie wystąpień wyszukiwania.

Nazwa Typ Opis
by

InstancesSortBy

Wartość do użycia do sortowania wystąpień szeregów czasowych przed zwróceniem przez wywołanie wystąpień wyszukiwania. Po ustawieniu wartości "Rank" zwracane wystąpienia są sortowane na podstawie istotności. Po ustawieniu wartości "DisplayName" zwracane wyniki są sortowane na podstawie nazwy wyświetlanej. Nazwa wyświetlana to nazwa wystąpienia, jeśli istnieje, w przeciwnym razie nazwa wyświetlana jest identyfikatorem szeregów czasowych. Wartość domyślna to "Rank".

SearchHierarchyNodesResponse

Object

Węzły hierarchii zawierające wystąpienia pasujące do zapytania na podstawie danych wejściowych. Może być pusty lub ma wartość null.

Nazwa Typ Opis
continuationToken

string

Jeśli zostanie zwrócona, oznacza to, że bieżące wyniki reprezentują częściowy wynik. Token kontynuacji umożliwia uzyskanie następnej strony wyników. Aby uzyskać następną stronę wyników zapytania, wyślij to samo żądanie z parametrem tokenu kontynuacji w nagłówku HTTP "x-ms-continuation".
hitCount

integer

Łączna liczba węzłów hierarchii, które zawierają wystąpienia pasujące do zapytania na podstawie danych wejściowych.
hits

HierarchyHit[]

Lista węzłów hierarchii zawierająca wystąpienia pasujące do zapytania na podstawie danych wejściowych. Może być pusty.

SearchInstancesHierarchiesParameters

Object

Parametr sposobu zwracania hierarchii wystąpień szeregów czasowych przez wywołanie wystąpień wyszukiwania.

Nazwa Typ Opis
expand

HierarchiesExpandParameter

Definicja tego, czy węzły hierarchii mają być rozwijane w tym samym wywołaniu wystąpień wyszukiwania. Opcjonalnie wartość domyślna to "UntilChildren".
pageSize

integer

Maksymalna liczba hierarchii na tym samym poziomie, które mają być zwracane na tej samej stronie. Opcjonalnie wartość domyślna to 10, jeśli nie jest ustawiona. Zakres wynosi od 1 do 100. Jeśli istnieją wyniki wykraczające poza rozmiar strony, token kontynuacji może służyć do pobierania następnej strony.
sort

HierarchiesSortParameter

Definicja sortowania węzłów hierarchii. Opcjonalnie wartość domyślna to "CumulativeInstanceCount".

SearchInstancesParameters

Object

Parametry sposobu zwracania wystąpień szeregów czasowych przez wywołanie wystąpień wyszukiwania.

Nazwa Typ Opis
highlights

boolean

Definicja wyróżnionych wyników wyszukiwania lub nie. Po ustawieniu wartości "true" zostaną zwrócone wyróżnione wyniki wyszukiwania. Po ustawieniu wartości "false" wyróżnione wyniki wyszukiwania nie są zwracane. Wartość domyślna to "true".
pageSize

integer

Maksymalna liczba wystąpień oczekiwanych na każdej stronie wyniku. Wartość domyślna to 10, jeśli nie jest ustawiona. Zakresy od 1 do 100. Jeśli istnieją wyniki wykraczające poza rozmiar strony, użytkownik może użyć tokenu kontynuacji, aby pobrać następną stronę.
recursive

boolean

Definicja zwracanych wystąpień. Gdy rekursywna jest ustawiona na wartość "true", zwracane są wszystkie wystąpienia, które mają ścieżkę rozpoczynającą się od ścieżki parametr ścieżki. Gdy rekursywna jest ustawiona na wartość "false", zwracane są tylko wystąpienia, które mają ścieżkę, która dokładnie odpowiada parametrowi ścieżki. Korzystanie z wyszukiwania cyklicznego umożliwia zaimplementowanie środowiska użytkownika wyszukiwania, podczas gdy korzystanie z wyszukiwania niecyklicznego umożliwia zaimplementowanie środowiska nawigacji. Opcjonalnie wartość domyślna to "true".
sort

InstancesSortParameter

Definicja sposobu sortowania wystąpień szeregów czasowych przed zwróceniem przez wywołanie wystąpień wyszukiwania — istotność lub alfabetyczne. Opcjonalnie wartość domyślna to "Ranga".

SearchInstancesRequest

Object

Żądanie wykonania zapytania wyszukiwania względem wystąpień szeregów czasowych i zwrócenia pasujących wystąpień szeregów czasowych.

Nazwa Typ Opis
hierarchies

SearchInstancesHierarchiesParameters

Parametry sposobu zwracania hierarchii wystąpień szeregów czasowych. W przypadku wartości null hierarchie nie są zwracane. Jeśli parametr instances ma wartość null, a parametr hierarchii nie ma wartości null, zwracane są tylko hierarchie bez wystąpień.
instances

SearchInstancesParameters

Parametry sposobu zwracania wystąpień szeregów czasowych. Może mieć wartość null. Gdy parametry wystąpień i hierarchii mają wartość null, wystąpienia są zwracane w wynikach na podstawie wartości domyślnych parametrów, a hierarchie nie są zwracane.
path

string[]

Filtruj według ścieżki hierarchii wystąpień szeregów czasowych. Ścieżka jest reprezentowana jako tablica segmentów ścieżki ciągu. Pierwszym elementem powinna być nazwa hierarchii. Przykład: ["Location", "California"]. Opcjonalnie, z uwzględnieniem wielkości liter, nigdy nie jest pusta i może mieć wartość null.
searchString

string

Ciąg wyszukiwania zapytania, który zostanie dopasowany do atrybutów wystąpień szeregów czasowych. Przykład: "floor 100". Bez uwzględniania wielkości liter musi być obecny, ale może być pusty ciąg.

SearchInstancesResponse

Object

Wystąpienia pasujące do zapytania na podstawie danych wejściowych. Może być pusty lub ma wartość null.

Nazwa Typ Opis
continuationToken

string

Jeśli zostanie zwrócona, oznacza to, że bieżące wyniki reprezentują częściowy wynik. Token kontynuacji umożliwia uzyskanie następnej strony wyników. Aby uzyskać następną stronę wyników zapytania, wyślij to samo żądanie z parametrem tokenu kontynuacji w nagłówku HTTP "x-ms-continuation".
hitCount

integer

Łączna liczba wystąpień pasujących do zapytania na podstawie danych wejściowych.
hits

InstanceHit[]

Lista wystąpień pasujących do zapytania na podstawie danych wejściowych. Może być pusty.

SearchInstancesResponsePage

Object

Pojedyncza strona wyników wyszukiwania.

Nazwa Typ Opis
hierarchyNodes

SearchHierarchyNodesResponse

Węzły hierarchii zawierające wystąpienia pasujące do zapytania na podstawie danych wejściowych. Może być pusty lub ma wartość null.
instances

SearchInstancesResponse

Wystąpienia pasujące do zapytania na podstawie danych wejściowych. Może być pusty lub ma wartość null.

TsiError

Object

Informacje o błędzie interfejsu API.

Nazwa Typ Opis
error

TsiErrorBody

Określony błąd interfejsu API z kodem błędu i komunikatem.

TsiErrorBody

Object

Określony błąd interfejsu API z kodem błędu i komunikatem.

Nazwa Typ Opis
code

string

Ciąg czytelny dla języka, który definiuje kod błędu specyficzny dla usługi. Ten kod służy jako bardziej szczegółowy wskaźnik dla kodu błędu HTTP określonego w odpowiedzi. Może służyć do programowego obsługi określonych przypadków błędów.
details

TsiErrorDetails[]

Zawiera dodatkowe informacje o błędzie. Może mieć wartość null.
innerError

TsiErrorBody

Zawiera bardziej szczegółowy błąd, który zawęża przyczynę. Może mieć wartość null.
message

string

Czytelna dla człowieka, niezależna od języka reprezentacja błędu. Jest ona przeznaczona jako pomoc dla deweloperów i nie jest odpowiednia dla użytkowników końcowych.
target

string

Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie). Może mieć wartość null.

TsiErrorDetails

Object

Dodatkowe informacje o błędzie.

Nazwa Typ Opis
code

string

Niezależny od języka ciąg czytelny dla człowieka, który definiuje kod błędu specyficzny dla usługi. Ten kod służy jako bardziej szczegółowy wskaźnik kodu błędu HTTP określonego w odpowiedzi. Może służyć do programowego obsługi określonych przypadków błędów.
message

string

Czytelna dla człowieka, niezależna od języka reprezentacja błędu. Jest ona przeznaczona jako pomoc dla deweloperów i nie nadaje się do ujawnienia użytkownikom końcowym.