Freigeben über

Time Series Instances - Search

  • Referenz
Dienst:
Time Series Insights
API-Version:
2020-07-31

Partielle Liste der Treffer bei der Suche nach Zeitreiheninstanzen basierend auf instance Attributen.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
environmentFqdn
 path True

string

FQDN pro Umgebung, z. B. 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Sie können diesen Domänennamen aus der Antwort der Get Environments-API, Azure-Portal oder Azure Resource Manager abrufen.
api-version
 query True

string

Version der API, die mit der Clientanforderung verwendet werden soll. Derzeit wird die Version "2020-07-31" unterstützt.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-continuation

string

Fortsetzungstoken von der vorherigen Seite der Ergebnisse, um die nächste Seite der Ergebnisse in Aufrufen abzurufen, die Paginierung unterstützen. Um die Ergebnisse der ersten Seite zu erhalten, geben Sie das NULL-Fortsetzungstoken als Parameterwert an. Das zurückgegebene Fortsetzungstoken ist NULL, wenn alle Ergebnisse zurückgegeben wurden und keine nächste Seite mit Ergebnissen vorhanden ist.
x-ms-client-request-id

string

Optionale Clientanforderungs-ID. Der Dienst zeichnet diesen Wert auf. Ermöglicht dem Dienst die dienstübergreifende Ablaufverfolgung des Vorgangs und ermöglicht es dem Kunden, sich bezüglich einer bestimmten Anforderung an den Support zu wenden.
x-ms-client-session-id

string

Optionale Clientsitzungs-ID. Der Dienst zeichnet diesen Wert auf. Ermöglicht dem Dienst das Nachverfolgen einer Gruppe verwandter Vorgänge über Dienste hinweg und ermöglicht es dem Kunden, den Support bezüglich einer bestimmten Gruppe von Anforderungen zu kontaktieren.

Anforderungstext

Name Erforderlich Typ Beschreibung
searchString True

string

Abfragesuchzeichenfolge, die mit den Attributen von Zeitreiheninstanzen abgeglichen wird. Beispiel: "floor 100". Die Groß-/Kleinschreibung muss nicht beachtet werden, kann jedoch eine leere Zeichenfolge sein.
hierarchies

SearchInstancesHierarchiesParameters

Parameter für die Rückgabe von Zeitreihen instance Hierarchien. Bei NULL werden keine Hierarchien zurückgegeben. Wenn der Instances-Parameter NULL und der hierarchies-Parameter nicht NULL ist, werden nur Hierarchien ohne Instanzen zurückgegeben.
instances

SearchInstancesParameters

Parameter für die Rückgabe von Zeitreiheninstanzen. Kann NULL sein. Wenn sowohl der Instanz- als auch der Hierarchieparameter NULL sind, werden die Instanzen in den Ergebnissen basierend auf den Standardwerten von Parametern zurückgegeben, und Hierarchien werden nicht zurückgegeben.
path

string[]

Filtern sie nach dem Hierarchiepfad von Zeitreiheninstanzen. Pfad wird als Array von Zeichenfolgenpfadsegmenten dargestellt. Das erste Element sollte der Hierarchiename sein. Beispiel: ["Location", "California"]. Optional, Groß-/Kleinschreibung, nie leer und kann NULL sein.

Antworten

Name Typ Beschreibung
200 OK

SearchInstancesResponsePage

Erfolgreiche Suchantwort.

Header

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

TsiError

Unerwarteter Fehler.

Header

x-ms-request-id: string

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

SearchInstancesDefault
SearchInstancesExpandHierarchiesOnly
SearchInstancesHierarchiesDefaultInputPage1
SearchInstancesHierarchiesDefaultInputPage2
SearchInstancesHierarchiesDefaultInputPage3
SearchInstancesOneLevel
SearchInstancesRecursive
SearchInstancesUntilChildren

SearchInstancesDefault

Beispielanforderung

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

{
  "searchString": "floor 100"
}

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

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

SearchInstancesRecursive

