Time Series Instances - Search

  • Referencia
Service:
Time Series Insights
API Version:
2020-07-31

Az idősorpéldányok példányattribútumok alapján történő keresésére vonatkozó találatok részleges listája.

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

URI-paraméterek

Name In Kötelező Típus Description
environmentFqdn
 path True

string

Környezeti teljes tartománynévként, például 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Ezt a tartománynevet a Get Environments API, a Azure Portal vagy az Azure Resource Manager válaszából szerezheti be.
api-version
 query True

string

Az ügyfélkéréshez használni kívánt API verziója. Jelenleg a "2020-07-31" támogatott verzió.

Kérelem fejléce

Name Kötelező Típus Description
x-ms-continuation

string

Folytatási jogkivonat az előző eredményoldalról az eredmények következő oldalának lekéréséhez a lapozást támogató hívásokban. Az első oldal eredményeinek lekéréséhez adja meg a null folytatási jogkivonatot paraméterértékként. A visszaadott folytatási jogkivonat null értékű, ha az összes eredményt visszaadta, és nincs következő találatoldal.
x-ms-client-request-id

string

Nem kötelező ügyfélkérés azonosítója. A szolgáltatás ezt az értéket rögzíti. Lehetővé teszi, hogy a szolgáltatás nyomon kövesse a műveletet a szolgáltatások között, és lehetővé teszi, hogy az ügyfél kapcsolatba lépjen az ügyfélszolgálattal egy adott kéréssel kapcsolatban.
x-ms-client-session-id

string

Nem kötelező ügyfélmunkamenet-azonosító. A szolgáltatás ezt az értéket rögzíti. Lehetővé teszi, hogy a szolgáltatás nyomon kövesse a kapcsolódó műveletek egy csoportját a szolgáltatások között, és lehetővé teszi, hogy az ügyfél kapcsolatba lépjen az ügyfélszolgálattal egy adott kéréscsoporttal kapcsolatban.

Kérelem törzse

Name Kötelező Típus Description
searchString True

string

Lekérdezési keresési sztring, amely megfelel az idősorpéldányok attribútumainak. Példa: "100. emelet". A kis- és nagybetűk érzéketlennek kell lenniük, de lehetnek üres sztringek.
hierarchies

SearchInstancesHierarchiesParameters

Az idősorpéldány-hierarchiák visszaadásának paraméterei. Null érték esetén a rendszer nem ad vissza hierarchiákat. Ha a példányparaméter null értékű, és a hierarchiák paramétere nem null, csak a példány nélküli hierarchiák lesznek visszaadva.
instances

SearchInstancesParameters

Idősorpéldányok visszaadásának paraméterei. Null értékű lehet. Ha a példányok és a hierarchiák paraméterei is null értékűek, a rendszer a paraméterek alapértelmezett értékei alapján adja vissza a példányokat az eredményekben, és a hierarchiák nem lesznek visszaadva.
path

string[]

Szűrjön az idősorpéldányok hierarchiaútvonalára. Az elérési út karakterlánc-szegmensek tömbjeként jelenik meg. Az első elemnek hierarchianévnek kell lennie. Példa: ["Location", "California"]. Nem kötelező, a kis- és nagybetűk megkülönböztetése, soha nem üres, és null értékű lehet.

Válaszok

Name Típus Description
200 OK

SearchInstancesResponsePage

Sikeres keresési válasz.

Headers

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

TsiError

Váratlan hiba.

Headers

x-ms-request-id: string

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

SearchInstancesDefault
SearchInstancesExpandHierarchiesOnly
SearchInstancesHierarchiesDefaultInputPage1
SearchInstancesHierarchiesDefaultInputPage2
SearchInstancesHierarchiesDefaultInputPage3
SearchInstancesOneLevel
SearchInstancesRecursive
SearchInstancesUntilChildren

SearchInstancesDefault

Sample Request

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

{
  "searchString": "floor 100"
}

Sample Response

Status code:
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

Sample Request

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

Sample Response

Status code:
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

Sample Request

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

Sample Response

Status code:
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

Sample Request

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

Sample Response

Status code:
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

Sample Request

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

Sample Response

Status code:
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

Sample Request

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

Sample Response

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

SearchInstancesRecursive

Sample Request

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
}

Sample Response

Status code:
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

Sample Request

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

Sample Response

Status code:
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
  }
}

Definíciók

Name Description
HierarchiesExpandKind

