Share via

Time Series Instances - Search

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

Elenco parziale di riscontri nella ricerca di istanze di serie temporali in base agli attributi dell'istanza.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
environmentFqdn
 path True

string

FQDN per ambiente, ad esempio 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. È possibile ottenere questo nome di dominio dalla risposta dell'API Get Environments, portale di Azure o azure Resource Manager.
api-version
 query True

string

Versione dell'API da usare con la richiesta client. La versione attualmente supportata è "2020-07-31".

Intestazione della richiesta

Nome Necessario Tipo Descrizione
x-ms-continuation

string

Token di continuazione dalla pagina precedente dei risultati per recuperare la pagina successiva dei risultati nelle chiamate che supportano la paginazione. Per ottenere i risultati della prima pagina, specificare il token di continuazione Null come valore del parametro. Il token di continuazione restituito è Null se tutti i risultati sono stati restituiti e non è presente alcuna pagina successiva di risultati.
x-ms-client-request-id

string

ID richiesta client facoltativo. Il servizio registra questo valore. Consente al servizio di tenere traccia dell'operazione tra i servizi e consente al cliente di contattare il supporto tecnico relativo a una richiesta specifica.
x-ms-client-session-id

string

ID sessione client facoltativo. Il servizio registra questo valore. Consente al servizio di tracciare un gruppo di operazioni correlate tra i servizi e consente al cliente di contattare il supporto tecnico relativo a un determinato gruppo di richieste.

Corpo della richiesta

Nome Necessario Tipo Descrizione
searchString True

string

Stringa di ricerca di query corrispondente agli attributi delle istanze di serie temporali. Esempio: "floor 100". Deve essere presente senza distinzione tra maiuscole e minuscole, ma può essere una stringa vuota.
hierarchies

SearchInstancesHierarchiesParameters

Parametri di come restituire gerarchie di istanze di serie temporali. Se null, le gerarchie non vengono restituite. Se il parametro instances è null e il parametro delle gerarchie non è Null, vengono restituite solo gerarchie senza istanze.
instances

SearchInstancesParameters

Parametri di come restituire istanze di serie temporali. Può essere null. Quando entrambi i parametri delle istanze e delle gerarchie sono Null, le istanze vengono restituite nei risultati in base ai valori predefiniti dei parametri e le gerarchie non vengono restituite.
path

string[]

Filtrare in base al percorso gerarchia delle istanze di serie temporali. Il percorso è rappresentato come matrice di segmenti di percorso stringa. Il primo elemento deve essere il nome della gerarchia. Esempio: ["Location", "California"]. Facoltativo, con distinzione tra maiuscole e minuscole, mai vuoto e può essere Null.

Risposte

Nome Tipo Descrizione
200 OK

SearchInstancesResponsePage

Risposta di ricerca riuscita.

Headers

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

TsiError

Errore imprevisto.

Headers

x-ms-request-id: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

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

Definizioni

Nome Descrizione
HierarchiesExpandKind

Tipo di espansione dei nodi della gerarchia. Quando è impostato su "UntilChildren", i nodi della gerarchia vengono espansi in modo ricorsivo fino a quando non è presente più di un elemento figlio. Quando è impostata su "OneLevel", le gerarchie vengono espanse solo al parametro delle istanze di ricerca del percorso corrispondente a livello singolo. Facoltativo, il valore predefinito è "UntilChildren".
HierarchiesExpandParameter

Definizione di se espandere i nodi della gerarchia nella stessa chiamata alle istanze di ricerca.
HierarchiesSortBy

Valore da usare per l'ordinamento dei nodi della gerarchia. Quando è impostato su "CumulativeInstanceCount", le gerarchie restituite vengono ordinate in base alle istanze totali appartenenti al nodo della gerarchia e ai relativi nodi della gerarchia figlio. Quando è impostata su "Name", le gerarchie restituite vengono ordinate in base al nome della gerarchia. Facoltativo, il valore predefinito è "CumulativeInstanceCount".
HierarchiesSortParameter

Definizione dell'ordinamento dei nodi della gerarchia.
HierarchyHit