Beispielanforderung

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
}

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
HierarchiesExpandKind

Art der Erweiterung von Hierarchieknoten. Wenn sie auf "UntilChildren" festgelegt ist, werden die Hierarchieknoten rekursiv erweitert, bis mehr als ein untergeordnetes Element vorhanden ist. Wenn sie auf "OneLevel" festgelegt ist, werden die Hierarchien nur auf dem Suchinstanzenparameter der einzelnen Ebene erweitert. Optional, der Standardwert ist "UntilChildren".
HierarchiesExpandParameter

Definition, ob Hierarchieknoten in demselben Suchinstanzaufruf erweitert werden sollen.
HierarchiesSortBy

Wert, der für die Sortierung von Hierarchieknoten verwendet werden soll. Wenn sie auf "CumulativeInstanceCount" festgelegt ist, werden die zurückgegebenen Hierarchien basierend auf der Gesamtanzahl der Instanzen sortiert, die zum Hierarchieknoten und den untergeordneten Hierarchieknoten gehören. Wenn sie auf "Name" festgelegt ist, werden die zurückgegebenen Hierarchien basierend auf dem Hierarchienamen sortiert. Optional, der Standardwert ist "CumulativeInstanceCount".
HierarchiesSortParameter

Definition der Sortierung von Hierarchieknoten.
HierarchyHit

Der Hierarchieknoten, der die Instanzen enthält, die der Abfrage basierend auf der Eingabe entsprechen. Kann leer oder NULL sein.
Highlights

Hervorgehobener Text der Zeitreihen instance, der dem Benutzer angezeigt werden soll. Hervorheben von Einfügungen und Tags in den Textabschnitten, die mit der Suchzeichenfolge übereinstimmen. Verwenden Sie keine der hervorgehobenen Eigenschaften, um weitere API-Aufrufe auszuführen.
InstanceHit

Zeitreihen instance, die vom Suchaufruf der Instanzen zurückgegeben wird. Zurückgegebene instance der Suchanforderung entspricht und hervorgehobenen Text enthält, der dem Benutzer angezeigt werden soll, wenn er auf "true" festgelegt ist.
InstancesSortBy

Wert, der für die Sortierung der Zeitreiheninstanzen verwendet werden soll, bevor vom Aufruf von Suchinstanzen zurückgegeben wird. Wenn sie auf "Rang" festgelegt ist, werden die zurückgegebenen Instanzen basierend auf der Relevanz sortiert. Wenn sie auf "DisplayName" festgelegt ist, werden die zurückgegebenen Ergebnisse basierend auf dem Anzeigenamen sortiert. Anzeigename ist der Name der instance, sofern vorhanden, andernfalls ist der Anzeigename die Zeitreihen-ID. Der Standardwert ist "Rang".
InstancesSortParameter

Definition, wie Zeitreiheninstanzen sortiert werden, bevor sie von Suchinstanzen aufgerufen werden.
SearchHierarchyNodesResponse

Die Hierarchieknoten, die die Instanzen enthalten, die der Abfrage basierend auf der Eingabe entsprechen. Kann leer oder NULL sein.
SearchInstancesHierarchiesParameters

Parameter zum Zurückgeben von Zeitreihen instance Hierarchien nach Aufruf von Suchinstanzen.
SearchInstancesParameters

Parameter für die Rückgabe von Zeitreiheninstanzen durch Aufruf von Suchinstanzen.
SearchInstancesRequest

Anforderung, eine Suchabfrage für Zeitreiheninstanzen auszuführen und übereinstimmende Zeitreiheninstanzen zurückzugeben.
SearchInstancesResponse

Die Instanzen, die der Abfrage basierend auf der Eingabe entsprechen. Kann leer oder NULL sein.
SearchInstancesResponsePage

Einzelne Seite der Suchergebnisse.
TsiError

Informationen zu einem API-Fehler.
TsiErrorBody

Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.
TsiErrorDetails

Zusätzliche Fehlerinformationen.

HierarchiesExpandKind

