Dela via

Time Series Instances - Search

Tjänst:
Time Series Insights
API-version:
2020-07-31

Partiell lista över träffar vid sökning efter tidsserieinstanser baserat på instansattribut.

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

URI-parametrar

Name I Obligatorisk Typ Description
environmentFqdn
 path True

string

FQDN per miljö, till exempel 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Du kan hämta det här domännamnet från svaret från Get Environments API, Azure Portal eller Azure Resource Manager.
api-version
 query True

string

Version av API:et som ska användas med klientbegäran. Den version som stöds för närvarande är "2020-07-31".

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-continuation

string

Fortsättningstoken från föregående resultatsida för att hämta nästa sida i resultatet i anrop som stöder sidnumrering. Om du vill få resultat från första sidan anger du null-fortsättningstoken som parametervärde. Den returnerade fortsättningstoken är null om alla resultat har returnerats och det inte finns någon nästa sida med resultat.
x-ms-client-request-id

string

Valfritt klientbegärans-ID. Tjänsten registrerar det här värdet. Tillåter att tjänsten spårar åtgärder mellan tjänster och gör det möjligt för kunden att kontakta supporten angående en viss begäran.
x-ms-client-session-id

string

Valfritt klientsessions-ID. Tjänsten registrerar det här värdet. Gör att tjänsten kan spåra en grupp relaterade åtgärder mellan tjänster och gör det möjligt för kunden att kontakta supporten om en viss grupp med begäranden.

Begärandetext

Name Obligatorisk Typ Description
searchString True

string

Frågesöksträng som ska matchas med attributen för tidsserieinstanser. Exempel: "våning 100". Skiftlägesokänsligt måste finnas, men kan vara en tom sträng.
hierarchies

SearchInstancesHierarchiesParameters

Parametrar för hur du returnerar tidsserieinstanshierarkier. Om värdet är null returneras inte hierarkier. Om instansparametern är null och hierarkiparametern inte är null returneras endast hierarkier utan instanser.
instances

SearchInstancesParameters

Parametrar för hur du returnerar tidsserieinstanser. Kan vara null. När både parametrarna för instanser och hierarkier är null returneras instanserna i resultaten baserat på standardvärdena för parametrar och hierarkier returneras inte.
path

string[]

Filtrera på hierarkisökvägen för tidsserieinstanser. Sökvägen representeras som en matris med strängsökvägssegment. Det första elementet ska vara hierarkinamn. Exempel: ["Location", "California"]. Valfritt, skiftlägeskänsligt, aldrig tomt och kan vara null.

Svar

Name Typ Description
200 OK

SearchInstancesResponsePage

Lyckat söksvar.

Sidhuvuden

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

TsiError

Oväntat fel.

Sidhuvuden

x-ms-request-id: string

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

SearchInstancesDefault
SearchInstancesExpandHierarchiesOnly
SearchInstancesHierarchiesDefaultInputPage1
SearchInstancesHierarchiesDefaultInputPage2
SearchInstancesHierarchiesDefaultInputPage3
SearchInstancesOneLevel
SearchInstancesRecursive
SearchInstancesUntilChildren

SearchInstancesDefault

Exempelbegäran

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

{
  "searchString": "floor 100"
}

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

SearchInstancesRecursive

Exempelbegäran

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
}

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
HierarchiesExpandKind

Typ av expansion av hierarkinoder. När den är inställd på "UntilChildren" expanderas hierarkinoderna rekursivt tills det finns fler än ett underordnat objekt. När den är inställd på "OneLevel" expanderas hierarkierna endast på den matchande sökvägsinstansparametern på en nivå. Valfritt är standard "UntilChildren".
HierarchiesExpandParameter

Definition av om du vill expandera hierarkinoder i samma sökinstansanrop.
HierarchiesSortBy

Värde som ska användas för hierarkinodsortering. När den är inställd på "CumulativeInstanceCount" sorteras de returnerade hierarkierna baserat på de totala instanserna som tillhör hierarkinoden och dess underordnade hierarkinoder. När den är inställd på Namn sorteras de returnerade hierarkierna baserat på hierarkinamnet. Valfritt är standard "CumulativeInstanceCount".
HierarchiesSortParameter

Definition av sortering av hierarkinoder.
HierarchyHit

Hierarkinoden som innehåller de instanser som matchar frågan baserat på indata. Kan vara tomt eller null.
Highlights

Markerad text i tidsserieinstansen som ska visas för användaren. Markering infogar <taggarna hit> och </hit> i de delar av texten som matchade söksträngen. Använd inte någon av de markerade egenskaperna för att göra ytterligare API-anrop.
InstanceHit