A hierarchiacsomópontok kiterjesztésének típusa. Ha az "UntilChildren" értékre van állítva, a hierarchiacsomópontok rekurzív módon lesznek kibontva, amíg több gyermek nem lesz. Ha a "OneLevel" értékre van állítva, a hierarchiák csak az egyszintű elérésiút-keresési példányok paraméterében lesznek kibontva. Nem kötelező, az alapértelmezett érték az "UntilChildren".
HierarchiesExpandParameter

Annak meghatározása, hogy ki szeretné-e bontani a hierarchiacsomópontokat ugyanabban a keresési példányban.
HierarchiesSortBy

A hierarchiacsomópont-rendezéshez használandó érték. Ha a "GöngyöltinstanceCount" értékre van állítva, a visszaadott hierarchiák a hierarchiacsomóponthoz és a gyermekhierarchia csomópontjaihoz tartozó összes példány alapján lesznek rendezve. Ha a "Név" értékre van állítva, a visszaadott hierarchiák a hierarchia neve alapján lesznek rendezve. Nem kötelező, az alapértelmezett érték a "GöngyöltInstanceCount".
HierarchiesSortParameter

A hierarchiacsomópontok rendezésének definíciója.
HierarchyHit

A lekérdezésnek megfelelő példányokat tartalmazó hierarchiacsomópont a bemenet alapján. Üres vagy null értékű lehet.
Highlights

A felhasználó számára megjelenítendő idősorpéldány kiemelt szövege. Beszúrások és címkék kiemelése a keresési sztringnek megfelelő szövegrészekben. Ne használja a kiemelt tulajdonságok egyikét sem további API-hívásokhoz.
InstanceHit

A példányok keresési hívása által visszaadott idősorpéldány. A visszaadott példány megfelelt a keresési kérelemnek, és kiemelt szöveget tartalmaz, amely "igaz" értékre van állítva a felhasználó számára.
InstancesSortBy

A keresési példányok hívása által visszaadott idősorpéldányok rendezéséhez használandó érték. Ha a "Rangsor" értékre van állítva, a visszaadott példányok a relevancia alapján lesznek rendezve. Ha a "DisplayName" értékre van állítva, a visszaadott eredmények a megjelenített név alapján lesznek rendezve. A megjelenítendő név a példány neve, ha létezik, ellenkező esetben a megjelenítendő név az idősor azonosítója. Az alapértelmezett érték a "Rangsor".
InstancesSortParameter

Az idősorpéldányok rendezési módjának meghatározása a keresési példányok hívása előtt.
SearchHierarchyNodesResponse

A lekérdezésnek megfelelő példányokat tartalmazó hierarchiacsomópontok a bemenet alapján. Lehet üres vagy null értékű.
SearchInstancesHierarchiesParameters

Az idősorpéldány-hierarchiák keresési példányok hívása szerinti visszaadásának paramétere.
SearchInstancesParameters

Az idősorpéldányok keresési példányok hívása szerinti visszaadásának paraméterei.
SearchInstancesRequest

Kérés keresési lekérdezés végrehajtására az idősorpéldányokon, és egyező idősorpéldányokat ad vissza.
SearchInstancesResponse

A lekérdezésnek megfelelő példányok a bemenet alapján. Lehet üres vagy null értékű.
SearchInstancesResponsePage

A keresési eredmények egyetlen oldala.
TsiError

Információ egy API-hibáról.
TsiErrorBody

Egy adott API-hiba egy hibakóddal és egy üzenettel.
TsiErrorDetails

További hibainformációk.

HierarchiesExpandKind

A hierarchiacsomópontok kiterjesztésének típusa. Ha az "UntilChildren" értékre van állítva, a hierarchiacsomópontok rekurzív módon lesznek kibontva, amíg több gyermek nem lesz. Ha a "OneLevel" értékre van állítva, a hierarchiák csak az egyszintű elérésiút-keresési példányok paraméterében lesznek kibontva. Nem kötelező, az alapértelmezett érték az "UntilChildren".

Name Típus Description
OneLevel

string

UntilChildren

string

HierarchiesExpandParameter

Annak meghatározása, hogy ki szeretné-e bontani a hierarchiacsomópontokat ugyanabban a keresési példányban.

Name Típus Description
kind

HierarchiesExpandKind

A hierarchiacsomópontok kiterjesztésének típusa. Ha az "UntilChildren" értékre van állítva, a hierarchiacsomópontok rekurzív módon lesznek kibontva, amíg több gyermek nem lesz. Ha a "OneLevel" értékre van állítva, a hierarchiák csak az egyszintű elérésiút-keresési példányok paraméterében lesznek kibontva. Nem kötelező, az alapértelmezett érték az "UntilChildren".