Art der Erweiterung von Hierarchieknoten. Wenn sie auf "UntilChildren" festgelegt ist, werden die Hierarchieknoten rekursiv erweitert, bis mehr als ein untergeordnetes Element vorhanden ist. Wenn sie auf "OneLevel" festgelegt ist, werden die Hierarchien nur auf dem Suchinstanzenparameter der einzelnen Ebene erweitert. Optional, der Standardwert ist "UntilChildren".

Name Typ Beschreibung
OneLevel

string

UntilChildren

string

HierarchiesExpandParameter

Definition, ob Hierarchieknoten in demselben Suchinstanzaufruf erweitert werden sollen.

Name Typ Beschreibung
kind

HierarchiesExpandKind

Art der Erweiterung von Hierarchieknoten. Wenn sie auf "UntilChildren" festgelegt ist, werden die Hierarchieknoten rekursiv erweitert, bis mehr als ein untergeordnetes Element vorhanden ist. Wenn sie auf "OneLevel" festgelegt ist, werden die Hierarchien nur auf dem Suchinstanzenparameter der einzelnen Ebene erweitert. Optional, der Standardwert ist "UntilChildren".

HierarchiesSortBy

Wert, der für die Sortierung von Hierarchieknoten verwendet werden soll. Wenn sie auf "CumulativeInstanceCount" festgelegt ist, werden die zurückgegebenen Hierarchien basierend auf der Gesamtanzahl der Instanzen sortiert, die zum Hierarchieknoten und den untergeordneten Hierarchieknoten gehören. Wenn sie auf "Name" festgelegt ist, werden die zurückgegebenen Hierarchien basierend auf dem Hierarchienamen sortiert. Optional, der Standardwert ist "CumulativeInstanceCount".

Name Typ Beschreibung
CumulativeInstanceCount

string

Name

string

HierarchiesSortParameter

Definition der Sortierung von Hierarchieknoten.

Name Typ Beschreibung
by

HierarchiesSortBy

Wert, der für die Sortierung von Hierarchieknoten verwendet werden soll. Wenn sie auf "CumulativeInstanceCount" festgelegt ist, werden die zurückgegebenen Hierarchien basierend auf der Gesamtanzahl der Instanzen sortiert, die zum Hierarchieknoten und den untergeordneten Hierarchieknoten gehören. Wenn sie auf "Name" festgelegt ist, werden die zurückgegebenen Hierarchien basierend auf dem Hierarchienamen sortiert. Optional, der Standardwert ist "CumulativeInstanceCount".

HierarchyHit

Der Hierarchieknoten, der die Instanzen enthält, die der Abfrage basierend auf der Eingabe entsprechen. Kann leer oder NULL sein.

Name Typ Beschreibung
cumulativeInstanceCount

integer

Gesamtanzahl der Instanzen, die zu diesem Knoten gehören, und dessen Teilstrukturen, die der Abfrage entsprechen.
hierarchyNodes

SearchHierarchyNodesResponse

Untergeordnete Hierarchieknoten dieses Knotens. Kann leer oder NULL sein.
name

string

Name des Hierarchieknotens. Kann leer sein, darf nicht NULL sein.

Highlights

Hervorgehobener Text der Zeitreihen instance, der dem Benutzer angezeigt werden soll. Hervorheben von Einfügungen und Tags in den Textabschnitten, die mit der Suchzeichenfolge übereinstimmen. Verwenden Sie keine der hervorgehobenen Eigenschaften, um weitere API-Aufrufe auszuführen.

Name Typ Beschreibung
description

string

Hervorgehobene Beschreibung der zeitreihen-instance. Ist möglicherweise NULL.
hierarchyIds

string[]

Liste der hervorgehobenen Zeitreihenhierarchie-IDs, zu denen zeitreihen instance gehören. Kann nicht zum Suchen von Hierarchien verwendet werden. Ist möglicherweise NULL.
hierarchyNames

string[]