Nodo della gerarchia che contiene le istanze corrispondenti alla query in base all'input. Può essere vuoto o Null.
Highlights

Testo evidenziato dell'istanza della serie temporale da visualizzare all'utente. Evidenziazione degli inserimenti e dei tag nelle parti di testo corrispondenti alla stringa di ricerca. Non usare alcuna delle proprietà evidenziate per eseguire altre chiamate API.
InstanceHit

Istanza di serie temporale restituita dalla chiamata di ricerca delle istanze. L'istanza restituita corrisponde alla richiesta di ricerca e contiene il testo evidenziato da visualizzare all'utente se è impostato su "true".
InstancesSortBy

Valore da usare per l'ordinamento delle istanze della serie temporale prima di essere restituito dalla chiamata delle istanze di ricerca. Quando è impostato su "Rank", le istanze restituite vengono ordinate in base alla pertinenza. Quando è impostato su "DisplayName", i risultati restituiti vengono ordinati in base al nome visualizzato. Il nome visualizzato è il nome dell'istanza, se esistente. In caso contrario, il nome visualizzato è l'ID serie temporale. Il valore predefinito è 'Rank'.
InstancesSortParameter

Definizione della modalità di ordinamento delle istanze di serie temporali prima di essere restituite dalla chiamata delle istanze di ricerca.
SearchHierarchyNodesResponse

Nodi della gerarchia che contengono le istanze corrispondenti alla query in base all'input. Può essere vuoto o Null.
SearchInstancesHierarchiesParameters

Parametro di come restituire gerarchie di istanze di serie temporali in base alla chiamata delle istanze di ricerca.
SearchInstancesParameters

Parametri di come restituire istanze di serie temporali in base alla chiamata delle istanze di ricerca.
SearchInstancesRequest

Richiedere di eseguire una query di ricerca su istanze di serie temporali e restituire istanze di serie temporali corrispondenti.
SearchInstancesResponse

Istanze corrispondenti alla query in base all'input. Può essere vuoto o Null.
SearchInstancesResponsePage

Pagina singola dei risultati della ricerca.
TsiError

Informazioni su un errore dell'API.
TsiErrorBody

Errore dell'API specifico con un codice di errore e un messaggio.
TsiErrorDetails

Informazioni aggiuntive sull'errore.

HierarchiesExpandKind

Tipo di espansione dei nodi della gerarchia. Quando è impostato su "UntilChildren", i nodi della gerarchia vengono espansi in modo ricorsivo fino a quando non è presente più di un elemento figlio. Quando è impostata su "OneLevel", le gerarchie vengono espanse solo al parametro delle istanze di ricerca del percorso corrispondente a livello singolo. Facoltativo, il valore predefinito è "UntilChildren".

Nome Tipo Descrizione
OneLevel

string

UntilChildren

string

HierarchiesExpandParameter

Definizione di se espandere i nodi della gerarchia nella stessa chiamata alle istanze di ricerca.

Nome Tipo Descrizione
kind

HierarchiesExpandKind

Tipo di espansione dei nodi della gerarchia. Quando è impostato su "UntilChildren", i nodi della gerarchia vengono espansi in modo ricorsivo fino a quando non è presente più di un elemento figlio. Quando è impostata su "OneLevel", le gerarchie vengono espanse solo al parametro delle istanze di ricerca del percorso corrispondente a livello singolo. Facoltativo, il valore predefinito è "UntilChildren".

HierarchiesSortBy

Valore da usare per l'ordinamento dei nodi della gerarchia. Quando è impostato su "CumulativeInstanceCount", le gerarchie restituite vengono ordinate in base alle istanze totali appartenenti al nodo della gerarchia e ai relativi nodi della gerarchia figlio. Quando è impostata su "Name", le gerarchie restituite vengono ordinate in base al nome della gerarchia. Facoltativo, il valore predefinito è "CumulativeInstanceCount".

Nome Tipo Descrizione
CumulativeInstanceCount

string

Name

string

HierarchiesSortParameter

Definizione dell'ordinamento dei nodi della gerarchia.

