Compartilhar via

Time Series Instances - Search

  • Referência
Service:
Time Series Insights
API Version:
2020-07-31

Lista parcial de ocorrências 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 de URI

Nome Em Obrigatório Tipo Description
environmentFqdn
 path True

string

Por FQDN de ambiente, por exemplo, 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Você pode obter esse nome de domínio da resposta da API Obter Ambientes, portal do Azure ou Resource Manager do Azure.
api-version
 query True

string

Versão da API a ser usada com a solicitação do cliente. A versão atualmente com suporte é "2020-07-31".

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-continuation

string

Token de continuação da página anterior de resultados para recuperar a próxima página dos resultados em chamadas que dão suporte à paginação. Para obter os resultados da primeira página, especifique o token de continuação nula como valor de parâmetro. O token de continuação retornado será nulo se todos os resultados tiverem sido retornados e não houver nenhuma próxima página de resultados.
x-ms-client-request-id

string

ID de solicitação de cliente opcional. O serviço registra esse valor. Permite que o serviço rastreie a operação entre serviços e permite que o cliente entre em contato com o suporte em relação a uma solicitação específica.
x-ms-client-session-id

string

ID de sessão do cliente opcional. O serviço registra esse valor. Permite que o serviço rastreie um grupo de operações relacionadas entre serviços e permite que o cliente entre em contato com o suporte em relação a um grupo específico de solicitações.

Corpo da solicitação

Nome Obrigatório Tipo Description
searchString True

string

Cadeia de caracteres de pesquisa de consulta que será correspondida aos atributos de instâncias de série temporal. Exemplo: "andar 100". Não diferencia maiúsculas de minúsculas, deve estar presente, mas pode ser uma cadeia de caracteres vazia.
hierarchies

SearchInstancesHierarchiesParameters

Parâmetros de como retornar hierarquias de instância de série temporal. Se for nulo, as hierarquias não serão retornadas. Se o parâmetro instances for nulo e o parâmetro hierarchies não for nulo, somente hierarquias sem instâncias serão retornadas.
instances

SearchInstancesParameters

Parâmetros de como retornar 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 retornadas nos resultados com base nos valores padrão dos parâmetros e as hierarquias não são retornadas.
path

string[]

Filtre o caminho da hierarquia de instâncias de série temporal. Path é representado como matriz de segmentos de caminho de cadeia de caracteres. O primeiro elemento deve ser o nome da hierarquia. Exemplo: ["Location", "California"]. Opcional, diferencia maiúsculas de minúsculas, nunca vazio e pode ser nulo.

Respostas

Nome Tipo Description
200 OK

SearchInstancesResponsePage

Resposta de pesquisa bem-sucedida.

Headers

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

TsiError

Erro inesperado.

Headers

x-ms-request-id: string

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

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

Definições

Nome Description
HierarchiesExpandKind

Tipo de expansão de nós de hierarquia. Quando é definido como 'UntilChildren', os nós de hierarquia são expandidos recursivamente até que haja mais de um filho. Quando ele é definido como 'OneLevel', as hierarquias são expandidas somente no parâmetro de instâncias de pesquisa de caminho correspondente de nível único. Opcional, o padrão é 'UntilChildren'.
HierarchiesExpandParameter

Definição de se os nós de hierarquia devem ser expandidos na mesma chamada de instâncias de pesquisa.
HierarchiesSortBy

Valor a ser usado para classificação de nó de hierarquia. Quando ele é definido como 'CumulativeInstanceCount', as hierarquias retornadas são classificadas com base no total de instâncias pertencentes ao nó de hierarquia e seus nós de hierarquia filho. Quando ele é definido como 'Name', as hierarquias retornadas são classificadas com base no nome da hierarquia. Opcional, o padrão é 'CumulativeInstanceCount'.
HierarchiesSortParameter

Definição de classificação de nós de hierarquia.
HierarchyHit

O nó de hierarquia que contém as instâncias que correspondem à consulta com base na entrada. Pode ser vazio ou nulo.
Highlights

Texto realçado da instância de série temporal a ser exibido para o usuário. Realçando inserções e marcas nas partes do texto que corresponderam à cadeia de caracteres de pesquisa. Não use nenhuma das propriedades realçadas para fazer mais chamadas à API.
InstanceHit

Instância de série temporal retornada pela chamada de pesquisa de instâncias. A instância retornada correspondeu à solicitação de pesquisa e contém o texto realçado a ser exibido para o usuário se ela estiver definida como "true".
InstancesSortBy