Liste der hervorgehobenen Zeitreihenhierarchienamen, zu denen zeitreihen instance gehört. Kann nicht zum Suchen von Hierarchien verwendet werden. Ist möglicherweise NULL.
instanceFieldNames

string[]

Liste der hervorgehobenen Zeitreihen instance Feldnamen. Ist möglicherweise NULL.
instanceFieldValues

string[]

Liste der hervorgehobenen Zeitreihen instance Feldwerte. Ist möglicherweise NULL.
name

string

Hervorgehobener Name der zeitreihen-instance. Ist möglicherweise NULL.
timeSeriesId

string[]

Liste der hervorgehobenen Zeichenfolgenwerte der Time Series-ID für die Anzeige. Kann nicht verwendet werden, um instance zu suchen.
typeName

string

Hervorgehobener Name des Zeitreihentyps, zu dem dieser instance gehört.

InstanceHit

Zeitreihen instance, die vom Suchaufruf der Instanzen zurückgegeben wird. Zurückgegebene instance der Suchanforderung entspricht und hervorgehobenen Text enthält, der dem Benutzer angezeigt werden soll, wenn er auf "true" festgelegt ist.

Name Typ Beschreibung
hierarchyIds

string[]

Liste der Zeitreihenhierarchie-IDs, zu denen zeitreihen instance, die der Suchanforderung entsprechen. Kann nicht zum Suchen von Hierarchien verwendet werden. Ist möglicherweise NULL.
highlights

Highlights

Hervorgehobener Text der Zeitreihen instance, der dem Benutzer angezeigt werden soll. Hervorheben von Einfügungen und Tags in den Textabschnitten, die mit der Suchzeichenfolge übereinstimmen. Verwenden Sie keine der hervorgehobenen Eigenschaften, um weitere API-Aufrufe auszuführen.
name

string

Name der Zeitreihe instance, die der Suchanforderung entspricht. Ist möglicherweise NULL.
timeSeriesId

TimeSeriesId[]

Zeitreihen-ID der Zeitreihen-instance, die der Suchanforderung entspricht.
typeId

string

Stellt den Typ dar, zu dem zeitreihen instance, dem die Suchanforderung entspricht. Nie NULL.

InstancesSortBy

Wert, der für die Sortierung der Zeitreiheninstanzen verwendet werden soll, bevor vom Aufruf von Suchinstanzen zurückgegeben wird. Wenn sie auf "Rang" festgelegt ist, werden die zurückgegebenen Instanzen basierend auf der Relevanz sortiert. Wenn sie auf "DisplayName" festgelegt ist, werden die zurückgegebenen Ergebnisse basierend auf dem Anzeigenamen sortiert. Anzeigename ist der Name der instance, sofern vorhanden, andernfalls ist der Anzeigename die Zeitreihen-ID. Der Standardwert ist "Rang".

Name Typ Beschreibung
DisplayName

string

Rank

string

InstancesSortParameter

Definition, wie Zeitreiheninstanzen sortiert werden, bevor sie von Suchinstanzen aufgerufen werden.

Name Typ Beschreibung
by

InstancesSortBy

Wert, der für die Sortierung der Zeitreiheninstanzen verwendet werden soll, bevor vom Aufruf von Suchinstanzen zurückgegeben wird. Wenn sie auf "Rang" festgelegt ist, werden die zurückgegebenen Instanzen basierend auf der Relevanz sortiert. Wenn sie auf "DisplayName" festgelegt ist, werden die zurückgegebenen Ergebnisse basierend auf dem Anzeigenamen sortiert. Anzeigename ist der Name der instance, sofern vorhanden, andernfalls ist der Anzeigename die Zeitreihen-ID. Der Standardwert ist "Rang".

SearchHierarchyNodesResponse

Die Hierarchieknoten, die die Instanzen enthalten, die der Abfrage basierend auf der Eingabe entsprechen. Kann leer oder NULL sein.

Name Typ Beschreibung
continuationToken

string