HierarchiesSortBy

A hierarchiacsomópont-rendezéshez használandó érték. Ha a "GöngyöltinstanceCount" értékre van állítva, a visszaadott hierarchiák a hierarchiacsomóponthoz és a gyermekhierarchia csomópontjaihoz tartozó összes példány alapján lesznek rendezve. Ha a "Név" értékre van állítva, a visszaadott hierarchiák a hierarchia neve alapján lesznek rendezve. Nem kötelező, az alapértelmezett érték a "GöngyöltInstanceCount".

Name Típus Description
CumulativeInstanceCount

string

Name

string

HierarchiesSortParameter

A hierarchiacsomópontok rendezésének definíciója.

Name Típus Description
by

HierarchiesSortBy

A hierarchiacsomópont-rendezéshez használandó érték. Ha a "CumulativeInstanceCount" értékre van állítva, a visszaadott hierarchiák a hierarchiacsomóponthoz és annak gyermekhierarchia-csomópontjaihoz tartozó összes példány alapján lesznek rendezve. Ha a "Név" értékre van állítva, a visszaadott hierarchiák a hierarchia neve alapján lesznek rendezve. Nem kötelező, az alapértelmezett érték a "CumulativeInstanceCount".

HierarchyHit

A lekérdezésnek megfelelő példányokat tartalmazó hierarchiacsomópont a bemenet alapján. Üres vagy null értékű lehet.

Name Típus Description
cumulativeInstanceCount

integer

A csomóponthoz tartozó példányok teljes száma és a lekérdezésnek megfelelő részhalmazok.
hierarchyNodes

SearchHierarchyNodesResponse

A csomópont gyermekhierarchiacsomópontjai. Üres vagy null értékű lehet.
name

string

A hierarchiacsomópont neve. Lehet, hogy üres, nem lehet null.

Highlights

A felhasználó számára megjelenítendő idősorpéldány kiemelt szövege. Beszúrások és címkék kiemelése a keresési sztringnek megfelelő szövegrészekben. Ne használja a kiemelt tulajdonságok egyikét sem további API-hívásokhoz.

Name Típus Description
description

string

Az idősorpéldány kiemelt leírása. Lehet, hogy null értékű.
hierarchyIds

string[]

Azon kiemelt idősor-hierarchiaazonosítók listája, amelyekhez az idősorpéldány tartozik. Nem használható hierarchiák keresésére. Lehet, hogy null értékű.
hierarchyNames

string[]

Azon kiemelt idősor-hierarchianevek listája, amelyekhez az idősorpéldány tartozik. Nem használható hierarchiák keresésére. Lehet, hogy null értékű.
instanceFieldNames

string[]

A kiemelt idősorpéldányok mezőneveinek listája. Lehet, hogy null értékű.
instanceFieldValues

string[]

Az idősorok kiemelt mezőértékeinek listája. Lehet, hogy null értékű.
name

string

Az idősorpéldány kiemelt neve. Lehet, hogy null értékű.
timeSeriesId

string[]

A megjelenítendő idősor-azonosító kiemelt sztringértékeinek listája. Nem használható a példány keresésére.
typeName

string

Kiemelt idősortípus neve, amelyhez ez a példány tartozik.

InstanceHit

A példányok keresési hívása által visszaadott idősorpéldány. A visszaadott példány megfelelt a keresési kérelemnek, és kiemelt szöveget tartalmaz, amely "igaz" értékre van állítva a felhasználó számára.

Name Típus Description
hierarchyIds

string[]

Azon idősor-hierarchiaazonosítók listája, amelyekhez az idősorpéldány tartozik, amely megfelel a keresési kérelemnek. Nem használható hierarchiák keresésére. Lehet, hogy null értékű.
highlights

Highlights

A felhasználó számára megjelenítendő idősorpéldány kiemelt szövege. Beszúrások és címkék kiemelése a keresési sztringnek megfelelő szövegrészekben. Ne használja a kiemelt tulajdonságok egyikét sem további API-hívásokhoz.
name

string

Annak az idősorpéldánynak a neve, amely megfelelt a keresési kérelemnek. Lehet, hogy null értékű.
timeSeriesId

TimeSeriesId[]

Annak az idősorpéldánynak az idősorazonosítója, amely megfelelt a keresési kérelemnek.
typeId

string

Azt a típust jelöli, amelyhez a keresési kérelemnek megfelelő idősorpéldány tartozik. Soha ne null értékű legyen.

InstancesSortBy