Tidsserieinstans som returneras av instanssökningsanropet. Den returnerade instansen matchade sökbegäran och innehåller markerad text som ska visas för användaren om den är inställd på "true".
InstancesSortBy

Värde som ska användas för sortering av tidsserieinstanser innan de returneras av anropet för sökinstanser. När den är inställd på Rank sorteras de returnerade instanserna baserat på relevansen. När det är inställt på "DisplayName" sorteras de returnerade resultaten baserat på visningsnamnet. Visningsnamnet är namnet på instansen om den finns, annars är visningsnamnet tidsserie-ID. Standardvärdet är "Rank".
InstancesSortParameter

Definition av hur tidsserieinstanser sorteras innan de returneras av anrop för sökinstanser.
SearchHierarchyNodesResponse

Hierarkinoderna som innehåller de instanser som matchar frågan baserat på indata. Kan vara tomt eller null.
SearchInstancesHierarchiesParameters

Parameter för hur du returnerar tidsserieinstanshierarkier genom att anropa sökinstanser.
SearchInstancesParameters

Parametrar för hur du returnerar tidsserieinstanser genom att anropa sökinstanser.
SearchInstancesRequest

Begäran om att köra en sökfråga mot tidsserieinstanser och returnera matchande tidsserieinstanser.
SearchInstancesResponse

De instanser som matchar frågan baserat på indata. Kan vara tomt eller null.
SearchInstancesResponsePage

En sida med sökresultaten.
TsiError

Information om ett API-fel.
TsiErrorBody

Ett visst API-fel med en felkod och ett meddelande.
TsiErrorDetails

Ytterligare felinformation.

HierarchiesExpandKind

Uppräkning

Typ av expansion av hierarkinoder. När den är inställd på "UntilChildren" expanderas hierarkinoderna rekursivt tills det finns fler än ett underordnat objekt. När den är inställd på "OneLevel" expanderas hierarkierna endast på den matchande sökvägsinstansparametern på en nivå. Valfritt är standard "UntilChildren".

Värde Description
UntilChildren
OneLevel

HierarchiesExpandParameter

Objekt

Definition av om du vill expandera hierarkinoder i samma sökinstansanrop.

Name Typ Description
kind

HierarchiesExpandKind

Typ av expansion av hierarkinoder. När den är inställd på "UntilChildren" expanderas hierarkinoderna rekursivt tills det finns fler än ett underordnat objekt. När den är inställd på "OneLevel" expanderas hierarkierna endast på den matchande sökvägsinstansparametern på en nivå. Valfritt är standard "UntilChildren".

HierarchiesSortBy

Uppräkning

Värde som ska användas för hierarkinodsortering. När den är inställd på "CumulativeInstanceCount" sorteras de returnerade hierarkierna baserat på de totala instanserna som tillhör hierarkinoden och dess underordnade hierarkinoder. När den är inställd på Namn sorteras de returnerade hierarkierna baserat på hierarkinamnet. Valfritt är standard "CumulativeInstanceCount".

Värde Description
CumulativeInstanceCount
Name

HierarchiesSortParameter

Objekt

Definition av sortering av hierarkinoder.

Name Typ Description
by

HierarchiesSortBy

Värde som ska användas för hierarkinodsortering. När den är inställd på "CumulativeInstanceCount" sorteras de returnerade hierarkierna baserat på de totala instanserna som tillhör hierarkinoden och dess underordnade hierarkinoder. När den är inställd på Namn sorteras de returnerade hierarkierna baserat på hierarkinamnet. Valfritt är standard "CumulativeInstanceCount".

HierarchyHit

Objekt

Hierarkinoden som innehåller de instanser som matchar frågan baserat på indata. Kan vara tomt eller null.

Name Typ Description
cumulativeInstanceCount

integer (int32)

Totalt antal instanser som tillhör den här noden och det är underträd som matchar frågan.
hierarchyNodes

SearchHierarchyNodesResponse

Underordnade hierarkinoder för den här noden. Kan vara tomt eller null.
name

string

Namnet på hierarkinoden. Kan vara tom, får inte vara null.

Highlights

Objekt

Markerad text i tidsserieinstansen som ska visas för användaren. Markering infogar <taggarna hit> och </hit> i de delar av texten som matchade söksträngen. Använd inte någon av de markerade egenskaperna för att göra ytterligare API-anrop.

Name Typ Description
description

string

Markerad beskrivning av tidsserieinstansen. Kan vara null.
hierarchyIds

string[]

Lista över markerade tidsseriehierarki-ID:er som tidsserieinstansen tillhör. Det går inte att använda för uppslagshierarkier. Kan vara null.
hierarchyNames

string[]