Wenn dies zurückgegeben wird, bedeutet dies, dass aktuelle Ergebnisse ein Teilergebnis darstellen. Fortsetzungstoken ermöglicht das Abrufen der nächsten Seite der Ergebnisse. Um die nächste Seite der Abfrageergebnisse zu erhalten, senden Sie dieselbe Anforderung mit dem Fortsetzungstokenparameter im HTTP-Header "x-ms-continuation".
hitCount

integer

Gesamtanzahl der Hierarchieknoten, die die Instanzen enthält, die der Abfrage basierend auf der Eingabe entsprechen.
hits

HierarchyHit[]

Die Liste der Hierarchieknoten, die die Instanzen enthält, die der Abfrage basierend auf der Eingabe entsprechen. Kann leer sein.

SearchInstancesHierarchiesParameters

Parameter zum Zurückgeben von Zeitreihen instance Hierarchien nach Aufruf von Suchinstanzen.

Name Typ Beschreibung
expand

HierarchiesExpandParameter

Definition, ob Hierarchieknoten in demselben Suchinstanzaufruf erweitert werden sollen. Optional, der Standardwert ist "UntilChildren".
pageSize

integer

Maximale Anzahl von Hierarchien auf derselben Ebene, die auf derselben Seite zurückgegeben werden sollen. Optional ist der Standardwert 10, wenn er nicht festgelegt ist. Der Bereich liegt zwischen 1 und 100. Wenn Ergebnisse vorhanden sind, die über die Seitengröße hinausgehen, kann das Fortsetzungstoken verwendet werden, um die nächste Seite abzurufen.
sort

HierarchiesSortParameter

Definition der Sortierung von Hierarchieknoten. Optional, der Standardwert ist "CumulativeInstanceCount".

SearchInstancesParameters

Parameter für die Rückgabe von Zeitreiheninstanzen durch Aufruf von Suchinstanzen.

Name Typ Beschreibung
highlights

boolean

Definition von hervorgehobenen Suchergebnissen oder nicht. Wenn sie auf "true" festgelegt ist, werden die hervorgehobenen Suchergebnisse zurückgegeben. Wenn sie auf "false" festgelegt ist, werden die hervorgehobenen Suchergebnisse nicht zurückgegeben. Der Standardwert ist 'true'.
pageSize

integer

Maximale Anzahl von Instanzen, die auf jeder Seite des Ergebnisses erwartet werden. Der Standardwert ist 10, wenn nicht festgelegt. Reicht von 1 bis 100. Wenn ergebnisse vorhanden sind, die über die Seitengröße hinausgehen, kann der Benutzer das Fortsetzungstoken verwenden, um die nächste Seite abzurufen.
recursive

boolean

Definition, welche Instanzen zurückgegeben werden. Wenn rekursiv auf "true" festgelegt ist, werden alle Instanzen zurückgegeben, die über den Pfad verfügen, der mit dem Path-Parameter beginnt. Wenn rekursiv auf "false" festgelegt ist, werden nur Instanzen zurückgegeben, die über den Pfad verfügen, der genau mit dem path-Parameter übereinstimmt. Die Verwendung der rekursiven Suche ermöglicht die Implementierung der Suchbenutzeroberfläche, während die Verwendung nicht rekursiver Suche die Implementierung von Navigationsfunktionen ermöglicht. Optional, der Standardwert ist "true".
sort

InstancesSortParameter

Definition, wie Zeitreiheninstanzen sortiert werden, bevor sie von Suchinstanzen zurückgegeben werden– Relevanz oder alphabetisch. Optional ist der Standardwert "Rang".

SearchInstancesRequest

Anforderung, eine Suchabfrage für Zeitreiheninstanzen auszuführen und übereinstimmende Zeitreiheninstanzen zurückzugeben.

Name Typ Beschreibung
hierarchies

SearchInstancesHierarchiesParameters

Parameter für die Rückgabe von Zeitreihen instance Hierarchien. Bei NULL werden keine Hierarchien zurückgegeben. Wenn der Instances-Parameter NULL und der hierarchies-Parameter nicht NULL ist, werden nur Hierarchien ohne Instanzen zurückgegeben.
instances