A keresési példányok hívása által visszaadott idősorpéldányok rendezéséhez használandó érték. Ha a "Rangsor" értékre van állítva, a visszaadott példányok a relevancia alapján lesznek rendezve. Ha a "DisplayName" értékre van állítva, a visszaadott eredmények a megjelenített név alapján lesznek rendezve. A megjelenítendő név a példány neve, ha létezik, ellenkező esetben a megjelenítendő név az idősor azonosítója. Az alapértelmezett érték a "Rangsor".

Name Típus Description
DisplayName

string

Rank

string

InstancesSortParameter

Az idősorpéldányok rendezési módjának meghatározása a keresési példányok hívása előtt.

Name Típus Description
by

InstancesSortBy

A keresési példányok hívása által visszaadott idősorpéldányok rendezéséhez használandó érték. Ha a "Rangsor" értékre van állítva, a visszaadott példányok a relevancia alapján lesznek rendezve. Ha a "DisplayName" értékre van állítva, a visszaadott eredmények a megjelenített név alapján lesznek rendezve. A megjelenítendő név a példány neve, ha létezik, ellenkező esetben a megjelenítendő név az idősor azonosítója. Az alapértelmezett érték a "Rangsor".

SearchHierarchyNodesResponse

A lekérdezésnek megfelelő példányokat tartalmazó hierarchiacsomópontok a bemenet alapján. Lehet üres vagy null értékű.

Name Típus Description
continuationToken

string

Ha visszaadja, az azt jelenti, hogy az aktuális eredmények részleges eredményt jelentenek. A folytatási jogkivonat lehetővé teszi az eredmények következő oldalának lekérését. A lekérdezési eredmények következő oldalának lekéréséhez küldje el ugyanazt a kérést a folytatási jogkivonat paraméterével az "x-ms-continuation" HTTP-fejlécben.
hitCount

integer

A lekérdezésnek megfelelő példányokat tartalmazó hierarchiacsomópontok teljes száma a bemenet alapján.
hits

HierarchyHit[]

A lekérdezésnek megfelelő példányokat tartalmazó hierarchiacsomópontok listája a bemenet alapján. Lehet, hogy üres.

SearchInstancesHierarchiesParameters

Az idősorpéldány-hierarchiák keresési példányok hívása szerinti visszaadásának paramétere.

Name Típus Description
expand

HierarchiesExpandParameter

Annak meghatározása, hogy ki szeretné-e bontani a hierarchiacsomópontokat ugyanabban a keresési példányban. Nem kötelező, az alapértelmezett érték az "UntilChildren".
pageSize

integer

Az ugyanazon a szinten lévő hierarchiák maximális száma, ha ugyanabban az oldalon szeretne visszatérni. Nem kötelező, az alapértelmezett érték 10, ha nincs beállítva. A tartomány 1 és 100 között lehet. Ha az oldalméreten kívül vannak eredmények, a folytatási jogkivonattal lekérheti a következő oldalt.
sort

HierarchiesSortParameter

A hierarchiacsomópontok rendezésének definíciója. Nem kötelező, az alapértelmezett érték a "CumulativeInstanceCount".

SearchInstancesParameters

Az idősorpéldányok keresési példányok hívása szerinti visszaadásának paraméterei.

Name Típus Description
highlights

boolean

A kiemelt keresési eredmények definíciója, vagy sem. Ha "true" (igaz) értékre van állítva, a rendszer a kiemelt keresési eredményeket adja vissza. Ha "false" (hamis) értékre van állítva, a rendszer nem adja vissza a kiemelt keresési eredményeket. Az alapértelmezett érték az "igaz".
pageSize

integer

Az eredmény minden oldalán a várt példányok maximális száma. Alapértelmezés szerint 10, ha nincs beállítva. 1 és 100 közötti tartomány. Ha az oldalméreten kívül vannak eredmények, a felhasználó a folytatási jogkivonat használatával lekérheti a következő oldalt.
recursive

boolean

A visszaadott példányok definíciója. Ha a rekurzív érték "true" (igaz) értékre van állítva, a rendszer az összes olyan példányt visszaadja, amelynek elérési útja az elérési út paraméterrel kezdődik. Ha a rekurzív érték "false" (hamis) értékre van állítva, a rendszer csak azokat a példányokat adja vissza, amelyek elérési útja pontosan megegyezik az elérési út paraméterével. A rekurzív keresés lehetővé teszi a keresési felhasználói élmény megvalósítását, míg a nem rekurzív keresés lehetővé teszi a navigációs élmény megvalósítását. Nem kötelező, az alapértelmezett érték az "igaz".
sort