Valor a ser usado para classificar as instâncias de série temporal antes de serem retornadas pela chamada de instâncias de pesquisa. Quando ele é definido como 'Rank', as instâncias retornadas são classificadas com base na relevância. Quando ele é definido como 'DisplayName', os resultados retornados são classificados com base no nome de exibição. Nome de exibição será o nome da instância se ela existir; caso contrário, o nome de exibição será a ID da série temporal. O padrão é 'Rank'.
InstancesSortParameter

Definição de como as instâncias de série temporal são classificadas antes de serem retornadas pela chamada de instâncias de pesquisa.
SearchHierarchyNodesResponse

Os nós de hierarquia que contém as instâncias correspondentes à consulta com base na entrada. Pode ser vazio ou nulo.
SearchInstancesHierarchiesParameters

Parâmetro de como retornar hierarquias de instância de série temporal por chamada de instâncias de pesquisa.
SearchInstancesParameters

Parâmetros de como retornar instâncias de série temporal por chamada de instâncias de pesquisa.
SearchInstancesRequest

Solicitação para executar uma consulta de pesquisa em instâncias de série temporal e retornar instâncias de série temporal correspondentes.
SearchInstancesResponse

As instâncias que correspondem à consulta com base na entrada. Pode ser vazio ou nulo.
SearchInstancesResponsePage

Página única dos resultados da pesquisa.
TsiError

Informações sobre um erro de API.
TsiErrorBody

Um erro de API específico com um código de erro e uma mensagem.
TsiErrorDetails

Informações adicionais de erro.

HierarchiesExpandKind

Tipo de expansão de nós de hierarquia. Quando é definido como 'UntilChildren', os nós de hierarquia são expandidos recursivamente até que haja mais de um filho. Quando ele é definido como 'OneLevel', as hierarquias são expandidas somente no parâmetro de instâncias de pesquisa de caminho correspondente de nível único. Opcional, o padrão é 'UntilChildren'.

Nome Tipo Description
OneLevel

string

UntilChildren

string

HierarchiesExpandParameter

Definição de se os nós de hierarquia devem ser expandidos na mesma chamada de instâncias de pesquisa.

Nome Tipo Description
kind

HierarchiesExpandKind

Tipo de expansão de nós de hierarquia. Quando é definido como 'UntilChildren', os nós de hierarquia são expandidos recursivamente até que haja mais de um filho. Quando ele é definido como 'OneLevel', as hierarquias são expandidas somente no parâmetro de instâncias de pesquisa de caminho correspondente de nível único. Opcional, o padrão é 'UntilChildren'.

HierarchiesSortBy

Valor a ser usado para classificação de nó de hierarquia. Quando ele é definido como 'CumulativeInstanceCount', as hierarquias retornadas são classificadas com base no total de instâncias pertencentes ao nó de hierarquia e seus nós de hierarquia filho. Quando ele é definido como 'Name', as hierarquias retornadas são classificadas com base no nome da hierarquia. Opcional, o padrão é 'CumulativeInstanceCount'.

Nome Tipo Description
CumulativeInstanceCount

string

Name

string

HierarchiesSortParameter

Definição de classificação de nós de hierarquia.

Nome Tipo Description
by

HierarchiesSortBy

Valor a ser usado para classificação de nó de hierarquia. Quando ele é definido como 'CumulativeInstanceCount', as hierarquias retornadas são classificadas com base no total de instâncias pertencentes ao nó de hierarquia e seus nós de hierarquia filho. Quando ele é definido como 'Name', as hierarquias retornadas são classificadas com base no nome da hierarquia. Opcional, o padrão é 'CumulativeInstanceCount'.

HierarchyHit

O nó de hierarquia que contém as instâncias que correspondem à consulta com base na entrada. Pode ser vazio ou nulo.

Nome Tipo Description
cumulativeInstanceCount

integer

Número total de instâncias que pertencem a esse nó e suas subárvores correspondem à consulta.
hierarchyNodes

SearchHierarchyNodesResponse

Nós de hierarquia filho desse nó. Pode ser 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 ser exibido para o usuário. Realçando inserções e marcas nas partes do texto que corresponderam à cadeia de caracteres de pesquisa. Não use nenhuma das propriedades realçadas para fazer mais chamadas à API.

Nome 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çadas às quais a instância de série temporal pertence. Não pode ser usado para pesquisar hierarquias. Pode ser nulo.
hierarchyNames

string[]

Lista de nomes de hierarquia de série temporal realçados aos quais a instância de série temporal pertence. Não pode ser usado para pesquisar hierarquias. Pode ser nulo.
instanceFieldNames