Nome Tipo Descrizione
by

HierarchiesSortBy

Valore da usare per l'ordinamento dei nodi della gerarchia. Quando è impostato su "CumulativeInstanceCount", le gerarchie restituite vengono ordinate in base alle istanze totali appartenenti al nodo della gerarchia e ai relativi nodi della gerarchia figlio. Quando è impostata su "Name", le gerarchie restituite vengono ordinate in base al nome della gerarchia. Facoltativo, il valore predefinito è "CumulativeInstanceCount".

HierarchyHit

Nodo della gerarchia che contiene le istanze corrispondenti alla query in base all'input. Può essere vuoto o Null.

Nome Tipo Descrizione
cumulativeInstanceCount

integer

Numero totale di istanze appartenenti a questo nodo e sottoalberi corrispondenti alla query.
hierarchyNodes

SearchHierarchyNodesResponse

Nodi della gerarchia figlio di questo nodo. Può essere vuoto o Null.
name

string

Nome del nodo della gerarchia. Può essere vuoto, non può essere Null.

Highlights

Testo evidenziato dell'istanza della serie temporale da visualizzare all'utente. Evidenziazione degli inserimenti e dei tag nelle parti di testo corrispondenti alla stringa di ricerca. Non usare alcuna delle proprietà evidenziate per eseguire altre chiamate API.

Nome Tipo Descrizione
description

string

Descrizione evidenziata dell'istanza della serie temporale. Può essere Null.
hierarchyIds

string[]

Elenco degli ID gerarchia delle serie temporali evidenziate a cui appartiene l'istanza della serie temporale. Impossibile utilizzare per cercare gerarchie. Può essere Null.
hierarchyNames

string[]

Elenco dei nomi della gerarchia delle serie temporali evidenziate a cui appartiene l'istanza della serie temporale. Impossibile utilizzare per cercare gerarchie. Può essere Null.
instanceFieldNames

string[]

Elenco dei nomi dei campi dell'istanza delle serie temporali evidenziate. Può essere Null.
instanceFieldValues

string[]

Elenco dei valori di campo dell'istanza della serie temporale evidenziati. Può essere Null.
name

string

Nome evidenziato dell'istanza della serie temporale. Può essere Null.
timeSeriesId

string[]

Elenco dei valori stringa evidenziati dell'ID serie temporale da visualizzare. Non può essere usato per cercare l'istanza.
typeName

string

Nome del tipo di serie temporale evidenziato a cui appartiene questa istanza.

InstanceHit

Istanza di serie temporale restituita dalla chiamata di ricerca delle istanze. L'istanza restituita corrisponde alla richiesta di ricerca e contiene il testo evidenziato da visualizzare all'utente se è impostato su "true".

Nome Tipo Descrizione
hierarchyIds

string[]

Elenco di ID gerarchia di serie temporali a cui appartiene l'istanza della serie temporale corrispondente alla richiesta di ricerca. Impossibile utilizzare per cercare gerarchie. Può essere Null.
highlights

Highlights

Testo evidenziato dell'istanza della serie temporale da visualizzare all'utente. Evidenziazione degli inserimenti e dei tag nelle parti di testo corrispondenti alla stringa di ricerca. Non usare alcuna delle proprietà evidenziate per eseguire altre chiamate API.
name

string

Nome dell'istanza della serie temporale corrispondente alla richiesta di ricerca. Può essere Null.
timeSeriesId

TimeSeriesId[]

ID serie temporale dell'istanza della serie temporale corrispondente alla richiesta di ricerca.
typeId

string

Rappresenta il tipo a cui appartiene l'istanza della serie temporale a cui appartiene la richiesta di ricerca. Mai null.

InstancesSortBy

Valore da usare per l'ordinamento delle istanze della serie temporale prima di essere restituito dalla chiamata delle istanze di ricerca. Quando è impostato su "Rank", le istanze restituite vengono ordinate in base alla pertinenza. Quando è impostato su "DisplayName", i risultati restituiti vengono ordinati in base al nome visualizzato. Il nome visualizzato è il nome dell'istanza, se esistente. In caso contrario, il nome visualizzato è l'ID serie temporale. Il valore predefinito è 'Rank'.