Lista över markerade tidsseriehierarkinamn som tidsserieinstansen tillhör. Det går inte att använda för uppslagshierarkier. Kan vara null.
instanceFieldNames

string[]

Lista över markerade tidsserieinstansfältnamn. Kan vara null.
instanceFieldValues

string[]

Lista över markerade tidsserieinstansfältvärden. Kan vara null.
name

string

Markerat namn på tidsserieinstansen. Kan vara null.
timeSeriesId

string[]

Lista över markerade strängvärden för Tidsserie-ID för visning. Det går inte att använda uppslagsinstansen.
typeName

string

Markerat namn på tidsserietyp som den här instansen tillhör.

InstanceHit

Objekt

Tidsserieinstans som returneras av instanssökningsanropet. Den returnerade instansen matchade sökbegäran och innehåller markerad text som ska visas för användaren om den är inställd på "true".

Name Typ Description
hierarchyIds

string[]

Lista över tidsseriehierarki-ID:t som tidsserieinstansen som matchade sökbegäran tillhör. Det går inte att använda för uppslagshierarkier. Kan vara null.
highlights

Highlights

Markerad text i tidsserieinstansen som ska visas för användaren. Markering infogar <taggarna hit> och </hit> i de delar av texten som matchade söksträngen. Använd inte någon av de markerade egenskaperna för att göra ytterligare API-anrop.
name

string

Namnet på den tidsserieinstans som matchade sökbegäran. Kan vara null.
timeSeriesId

TimeSeriesId[]

Tidsserie-ID för tidsserieinstansen som matchade sökbegäran.
typeId

string

Representerar den typ som tidsserieinstansen som matchade sökbegäran tillhör. Aldrig null.

InstancesSortBy

Uppräkning

Värde som ska användas för sortering av tidsserieinstanser innan de returneras av anropet för sökinstanser. När den är inställd på Rank sorteras de returnerade instanserna baserat på relevansen. När det är inställt på "DisplayName" sorteras de returnerade resultaten baserat på visningsnamnet. Visningsnamnet är namnet på instansen om den finns, annars är visningsnamnet tidsserie-ID. Standardvärdet är "Rank".

Värde Description
Rank
DisplayName

InstancesSortParameter

Objekt

Definition av hur tidsserieinstanser sorteras innan de returneras av anrop för sökinstanser.

Name Typ Description
by

InstancesSortBy

Värde som ska användas för sortering av tidsserieinstanser innan de returneras av anropet för sökinstanser. När den är inställd på Rank sorteras de returnerade instanserna baserat på relevansen. När det är inställt på "DisplayName" sorteras de returnerade resultaten baserat på visningsnamnet. Visningsnamnet är namnet på instansen om den finns, annars är visningsnamnet tidsserie-ID. Standardvärdet är "Rank".

SearchHierarchyNodesResponse

Objekt

Hierarkinoderna som innehåller de instanser som matchar frågan baserat på indata. Kan vara tomt eller null.

Name Typ Description
continuationToken

string

Om det returneras innebär det att aktuella resultat representerar ett partiellt resultat. Med fortsättningstoken kan du hämta nästa sida med resultat. Om du vill hämta nästa sida med frågeresultat skickar du samma begäran med fortsättningstokenparametern i HTTP-huvudet "x-ms-continuation".
hitCount

integer (int32)

Totalt antal hierarkinoder som innehåller de instanser som matchar frågan baserat på indata.
hits

HierarchyHit[]

Listan över hierarkinoder som innehåller de instanser som matchar frågan baserat på indata. Kan vara tomt.

SearchInstancesHierarchiesParameters

Objekt

Parameter för hur du returnerar tidsserieinstanshierarkier genom att anropa sökinstanser.

Name Typ Description
expand

HierarchiesExpandParameter

Definition av om du vill expandera hierarkinoder i samma sökinstansanrop. Valfritt är standard "UntilChildren".
pageSize

integer (int32)

Maximalt antal hierarkier på samma nivå som ska returneras på samma sida. Valfritt, standardvärdet är 10 när det inte har angetts. Intervallet är mellan 1 och 100. Om det finns resultat utöver sidstorleken kan fortsättningstoken användas för att hämta nästa sida.
sort

HierarchiesSortParameter

Definition av sortering av hierarkinoder. Valfritt är standard "CumulativeInstanceCount".

SearchInstancesParameters

Objekt

Parametrar för hur du returnerar tidsserieinstanser genom att anropa sökinstanser.

Name Typ Description
highlights

boolean

Definition av markerade sökresultat eller inte. När den är inställd på "true" returneras de markerade sökresultaten. När det är inställt på "false" returneras inte de markerade sökresultaten. Standardvärdet är "true".
pageSize