string[]

Lista de nomes de campo 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 de caracteres realçados da ID da Série Temporal para exibição. Não pode ser usado para pesquisar a instância.
typeName

string

Nome do tipo de série temporal realçado ao qual essa instância pertence.

InstanceHit

Instância de série temporal retornada pela chamada de pesquisa de instâncias. A instância retornada correspondeu à solicitação de pesquisa e contém o texto realçado a ser exibido para o usuário se ela estiver definida como "true".

Nome Tipo Description
hierarchyIds

string[]

Lista de IDs de hierarquia de série temporal à qual a instância de série temporal que correspondeu à solicitação de pesquisa pertence. Não pode ser usado para pesquisar hierarquias. Pode ser nulo.
highlights

Highlights

Texto realçado da instância de série temporal a ser exibido para o usuário. Realçando inserções e marcas nas partes do texto que corresponderam à cadeia de caracteres de pesquisa. Não use nenhuma das propriedades realçadas para fazer mais chamadas à API.
name

string

Nome da instância de série temporal que correspondeu à solicitação de pesquisa. Pode ser nulo.
timeSeriesId

TimeSeriesId[]

ID de série temporal da instância de série temporal que correspondeu à solicitação de pesquisa.
typeId

string

Representa o tipo ao qual a instância de série temporal que correspondeu à solicitação de pesquisa pertence. Nunca nulo.

InstancesSortBy

Valor a ser usado para classificar as instâncias de série temporal antes de serem retornadas pela chamada de instâncias de pesquisa. Quando ele é definido como 'Rank', as instâncias retornadas são classificadas com base na relevância. Quando ele é definido como 'DisplayName', os resultados retornados são classificados com base no nome de exibição. Nome de exibição será o nome da instância se ela existir; caso contrário, o nome de exibição será a ID da série temporal. O padrão é 'Rank'.

Nome Tipo Description
DisplayName

string

Rank

string

InstancesSortParameter

Definição de como as instâncias de série temporal são classificadas antes de serem retornadas pela chamada de instâncias de pesquisa.

Nome Tipo Description
by

InstancesSortBy

Valor a ser usado para classificar as instâncias de série temporal antes de serem retornadas pela chamada de instâncias de pesquisa. Quando ele é definido como 'Rank', as instâncias retornadas são classificadas com base na relevância. Quando ele é definido como 'DisplayName', os resultados retornados são classificados com base no nome de exibição. Nome de exibição será o nome da instância se ela existir; caso contrário, o nome de exibição será a ID da série temporal. O padrão é 'Rank'.

SearchHierarchyNodesResponse

Os nós de hierarquia que contém as instâncias correspondentes à consulta com base na entrada. Pode ser vazio ou nulo.

Nome Tipo Description
continuationToken

string

Se retornado, isso significa que os resultados atuais representam um resultado parcial. O token de continuação permite obter a próxima página de resultados. Para obter a próxima página de resultados da consulta, envie a mesma solicitação com o parâmetro de 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 correspondentes à consulta com base na entrada.
hits

HierarchyHit[]

A lista de nós de hierarquia que contém as instâncias que correspondem à consulta com base na entrada. Pode ficar em branco.

SearchInstancesHierarchiesParameters

Parâmetro de como retornar hierarquias de instância de série temporal por chamada de instâncias de pesquisa.

Nome Tipo Description
expand

HierarchiesExpandParameter

Definição de se os nós de hierarquia devem ser expandidos na mesma chamada de instâncias de pesquisa. Opcional, o padrão é 'UntilChildren'.
pageSize

integer

Número máximo de hierarquias no mesmo nível a serem retornadas na mesma página. Opcional, o padrão é 10 quando não definido. O intervalo é de 1 a 100. Se houver resultados além do tamanho da página, o token de continuação poderá ser usado para buscar a próxima página.
sort

HierarchiesSortParameter

Definição de classificação de nós de hierarquia. Opcional, o padrão é 'CumulativeInstanceCount'.

SearchInstancesParameters

Parâmetros de como retornar instâncias de série temporal por chamada de instâncias de pesquisa.

Nome Tipo Description
highlights

boolean

Definição de resultados de pesquisa realçados ou não. Quando ele é definido como 'true', os resultados da pesquisa realçados são retornados. Quando ele é definido como 'false', os resultados da pesquisa realçados não são retornados. O valor padrão é 'true'.
pageSize

integer