Nome Tipo Descrizione
DisplayName

string

Rank

string

InstancesSortParameter

Definizione della modalità di ordinamento delle istanze di serie temporali prima di essere restituite dalla chiamata delle istanze di ricerca.

Nome Tipo Descrizione
by

InstancesSortBy

Valore da usare per l'ordinamento delle istanze della serie temporale prima di essere restituito dalla chiamata delle istanze di ricerca. Quando è impostato su "Rank", le istanze restituite vengono ordinate in base alla pertinenza. Quando è impostato su "DisplayName", i risultati restituiti vengono ordinati in base al nome visualizzato. Il nome visualizzato è il nome dell'istanza, se esistente. In caso contrario, il nome visualizzato è l'ID serie temporale. Il valore predefinito è 'Rank'.

SearchHierarchyNodesResponse

Nodi della gerarchia che contengono le istanze corrispondenti alla query in base all'input. Può essere vuoto o Null.

Nome Tipo Descrizione
continuationToken

string

Se restituito, significa che i risultati correnti rappresentano un risultato parziale. Il token di continuazione consente di ottenere la pagina successiva dei risultati. Per ottenere la pagina successiva dei risultati della query, inviare la stessa richiesta con il parametro del token di continuazione nell'intestazione HTTP "x-ms-continuation".
hitCount

integer

Numero totale di nodi della gerarchia che contiene le istanze corrispondenti alla query in base all'input.
hits

HierarchyHit[]

Elenco di nodi della gerarchia che contiene le istanze corrispondenti alla query in base all'input. Può essere vuoto.

SearchInstancesHierarchiesParameters

Parametro di come restituire gerarchie di istanze di serie temporali in base alla chiamata delle istanze di ricerca.

Nome Tipo Descrizione
expand

HierarchiesExpandParameter

Definizione di se espandere i nodi della gerarchia nella stessa chiamata alle istanze di ricerca. Facoltativo, il valore predefinito è "UntilChildren".
pageSize

integer

Numero massimo di gerarchie nello stesso livello da restituire nella stessa pagina. Facoltativo, il valore predefinito è 10 se non impostato. L'intervallo è compreso tra 1 e 100. Se sono presenti risultati oltre le dimensioni della pagina, è possibile usare il token di continuazione per recuperare la pagina successiva.
sort

HierarchiesSortParameter

Definizione dell'ordinamento dei nodi della gerarchia. Facoltativo, il valore predefinito è "CumulativeInstanceCount".

SearchInstancesParameters

Parametri di come restituire istanze di serie temporali in base alla chiamata delle istanze di ricerca.

Nome Tipo Descrizione
highlights

boolean

Definizione dei risultati della ricerca evidenziati o meno. Quando è impostato su "true", vengono restituiti i risultati della ricerca evidenziati. Quando è impostata su "false", i risultati della ricerca evidenziati non vengono restituiti. Il valore predefinito è 'true'.
pageSize

integer

Numero massimo di istanze previste in ogni pagina del risultato. Il valore predefinito è 10 se non impostato. È compreso tra 1 e 100. Se sono presenti risultati oltre le dimensioni della pagina, l'utente può usare il token di continuazione per recuperare la pagina successiva.
recursive

boolean

Definizione delle istanze restituite. Quando la ricorsiva è impostata su "true", vengono restituite tutte le istanze che hanno il percorso che inizia con il percorso del parametro path. Quando la ricorsiva è impostata su 'false', vengono restituite solo le istanze con il percorso che corrisponde esattamente al parametro path. L'uso della ricerca ricorsiva consente di implementare l'esperienza utente di ricerca, mentre l'uso della ricerca non ricorsiva consente di implementare l'esperienza di spostamento. Facoltativo, il valore predefinito è "true".
sort

InstancesSortParameter

Definizione del modo in cui le istanze delle serie temporali vengono ordinate prima di essere restituite dalla chiamata delle istanze di ricerca: pertinenza o alfabetica. Facoltativo, il valore predefinito è "Rank".