SearchInstancesParameters

Parameter für die Rückgabe von Zeitreiheninstanzen. Kann NULL sein. Wenn sowohl der Instanz- als auch der Hierarchieparameter NULL sind, werden die Instanzen in den Ergebnissen basierend auf den Standardwerten von Parametern zurückgegeben, und Hierarchien werden nicht zurückgegeben.
path

string[]

Filtern sie nach dem Hierarchiepfad von Zeitreiheninstanzen. Pfad wird als Array von Zeichenfolgenpfadsegmenten dargestellt. Das erste Element sollte der Hierarchiename sein. Beispiel: ["Location", "California"]. Optional, Groß-/Kleinschreibung, nie leer und kann NULL sein.
searchString

string

Abfragesuchzeichenfolge, die mit den Attributen von Zeitreiheninstanzen abgeglichen wird. Beispiel: "floor 100". Die Groß-/Kleinschreibung muss nicht beachtet werden, kann jedoch eine leere Zeichenfolge sein.

SearchInstancesResponse

Die Instanzen, die der Abfrage basierend auf der Eingabe entsprechen. Kann leer oder NULL sein.

Name Typ Beschreibung
continuationToken

string

Wenn dies zurückgegeben wird, bedeutet dies, dass aktuelle Ergebnisse ein Teilergebnis darstellen. Fortsetzungstoken ermöglicht das Abrufen der nächsten Seite der Ergebnisse. Um die nächste Seite der Abfrageergebnisse zu erhalten, senden Sie dieselbe Anforderung mit dem Fortsetzungstokenparameter im HTTP-Header "x-ms-continuation".
hitCount

integer

Gesamtanzahl der Instanzen, die der Abfrage basierend auf der Eingabe entsprechen.
hits

InstanceHit[]

Die Liste der Instanzen, die der Abfrage basierend auf der Eingabe entsprechen. Kann leer sein.

SearchInstancesResponsePage

Einzelne Seite der Suchergebnisse.

Name Typ Beschreibung
hierarchyNodes

SearchHierarchyNodesResponse

Die Hierarchieknoten, die die Instanzen enthalten, die der Abfrage basierend auf der Eingabe entsprechen. Kann leer oder NULL sein.
instances

SearchInstancesResponse

Die Instanzen, die der Abfrage basierend auf der Eingabe entsprechen. Kann leer oder NULL sein.

TsiError

Informationen zu einem API-Fehler.

Name Typ Beschreibung
error

TsiErrorBody

Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.

TsiErrorBody

Ein bestimmter API-Fehler mit einem Fehlercode und einer Meldung.

Name Typ Beschreibung
code

string

Sprachunabhängige, für Menschen lesbare Zeichenfolge, die einen dienstspezifischen Fehlercode definiert. Dieser Code dient als spezifischerer Indikator für den in der Antwort angegebenen HTTP-Fehlercode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details

TsiErrorDetails[]

Enthält zusätzliche Fehlerinformationen. Ist möglicherweise NULL.
innerError

TsiErrorBody

Enthält einen spezifischeren Fehler, der die Ursache eingrenzt. Ist möglicherweise NULL.
message

string

Für Menschen lesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Exposition gegenüber Endbenutzern.
target

string

Ziel des bestimmten Fehlers (z. B. der Name der -Eigenschaft im Fehler). Ist möglicherweise NULL.

TsiErrorDetails

Zusätzliche Fehlerinformationen.

Name Typ Beschreibung
code

string

Sprachunabhängige, für Menschen lesbare Zeichenfolge, die einen dienstspezifischen Fehlercode definiert. Dieser Code dient als spezifischerer Indikator für den in der Antwort angegebenen HTTP-Fehlercode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
message

string

Für Menschen lesbare, sprachunabhängige Darstellung des Fehlers. Es ist als Hilfe für Entwickler gedacht und eignet sich nicht für die Exposition gegenüber Endbenutzern.