Número máximo de instâncias esperadas em cada página do resultado. O padrão é 10 quando não definido. Varia de 1 a 100. Se houver resultados além do tamanho da página, o usuário poderá usar o token de continuação para buscar a próxima página.
recursive

boolean

Definição de quais instâncias são retornadas. Quando recursivo é definido como 'true', todas as instâncias que têm o caminho que começa com o caminho do parâmetro path são retornadas. Quando recursivo é definido como 'false', somente as instâncias que têm o caminho que corresponde exatamente ao parâmetro path são retornadas. O uso da pesquisa recursiva permite implementar a experiência do usuário de pesquisa, enquanto o uso da pesquisa não recursiva permite implementar a experiência de navegação. Opcional, o padrão é 'true'.
sort

InstancesSortParameter

Definição de como as instâncias de série temporal são classificadas antes de serem retornadas pela chamada de instâncias de pesquisa – relevância ou ordem alfabética. Opcional, o padrão é "Rank".

SearchInstancesRequest

Solicitação para executar uma consulta de pesquisa em instâncias de série temporal e retornar instâncias de série temporal correspondentes.

Nome Tipo Description
hierarchies

SearchInstancesHierarchiesParameters

Parâmetros de como retornar hierarquias de instância de série temporal. Se for nulo, as hierarquias não serão retornadas. Se o parâmetro instances for nulo e o parâmetro hierarchies não for nulo, somente hierarquias sem instâncias serão retornadas.
instances

SearchInstancesParameters

Parâmetros de como retornar 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 retornadas nos resultados com base nos valores padrão dos parâmetros e as hierarquias não são retornadas.
path

string[]

Filtre o caminho da hierarquia de instâncias de série temporal. Path é representado como matriz de segmentos de caminho de cadeia de caracteres. O primeiro elemento deve ser o nome da hierarquia. Exemplo: ["Location", "California"]. Opcional, diferencia maiúsculas de minúsculas, nunca vazio e pode ser nulo.
searchString

string

Cadeia de caracteres de pesquisa de consulta que será correspondida aos atributos de instâncias de série temporal. Exemplo: "andar 100". Não diferencia maiúsculas de minúsculas, deve estar presente, mas pode ser uma cadeia de caracteres vazia.

SearchInstancesResponse

As instâncias que correspondem à consulta com base na entrada. Pode ser vazio ou nulo.

Nome Tipo Description
continuationToken

string

Se retornado, isso significa que os resultados atuais representam um resultado parcial. O token de continuação permite obter a próxima página de resultados. Para obter a próxima página de resultados da consulta, envie a mesma solicitação com o parâmetro de token de continuação no cabeçalho HTTP "x-ms-continuation".
hitCount

integer

Número total de instâncias correspondentes à consulta com base na entrada.
hits

InstanceHit[]

A lista de instâncias que correspondem à consulta com base na entrada. Pode ficar em branco.

SearchInstancesResponsePage

Página única dos resultados da pesquisa.

Nome Tipo Description
hierarchyNodes

SearchHierarchyNodesResponse

Os nós de hierarquia que contém as instâncias correspondentes à consulta com base na entrada. Pode ser vazio ou nulo.
instances

SearchInstancesResponse

As instâncias que correspondem à consulta com base na entrada. Pode ser vazio ou nulo.

TsiError

Informações sobre um erro de API.

Nome Tipo Description
error

TsiErrorBody

Um erro de API específico com um código de erro e uma mensagem.

TsiErrorBody

Um erro de API específico com um código de erro e uma mensagem.

Nome Tipo Description
code

string

Cadeia de caracteres legível e independente de linguagem que define um código de erro específico do serviço. Esse código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser usado para lidar programaticamente com casos de erro específicos.
details

TsiErrorDetails[]

Contém informações de erro adicionais. Pode ser nulo.
innerError

TsiErrorBody

Contém um erro mais específico que restringe a causa. Pode ser nulo.
message

string

Representação legível e independente da linguagem do erro. Ele se destina a auxiliar os desenvolvedores e não é adequado para exposição aos usuários finais.
target

string

Destino do erro específico (por exemplo, o nome da propriedade em erro). Pode ser nulo.

TsiErrorDetails

Informações adicionais de erro.

Nome Tipo Description
code

string

Cadeia de caracteres legível e independente de linguagem que define um código de erro específico do serviço. Esse código serve como um indicador mais específico para o código de erro HTTP especificado na resposta. Pode ser usado para lidar programaticamente com casos de erro específicos.
message

string

Representação legível e independente da linguagem do erro. Ele se destina a auxiliar os desenvolvedores e não é adequado para exposição aos usuários finais.