InstancesSortParameter

Az idősorpéldányok rendezésének meghatározása a keresési példányok hívása előtt – relevancia vagy betűrend szerint. Nem kötelező, az alapértelmezett érték a "Rangsor".

SearchInstancesRequest

Kérés keresési lekérdezés végrehajtására az idősorpéldányokon, és egyező idősorpéldányokat ad vissza.

Name Típus Description
hierarchies

SearchInstancesHierarchiesParameters

Az idősorpéldány-hierarchiák visszaadásának paraméterei. Ha null, a rendszer nem ad vissza hierarchiákat. Ha a példányparaméter null értékű, és a hierarchiaparaméter nem null, csak a példány nélküli hierarchiák lesznek visszaadva.
instances

SearchInstancesParameters

Az idősorpéldányok visszaadásának paraméterei. Null érték is lehet. Ha a példányok és a hierarchiák paraméterei is null értékűek, a rendszer a paraméterek alapértelmezett értékei alapján adja vissza a példányokat az eredményekben, és a hierarchiák nem lesznek visszaadva.
path

string[]

Szűrjön az idősorpéldányok hierarchiaútvonalára. Az elérési út karakterlánc-szegmensek tömbjeként jelenik meg. Az első elemnek hierarchianévnek kell lennie. Például: ["Location", "California"]. Nem kötelező, a kis- és nagybetűk megkülönböztetése, soha nem üres, és null értékű is lehet.
searchString

string

Lekérdezés keresési sztringje, amely megfelel az idősorpéldányok attribútumainak. Példa: "100. emelet". A kis- és nagybetűk megkülönböztetése nem kötelező, de lehet üres sztring.

SearchInstancesResponse

A lekérdezésnek megfelelő példányok a bemenet alapján. Lehet üres vagy null értékű.

Name Típus Description
continuationToken

string

Ha visszaadja, az azt jelenti, hogy az aktuális eredmények részleges eredményt jelentenek. A folytatási jogkivonat lehetővé teszi az eredmények következő oldalának lekérését. A lekérdezési eredmények következő oldalának lekéréséhez küldje el ugyanazt a kérést a folytatási jogkivonat paraméterével az "x-ms-continuation" HTTP-fejlécben.
hitCount

integer

A lekérdezésnek megfelelő példányok teljes száma a bemenet alapján.
hits

InstanceHit[]

A lekérdezésnek megfelelő példányok listája a bemenet alapján. Lehet, hogy üres.

SearchInstancesResponsePage

A keresési eredmények egyetlen oldala.

Name Típus Description
hierarchyNodes

SearchHierarchyNodesResponse

A lekérdezésnek megfelelő példányokat tartalmazó hierarchiacsomópontok a bemenet alapján. Lehet üres vagy null értékű.
instances

SearchInstancesResponse

A lekérdezésnek megfelelő példányok a bemenet alapján. Lehet üres vagy null értékű.

TsiError

Információ egy API-hibáról.

Name Típus Description
error

TsiErrorBody

Egy adott API-hiba egy hibakóddal és egy üzenettel.

TsiErrorBody

Egy adott API-hiba egy hibakóddal és egy üzenettel.

Name Típus Description
code

string

Nyelvfüggetlen, emberi olvasásra alkalmas sztring, amely szolgáltatásspecifikus hibakódot határoz meg. Ez a kód pontosabb jelzője a válaszban megadott HTTP-hibakódnak. Adott hibaeseteket programozott módon lehet kezelni.
details

TsiErrorDetails[]

További hibainformációkat tartalmaz. Lehet, hogy null értékű.
innerError

TsiErrorBody

Pontosabb hibát tartalmaz, amely leszűkíti az okot. Lehet, hogy null értékű.
message

string

A hiba ember által olvasható, nyelvfüggetlen ábrázolása. A fejlesztőknek szánt támogatás, és nem alkalmas a végfelhasználóknak való kitettségre.
target

string

Az adott hiba célja (például a hibás tulajdonság neve). Lehet, hogy null értékű.

TsiErrorDetails

További hibainformációk.

Name Típus Description
code

string

Nyelvfüggetlen, emberi olvasásra alkalmas sztring, amely szolgáltatásspecifikus hibakódot definiál. Ez a kód a válaszban megadott HTTP-hibakód pontosabb jelzőjeként szolgál. Adott hibaesetek programozott kezelésére használható.
message

string

A hiba ember által olvasható, nyelvfüggetlen ábrázolása. A fejlesztőknek szánt támogatás, és nem alkalmas a végfelhasználóknak való kitettségre.