integer (int32)

Maximalt antal instanser som förväntas på varje sida i resultatet. Standardvärdet är 10 när det inte har angetts. Varierar från 1 till 100. Om det finns resultat utöver sidstorleken kan användaren använda fortsättningstoken för att hämta nästa sida.
recursive

boolean

Definition av vilka instanser som returneras. När rekursivt är inställt på "true" returneras alla instanser som har sökvägen som börjar med sökvägsparametern. När rekursiv är inställd på "false" returneras endast instanser som har sökvägen som exakt matchar sökvägsparametern. Med rekursiv sökning kan du implementera sökanvändarupplevelsen, men med icke-rekursiv sökning kan du implementera navigeringsupplevelsen. Valfritt, standardvärdet är "true".
sort

InstancesSortParameter

Definition av hur tidsserieinstanser sorteras innan de returneras av anrop för sökinstanser – relevans eller alfabetisk. Valfritt är standard "Rank".

SearchInstancesRequest

Objekt

Begäran om att köra en sökfråga mot tidsserieinstanser och returnera matchande tidsserieinstanser.

Name Typ Description
hierarchies

SearchInstancesHierarchiesParameters

Parametrar för hur du returnerar tidsserieinstanshierarkier. Om värdet är null returneras inte hierarkier. Om instansparametern är null och hierarkiparametern inte är null returneras endast hierarkier utan instanser.
instances

SearchInstancesParameters

Parametrar för hur du returnerar tidsserieinstanser. Kan vara null. När både parametrarna för instanser och hierarkier är null returneras instanserna i resultaten baserat på standardvärdena för parametrar och hierarkier returneras inte.
path

string[]

Filtrera på hierarkisökvägen för tidsserieinstanser. Sökvägen representeras som en matris med strängsökvägssegment. Det första elementet ska vara hierarkinamn. Exempel: ["Location", "California"]. Valfritt, skiftlägeskänsligt, aldrig tomt och kan vara null.
searchString

string

Frågesöksträng som ska matchas med attributen för tidsserieinstanser. Exempel: "våning 100". Skiftlägesokänsligt måste finnas, men kan vara en tom sträng.

SearchInstancesResponse

Objekt

De instanser som matchar frågan baserat på indata. Kan vara tomt eller null.

Name Typ Description
continuationToken

string

Om det returneras innebär det att aktuella resultat representerar ett partiellt resultat. Med fortsättningstoken kan du hämta nästa sida med resultat. Om du vill hämta nästa sida med frågeresultat skickar du samma begäran med fortsättningstokenparametern i HTTP-huvudet "x-ms-continuation".
hitCount

integer (int32)

Totalt antal instanser som matchar frågan baserat på indata.
hits

InstanceHit[]

Listan över instanser som matchar frågan baserat på indata. Kan vara tomt.

SearchInstancesResponsePage

Objekt

En sida med sökresultaten.

Name Typ Description
hierarchyNodes

SearchHierarchyNodesResponse

Hierarkinoderna som innehåller de instanser som matchar frågan baserat på indata. Kan vara tomt eller null.
instances

SearchInstancesResponse

De instanser som matchar frågan baserat på indata. Kan vara tomt eller null.

TsiError

Objekt

Information om ett API-fel.

Name Typ Description
error

TsiErrorBody

Ett visst API-fel med en felkod och ett meddelande.

TsiErrorBody

Objekt

Ett visst API-fel med en felkod och ett meddelande.

Name Typ Description
code

string

Språkoberoende, läsbar sträng som definierar en tjänstspecifik felkod. Den här koden fungerar som en mer specifik indikator för HTTP-felkoden som anges i svaret. Kan användas för att programmatiskt hantera specifika felfall.
details

TsiErrorDetails[]

Innehåller ytterligare felinformation. Kan vara null.
innerError

TsiErrorBody

Innehåller mer specifika fel som begränsar orsaken. Kan vara null.
message

string

Mänsklig läsbar, språkoberoende representation av felet. Det är avsett som ett stöd för utvecklare och är inte lämpligt för exponering för slutanvändare.
target

string

Målet för det specifika felet (till exempel namnet på egenskapen i fel). Kan vara null.

TsiErrorDetails

Objekt

Ytterligare felinformation.

Name Typ Description
code

string

Språkoberoende, läsbar sträng som definierar en tjänstspecifik felkod. Den här koden fungerar som en mer specifik indikator för HTTP-felkoden som anges i svaret. Kan användas för att programmatiskt hantera specifika felfall.
message

string

Mänsklig läsbar, språkoberoende representation av felet. Det är avsett som ett stöd för utvecklare och är inte lämpligt för exponering för slutanvändare.