SearchInstancesRequest

Richiedere di eseguire una query di ricerca su istanze di serie temporali e restituire istanze di serie temporali corrispondenti.

Nome Tipo Descrizione
hierarchies

SearchInstancesHierarchiesParameters

Parametri di come restituire gerarchie di istanze di serie temporali. Se null, le gerarchie non vengono restituite. Se il parametro instances è null e il parametro delle gerarchie non è Null, vengono restituite solo gerarchie senza istanze.
instances

SearchInstancesParameters

Parametri di come restituire istanze di serie temporali. Può essere null. Quando entrambi i parametri delle istanze e delle gerarchie sono Null, le istanze vengono restituite nei risultati in base ai valori predefiniti dei parametri e le gerarchie non vengono restituite.
path

string[]

Filtrare in base al percorso gerarchia delle istanze di serie temporali. Il percorso è rappresentato come matrice di segmenti di percorso stringa. Il primo elemento deve essere il nome della gerarchia. Esempio: ["Location", "California"]. Facoltativo, con distinzione tra maiuscole e minuscole, mai vuoto e può essere Null.
searchString

string

Stringa di ricerca di query corrispondente agli attributi delle istanze di serie temporali. Esempio: "floor 100". Deve essere presente senza distinzione tra maiuscole e minuscole, ma può essere una stringa vuota.

SearchInstancesResponse

Istanze corrispondenti alla query in base all'input. Può essere vuoto o Null.

Nome Tipo Descrizione
continuationToken

string

Se restituito, significa che i risultati correnti rappresentano un risultato parziale. Il token di continuazione consente di ottenere la pagina successiva dei risultati. Per ottenere la pagina successiva dei risultati della query, inviare la stessa richiesta con il parametro del token di continuazione nell'intestazione HTTP "x-ms-continuation".
hitCount

integer

Numero totale di istanze corrispondenti alla query in base all'input.
hits

InstanceHit[]

Elenco di istanze corrispondenti alla query in base all'input. Può essere vuoto.

SearchInstancesResponsePage

Pagina singola dei risultati della ricerca.

Nome Tipo Descrizione
hierarchyNodes

SearchHierarchyNodesResponse

Nodi della gerarchia che contengono le istanze corrispondenti alla query in base all'input. Può essere vuoto o Null.
instances

SearchInstancesResponse

Istanze corrispondenti alla query in base all'input. Può essere vuoto o Null.

TsiError

Informazioni su un errore dell'API.

Nome Tipo Descrizione
error

TsiErrorBody

Errore dell'API specifico con un codice di errore e un messaggio.

TsiErrorBody

Errore dell'API specifico con un codice di errore e un messaggio.

Nome Tipo Descrizione
code

string

Stringa leggibile indipendente dal linguaggio che definisce un codice di errore specifico del servizio. Questo codice funge da indicatore più specifico per il codice di errore HTTP specificato nella risposta. Può essere usato per gestire casi di errore specifici a livello di codice.
details

TsiErrorDetails[]

Contiene informazioni aggiuntive sull'errore. Può essere Null.
innerError

TsiErrorBody

Contiene un errore più specifico che restringe la causa. Può essere Null.
message

string

Rappresentazione indipendente dal linguaggio e leggibile dell'errore. È destinato agli sviluppatori e non è adatto per l'esposizione agli utenti finali.
target

string

Destinazione dell'errore specifico, ad esempio il nome della proprietà in errore. Può essere Null.

TsiErrorDetails

Informazioni aggiuntive sull'errore.

Nome Tipo Descrizione
code

string

Stringa leggibile indipendente dal linguaggio che definisce un codice di errore specifico del servizio. Questo codice funge da indicatore più specifico per il codice di errore HTTP specificato nella risposta. Può essere usato per gestire casi di errore specifici a livello di codice.
message

string

Rappresentazione indipendente dal linguaggio e leggibile dell'errore. È destinato agli sviluppatori e non è adatto per l'esposizione agli utenti finali.