Time Series Instances - Search
Lista parcial de acessos na pesquisa de instâncias de série temporal com base em atributos de instância.
POST https://{environmentFqdn}/timeseries/instances/search?api-version=2020-07-31
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
environment
|
path | True |
string |
FQDN por ambiente, por exemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Pode obter este nome de domínio a partir da resposta da API Obter Ambientes, portal do Azure ou Resource Manager do Azure. |
api-version
|
query | True |
string |
Versão da API a utilizar com o pedido de cliente. A versão atualmente suportada é "2020-07-31". |
Cabeçalho do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
x-ms-continuation |
string |
Token de continuação da página anterior dos resultados para obter a página seguinte dos resultados em chamadas que suportam a paginação. Para obter os resultados da primeira página, especifique o token de continuação nulo como valor de parâmetro. O token de continuação devolvido é nulo se todos os resultados tiverem sido devolvidos e não existir uma próxima página de resultados. |
|
x-ms-client-request-id |
string |
ID de pedido de cliente opcional. O serviço regista este valor. Permite que o serviço rastreia a operação entre serviços e permite que o cliente contacte o suporte relativamente a um pedido específico. |
|
x-ms-client-session-id |
string |
ID de sessão de cliente opcional. O serviço regista este valor. Permite que o serviço rastreia um grupo de operações relacionadas entre serviços e permite que o cliente contacte o suporte relativamente a um grupo específico de pedidos. |
Corpo do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
searchString | True |
string |
Cadeia de pesquisa de consulta que será correspondida aos atributos das instâncias de série temporal. Exemplo: "piso 100". Não sensível a maiúsculas e minúsculas, tem de estar presente, mas pode ser uma cadeia vazia. |
hierarchies |
Parâmetros de como devolver hierarquias de instâncias de série temporal. Se for nulo, as hierarquias não serão devolvidas. Se o parâmetro de instâncias for nulo e o parâmetro de hierarquias não for nulo, apenas são devolvidas hierarquias sem instâncias. |
||
instances |
Parâmetros de como devolver instâncias de série temporal. Pode ser nulo. Quando os parâmetros de instâncias e hierarquias são nulos, as instâncias são devolvidas nos resultados com base nos valores predefinidos dos parâmetros e as hierarquias não são devolvidas. |
||
path |
string[] |
Filtrar no caminho da hierarquia de instâncias de série temporal. O caminho é representado como matriz de segmentos de caminho de cadeia. O primeiro elemento deve ser o nome da hierarquia. Exemplo: ["Localização", "Califórnia"]. Opcional, sensível a maiúsculas e minúsculas, nunca vazio e pode ser nulo. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Resposta de pesquisa bem-sucedida. Cabeçalhos x-ms-request-id: string |
|
Other Status Codes |
Erro inesperado. Cabeçalhos x-ms-request-id: string |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
SearchInstancesDefault
Pedido de amostra
POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31
{
"searchString": "floor 100"
}
Resposta da amostra
{
"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
Pedido de amostra
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
}
}
Resposta da amostra
{
"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
Pedido de amostra
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
}
}
Resposta da amostra
{
"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
Pedido de amostra
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
}
}
Resposta da amostra
{
"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
Pedido de amostra
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
}
}
Resposta da amostra
{
"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
Pedido de amostra
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
}
}
Resposta da amostra
{
"instances": {
"hits": [],
"hitCount": 0,
"continuationToken": null
},
"hierarchyNodes": {
"hits": [
{
"name": "Location",
"cumulativeInstanceCount": 2,
"hierarchyNodes": null
}
],
"hitCount": 1,
"continuationToken": null
}
}
SearchInstancesRecursive
Pedido de amostra
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
}
Resposta da amostra
{
"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
Pedido de amostra
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
}
}
Resposta da amostra
{
"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
}
}
Definições
Name | Description |
---|---|
Hierarchies |
Tipo de expansão de nós de hierarquia. Quando está definido como "UntilChildren", os nós da hierarquia são expandidos recursivamente até que exista mais do que um subordinado. Quando está definido como "OneLevel", as hierarquias são expandidas apenas no parâmetro de instâncias de pesquisa de caminho correspondente de nível único. Opcional, a predefinição é "UntilChildren". |
Hierarchies |
Definição de expansão de nós de hierarquia na mesma chamada de instâncias de pesquisa. |
Hierarchies |
Valor a utilizar para ordenação de nós de hierarquia. Quando está definido como "CumulativeInstanceCount", as hierarquias devolvidas são ordenadas com base no total de instâncias pertencentes ao nó de hierarquia e aos nós da hierarquia subordinada. Quando está definido como "Nome", as hierarquias devolvidas são ordenadas com base no nome da hierarquia. Opcional, a predefinição é "CumulativeInstanceCount". |
Hierarchies |
Definição de ordenação de nós de hierarquia. |
Hierarchy |
O nó de hierarquia que contém as instâncias que correspondem à consulta com base na entrada. Pode estar vazio ou nulo. |
Highlights |
Texto realçado da instância de série temporal a apresentar ao utilizador. Realçar inserções e etiquetas nas partes do texto que correspondem à cadeia de pesquisa. Não utilize nenhuma das propriedades realçadas para efetuar mais chamadas à API. |
Instance |
Instância de série temporal devolvida pela chamada de pesquisa de instâncias. A instância devolvida correspondeu ao pedido de pesquisa e contém texto realçado para ser apresentado ao utilizador se estiver definido como "verdadeiro". |
Instances |
Valor a utilizar para ordenar as instâncias de série temporal antes de ser devolvido pela chamada de instâncias de pesquisa. Quando está definido como "Classificação", as instâncias devolvidas são ordenadas com base na relevância. Quando está definido como "DisplayName", os resultados devolvidos são ordenados com base no nome a apresentar. O nome a apresentar é o nome da instância, caso contrário, o nome a apresentar é o ID da série temporal. A predefinição é "Classificação". |
Instances |
Definição de como as instâncias de série temporal são ordenadas antes de serem devolvidas pela chamada de instâncias de pesquisa. |
Search |
Os nós de hierarquia que contêm as instâncias que correspondem à consulta com base na entrada. Pode estar vazio ou nulo. |
Search |
Parâmetro de como devolver hierarquias de instâncias de série temporal por chamada de instâncias de pesquisa. |
Search |
Parâmetros de como devolver instâncias de série temporal por chamada de instâncias de pesquisa. |
Search |
Pedido para executar uma consulta de pesquisa em instâncias de série temporal e devolver instâncias de série temporal correspondentes. |
Search |
As instâncias que correspondem à consulta com base na entrada. Pode estar vazio ou nulo. |
Search |
Página única dos resultados da pesquisa. |
Tsi |
Informações sobre um erro de API. |
Tsi |
Um erro específico da API com um código de erro e uma mensagem. |
Tsi |
Informações de erro adicionais. |
HierarchiesExpandKind
Tipo de expansão de nós de hierarquia. Quando está definido como "UntilChildren", os nós da hierarquia são expandidos recursivamente até que exista mais do que um subordinado. Quando está definido como "OneLevel", as hierarquias são expandidas apenas no parâmetro de instâncias de pesquisa de caminho correspondente de nível único. Opcional, a predefinição é "UntilChildren".
Name | Tipo | Description |
---|---|---|
OneLevel |
string |
|
UntilChildren |
string |
HierarchiesExpandParameter
Definição de expansão de nós de hierarquia na mesma chamada de instâncias de pesquisa.
Name | Tipo | Description |
---|---|---|
kind |
Tipo de expansão de nós de hierarquia. Quando está definido como "UntilChildren", os nós da hierarquia são expandidos recursivamente até que exista mais do que um subordinado. Quando está definido como "OneLevel", as hierarquias são expandidas apenas no parâmetro de instâncias de pesquisa de caminho correspondente de nível único. Opcional, a predefinição é "UntilChildren". |
HierarchiesSortBy
Valor a utilizar para ordenação de nós de hierarquia. Quando está definido como "CumulativeInstanceCount", as hierarquias devolvidas são ordenadas com base no total de instâncias pertencentes ao nó de hierarquia e aos nós da hierarquia subordinada. Quando está definido como "Nome", as hierarquias devolvidas são ordenadas com base no nome da hierarquia. Opcional, a predefinição é "CumulativeInstanceCount".
Name | Tipo | Description |
---|---|---|
CumulativeInstanceCount |
string |
|
Name |
string |
HierarchiesSortParameter
Definição de ordenação de nós de hierarquia.
Name | Tipo | Description |
---|---|---|
by |
Valor a utilizar para ordenação de nós de hierarquia. Quando está definido como "CumulativeInstanceCount", as hierarquias devolvidas são ordenadas com base no total de instâncias pertencentes ao nó de hierarquia e aos nós da hierarquia subordinada. Quando está definido como "Nome", as hierarquias devolvidas são ordenadas com base no nome da hierarquia. Opcional, a predefinição é "CumulativeInstanceCount". |
HierarchyHit
O nó de hierarquia que contém as instâncias que correspondem à consulta com base na entrada. Pode estar vazio ou nulo.
Name | Tipo | Description |
---|---|---|
cumulativeInstanceCount |
integer |
Número total de instâncias que pertencem a este nó e são subárvores correspondentes à consulta. |
hierarchyNodes |
Nós da hierarquia subordinada deste nó. Pode estar vazio ou nulo. |
|
name |
string |
Nome do nó de hierarquia. Pode estar vazio, não pode ser nulo. |
Highlights
Texto realçado da instância de série temporal a apresentar ao utilizador. Realçar inserções e etiquetas nas partes do texto que correspondem à cadeia de pesquisa. Não utilize nenhuma das propriedades realçadas para efetuar mais chamadas à API.
Name | Tipo | Description |
---|---|---|
description |
string |
Descrição realçada da instância de série temporal. Pode ser nulo. |
hierarchyIds |
string[] |
Lista de IDs de hierarquia de série temporal realçados aos quais pertence a instância de série temporal. Não pode ser utilizado para procurar hierarquias. Pode ser nulo. |
hierarchyNames |
string[] |
Lista de nomes de hierarquia de série temporal realçados aos quais pertence a instância de série temporal. Não pode ser utilizado para procurar hierarquias. Pode ser nulo. |
instanceFieldNames |
string[] |
Lista de nomes de campos de instância de série temporal realçados. Pode ser nulo. |
instanceFieldValues |
string[] |
Lista de valores de campo de instância de série temporal realçados. Pode ser nulo. |
name |
string |
Nome realçado da instância de série temporal. Pode ser nulo. |
timeSeriesId |
string[] |
Lista de valores de cadeia realçados do ID da Série Temporal para apresentação. Não é possível utilizar a instância de pesquisa. |
typeName |
string |
Nome do tipo de série temporal realçado ao qual esta instância pertence. |
InstanceHit
Instância de série temporal devolvida pela chamada de pesquisa de instâncias. A instância devolvida correspondeu ao pedido de pesquisa e contém texto realçado para ser apresentado ao utilizador se estiver definido como "verdadeiro".
Name | Tipo | Description |
---|---|---|
hierarchyIds |
string[] |
Lista de IDs de hierarquia de série temporal a que pertence a instância de série temporal que corresponde ao pedido de pesquisa. Não pode ser utilizado para procurar hierarquias. Pode ser nulo. |
highlights |
Texto realçado da instância de série temporal a apresentar ao utilizador. Realçar inserções e etiquetas nas partes do texto que correspondem à cadeia de pesquisa. Não utilize nenhuma das propriedades realçadas para efetuar mais chamadas à API. |
|
name |
string |
Nome da instância de série temporal que correspondeu ao pedido de pesquisa. Pode ser nulo. |
timeSeriesId |
Time |
ID da série temporal da instância de série temporal que correspondeu ao pedido de pesquisa. |
typeId |
string |
Representa o tipo a que a instância de série temporal que corresponde ao pedido de pesquisa pertence. Nunca nulo. |
InstancesSortBy
Valor a utilizar para ordenar as instâncias de série temporal antes de ser devolvido pela chamada de instâncias de pesquisa. Quando está definido como "Classificação", as instâncias devolvidas são ordenadas com base na relevância. Quando está definido como "DisplayName", os resultados devolvidos são ordenados com base no nome a apresentar. O nome a apresentar é o nome da instância, caso contrário, o nome a apresentar é o ID da série temporal. A predefinição é "Classificação".
Name | Tipo | Description |
---|---|---|
DisplayName |
string |
|
Rank |
string |
InstancesSortParameter
Definição de como as instâncias de série temporal são ordenadas antes de serem devolvidas pela chamada de instâncias de pesquisa.
Name | Tipo | Description |
---|---|---|
by |
Valor a utilizar para ordenar as instâncias de série temporal antes de ser devolvido pela chamada de instâncias de pesquisa. Quando está definido como "Classificação", as instâncias devolvidas são ordenadas com base na relevância. Quando está definido como "DisplayName", os resultados devolvidos são ordenados com base no nome a apresentar. O nome a apresentar é o nome da instância, caso contrário, o nome a apresentar é o ID da série temporal. A predefinição é "Classificação". |
SearchHierarchyNodesResponse
Os nós de hierarquia que contêm as instâncias que correspondem à consulta com base na entrada. Pode estar vazio ou nulo.
Name | Tipo | Description |
---|---|---|
continuationToken |
string |
Se for devolvido, significa que os resultados atuais representam um resultado parcial. O token de continuação permite obter a página seguinte dos resultados. Para obter a página seguinte dos resultados da consulta, envie o mesmo pedido com o parâmetro do token de continuação no cabeçalho HTTP "x-ms-continuation". |
hitCount |
integer |
Número total de nós de hierarquia que contém as instâncias que correspondem à consulta com base na entrada. |
hits |
A lista de nós de hierarquia que contém as instâncias que correspondem à consulta com base na entrada. Pode estar vazio. |
SearchInstancesHierarchiesParameters
Parâmetro de como devolver hierarquias de instâncias de série temporal por chamada de instâncias de pesquisa.
Name | Tipo | Description |
---|---|---|
expand |
Definição de expansão de nós de hierarquia na mesma chamada de instâncias de pesquisa. Opcional, a predefinição é "UntilChildren". |
|
pageSize |
integer |
Número máximo de hierarquias no mesmo nível a devolver na mesma página. Opcional, a predefinição é 10 quando não está definida. O intervalo é de 1 a 100. Se existirem resultados para além do tamanho da página, o token de continuação pode ser utilizado para obter a página seguinte. |
sort |
Definição de ordenação de nós de hierarquia. Opcional, a predefinição é "CumulativeInstanceCount". |
SearchInstancesParameters
Parâmetros de como devolver instâncias de série temporal por chamada de instâncias de pesquisa.
Name | Tipo | Description |
---|---|---|
highlights |
boolean |
Definição de resultados de pesquisa realçados ou não. Quando está definido como "verdadeiro", os resultados de pesquisa realçados são devolvidos. Quando está definido como "falso", os resultados de pesquisa realçados não são devolvidos. A predefinição é "true". |
pageSize |
integer |
Número máximo de instâncias esperadas em cada página do resultado. A predefinição é 10 quando não está definida. Varia entre 1 e 100. Se existirem resultados para além do tamanho da página, o utilizador pode utilizar o token de continuação para obter a página seguinte. |
recursive |
boolean |
Definição das instâncias que são devolvidas. Quando recursivo está definido como "verdadeiro", todas as instâncias que têm o caminho que começa com o caminho o parâmetro path são devolvidas. Quando o recursivo está definido como "falso", só são devolvidas as instâncias que têm o caminho que corresponde exatamente ao parâmetro path. A utilização da pesquisa recursiva permite implementar a experiência de utilizador de pesquisa, ao mesmo tempo que a utilização de pesquisas não recursivas permite implementar a experiência de navegação. Opcional, a predefinição é "true". |
sort |
Definição de como as instâncias de série temporal são ordenadas antes de serem devolvidas por chamadas de instâncias de pesquisa - relevância ou alfabética. Opcional, a predefinição é "Classificação". |
SearchInstancesRequest
Pedido para executar uma consulta de pesquisa em instâncias de série temporal e devolver instâncias de série temporal correspondentes.
Name | Tipo | Description |
---|---|---|
hierarchies |
Parâmetros de como devolver hierarquias de instâncias de série temporal. Se for nulo, as hierarquias não serão devolvidas. Se o parâmetro de instâncias for nulo e o parâmetro de hierarquias não for nulo, apenas são devolvidas hierarquias sem instâncias. |
|
instances |
Parâmetros de como devolver instâncias de série temporal. Pode ser nulo. Quando os parâmetros de instâncias e hierarquias são nulos, as instâncias são devolvidas nos resultados com base nos valores predefinidos dos parâmetros e as hierarquias não são devolvidas. |
|
path |
string[] |
Filtrar no caminho da hierarquia de instâncias de série temporal. O caminho é representado como matriz de segmentos de caminho de cadeia. O primeiro elemento deve ser o nome da hierarquia. Exemplo: ["Localização", "Califórnia"]. Opcional, sensível a maiúsculas e minúsculas, nunca vazio e pode ser nulo. |
searchString |
string |
Cadeia de pesquisa de consulta que será correspondida aos atributos das instâncias de série temporal. Exemplo: "piso 100". Não sensível a maiúsculas e minúsculas, tem de estar presente, mas pode ser uma cadeia vazia. |
SearchInstancesResponse
As instâncias que correspondem à consulta com base na entrada. Pode estar vazio ou nulo.
Name | Tipo | Description |
---|---|---|
continuationToken |
string |
Se for devolvido, significa que os resultados atuais representam um resultado parcial. O token de continuação permite obter a página seguinte dos resultados. Para obter a página seguinte dos resultados da consulta, envie o mesmo pedido com o parâmetro do token de continuação no cabeçalho HTTP "x-ms-continuation". |
hitCount |
integer |
Número total de instâncias que correspondem à consulta com base na entrada. |
hits |
A lista de instâncias que correspondem à consulta com base na entrada. Pode estar vazio. |
SearchInstancesResponsePage
Página única dos resultados da pesquisa.
Name | Tipo | Description |
---|---|---|
hierarchyNodes |
Os nós de hierarquia que contêm as instâncias que correspondem à consulta com base na entrada. Pode estar vazio ou nulo. |
|
instances |
As instâncias que correspondem à consulta com base na entrada. Pode estar vazio ou nulo. |
TsiError
Informações sobre um erro de API.
Name | Tipo | Description |
---|---|---|
error |
Um erro específico da API com um código de erro e uma mensagem. |
TsiErrorBody
Um erro específico da API com um código de erro e uma mensagem.
Name | Tipo | Description |
---|---|---|
code |
string |
Cadeia de carateres independente de linguagem e legível por humanos que define um código de erro específico do serviço. Este código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser utilizado para processar programaticamente casos de erro específicos. |
details |
Contém informações de erro adicionais. Pode ser nulo. |
|
innerError |
Contém um erro mais específico que restringe a causa. Pode ser nulo. |
|
message |
string |
Representação do erro legível por humanos e independente da linguagem. Destina-se a ajudar os programadores e não é adequado para exposição aos utilizadores finais. |
target |
string |
Destino do erro específico (por exemplo, o nome da propriedade em erro). Pode ser nulo. |
TsiErrorDetails
Informações de erro adicionais.
Name | Tipo | Description |
---|---|---|
code |
string |
Cadeia de carateres independente de linguagem e legível por humanos que define um código de erro específico do serviço. Este código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser utilizado para processar programaticamente casos de erro específicos. |
message |
string |
Representação do erro legível por humanos e independente da linguagem. Destina-se a ajudar os programadores e não é adequado para exposição aos utilizadores finais. |