Partilhar via

Time Series Instances - Search

Serviço:
Time Series Insights
Versão da API:
2020-07-31

Lista parcial de acertos na pesquisa de instâncias de séries temporais 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
environmentFqdn
 path True

string

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

string

Versão da API a ser usada com a solicitação do 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 de resultados para recuperar a próxima página dos resultados em chamadas que suportam paginação. Para obter os resultados da primeira página, especifique o token de continuação nulo como valor do parâmetro. O token de continuação retornado será nulo se todos os resultados tiverem sido retornados e não houver uma 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 a respeito de uma solicitação específica.
x-ms-client-session-id

string

ID de sessão de 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 do Pedido

Name Necessário Tipo Description
searchString True

string

Cadeia de pesquisa de consulta que será correspondida aos atributos de instâncias de séries temporais. Exemplo: "piso 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éries temporais. Se null, as hierarquias não são retornadas. Se instances parameter for null e hierarchies parameter não for null, somente hierarquias sem instâncias serão retornadas.
instances

SearchInstancesParameters

Parâmetros de como retornar instâncias de séries temporais. Pode ser null. Quando as instâncias e os parâmetros de hierarquia 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éries temporais. Path é representado como matriz de segmentos de caminho de cadeia de caracteres. O primeiro elemento deve ser o nome da hierarquia. Exemplo: ["Localização", "Califórnia"]. Opcional, diferencia maiúsculas de minúsculas, nunca vazio e pode ser nulo.

Respostas

Name Tipo Description
200 OK

SearchInstancesResponsePage

Resposta de pesquisa bem-sucedida.

Cabeçalhos

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

TsiError

Erro inesperado.

Cabeçalhos

x-ms-request-id: string

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

SearchInstancesDefault
SearchInstancesExpandHierarchiesOnly
SearchInstancesHierarchiesDefaultInputPage1
SearchInstancesHierarchiesDefaultInputPage2
SearchInstancesHierarchiesDefaultInputPage3
SearchInstancesOneLevel
SearchInstancesRecursive
SearchInstancesUntilChildren

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

Código de estado:
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

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

Código de estado:
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

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

Código de estado:
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

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

Código de estado:
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

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

Código de estado:
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

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

Código de estado:
200 
{
  "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

Código de estado:
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

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

Código de estado:
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

Name Description
HierarchiesExpandKind

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

Definição de expandir ou não nós de hierarquia na mesma chamada de instâncias de pesquisa.
HierarchiesSortBy

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

Definição de ordenação de nós hierárquicos.
HierarchyHit

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

Texto realçado da ocorrência da série temporal a ser exibido ao usuário. O realce insere as <tags hit> e </hit> nas partes do texto que correspondem à cadeia de pesquisa. Não use nenhuma das propriedades realçadas para fazer mais chamadas de API.
InstanceHit

Instância de série temporal que é retornada por chamada de pesquisa de instâncias. A instância retornada correspondeu à solicitação de pesquisa e contém texto realçado a ser exibido ao usuário se estiver definido como 'true'.
InstancesSortBy

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

Definição de como as instâncias de séries cronológicas 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 estar 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éries temporais por chamada de instâncias de pesquisa.
SearchInstancesRequest

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

As instâncias que correspondem à consulta com base na entrada. Pode estar 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 de erro adicionais.

HierarchiesExpandKind

Enumeração

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

Valor Description
UntilChildren
OneLevel

HierarchiesExpandParameter

Object

Definição de expandir ou não nós de hierarquia na mesma chamada de instâncias de pesquisa.

Name Tipo Description
kind

HierarchiesExpandKind

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

HierarchiesSortBy

Enumeração

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

Valor Description
CumulativeInstanceCount
Name

HierarchiesSortParameter

Object

Definição de ordenação de nós hierárquicos.

Name Tipo Description
by

HierarchiesSortBy

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

HierarchyHit

Object

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

Name Tipo Description
cumulativeInstanceCount

integer (int32)

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

SearchHierarchyNodesResponse

Nós de hierarquia filho deste nó. Pode estar vazio ou nulo.
name

string

Nome do nó da hierarquia. Pode estar vazio, não pode ser nulo.

Highlights

Object

Texto realçado da ocorrência da série temporal a ser exibido ao usuário. O realce insere as <tags hit> e </hit> nas partes do texto que correspondem à cadeia de pesquisa. Não use nenhuma das propriedades realçadas para fazer mais chamadas de API.

Name Tipo Description
description

string

Descrição realçada da instância da série temporal. Pode ser nulo.
hierarchyIds

string[]

Lista de IDs de hierarquia de séries temporais 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éries temporais 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 campos de ocorrência de séries temporais 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 da série temporal. Pode ser nulo.
timeSeriesId

string[]

Lista de valores de cadeia de caracteres realçados de ID de Série Temporal para exibição. Não pode ser usado para pesquisar instância.
typeName

string

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

InstanceHit

Object

Instância de série temporal que é retornada por chamada de pesquisa de instâncias. A instância retornada correspondeu à solicitação de pesquisa e contém texto realçado a ser exibido ao usuário se estiver definido como 'true'.

Name Tipo Description
hierarchyIds

string[]

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

Highlights

Texto realçado da ocorrência da série temporal a ser exibido ao usuário. O realce insere as <tags hit> e </hit> nas partes do texto que correspondem à cadeia de pesquisa. Não use nenhuma das propriedades realçadas para fazer mais chamadas de API.
name

string

Nome da instância da 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 pertence a ocorrência de série temporal que correspondeu à solicitação de pesquisa. Nunca nulo.

InstancesSortBy

Enumeração

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

Valor Description
Rank
DisplayName

InstancesSortParameter

Object

Definição de como as instâncias de séries cronológicas são classificadas antes de serem retornadas pela chamada de instâncias de pesquisa.

Name Tipo Description
by

InstancesSortBy

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

SearchHierarchyNodesResponse

Object

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

Name Tipo Description
continuationToken

string

Se retornado, isso significa que os resultados atuais representam um resultado parcial. 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 (int32)

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 correspondentes à consulta com base na entrada. Pode estar vazio.

SearchInstancesHierarchiesParameters

Object

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

Name Tipo Description
expand

HierarchiesExpandParameter

Definição de expandir ou não nós de hierarquia na mesma chamada de instâncias de pesquisa. Opcional, o padrão é 'UntilChildren'.
pageSize

integer (int32)

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

HierarchiesSortParameter

Definição de ordenação de nós hierárquicos. Opcional, o padrão é 'CumulativeInstanceCount'.

SearchInstancesParameters

Object

Parâmetros de como retornar instâncias de séries temporais por chamada de instâncias de pesquisa.

Name Tipo Description
highlights

boolean

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

integer (int32)

Número máximo de instâncias esperadas em cada página do resultado. O padrão é 10 quando não está definido. Varia de 1 a 100. Se houver resultados além do tamanho da página, o usuário pode 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 o parâmetro path são retornadas. Quando recursivo é definido como 'false', somente 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éries temporais são classificadas antes de serem retornadas por instâncias de pesquisa chamada - relevância ou alfabética. Opcional, o padrão é "Rank".

SearchInstancesRequest

Object

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

Name Tipo Description
hierarchies

SearchInstancesHierarchiesParameters

Parâmetros de como retornar hierarquias de instância de séries temporais. Se null, as hierarquias não são retornadas. Se instances parameter for null e hierarchies parameter não for null, somente hierarquias sem instâncias serão retornadas.
instances

SearchInstancesParameters

Parâmetros de como retornar instâncias de séries temporais. Pode ser null. Quando as instâncias e os parâmetros de hierarquia 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éries temporais. Path é representado como matriz de segmentos de caminho de cadeia de caracteres. O primeiro elemento deve ser o nome da hierarquia. Exemplo: ["Localização", "Califórnia"]. Opcional, diferencia maiúsculas de minúsculas, nunca vazio e pode ser nulo.
searchString

string

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

SearchInstancesResponse

Object

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

Name Tipo Description
continuationToken

string

Se retornado, isso significa que os resultados atuais representam um resultado parcial. 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 (int32)

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 estar vazio.

SearchInstancesResponsePage

Object

Página única dos resultados da pesquisa.

Name Tipo Description
hierarchyNodes

SearchHierarchyNodesResponse

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

SearchInstancesResponse

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

TsiError

Object

Informações sobre um erro de API.

Name Tipo Description
error

TsiErrorBody

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

TsiErrorBody

Object

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

Name Tipo Description
code

string

Cadeia de caracteres legível por humanos e independente do idioma 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 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 reduz a causa. Pode ser nulo.
message

string

Representação do erro legível por humanos e independente da linguagem. Destina-se a ajudar 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

Object

Informações de erro adicionais.

Name Tipo Description
code

string

Cadeia de caracteres legível por humanos e independente do idioma 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 usado para lidar programaticamente com casos de erro específicos.
message

string

Representação do erro legível por humanos e independente da linguagem. Destina-se a ajudar os desenvolvedores e não é adequado para exposição aos usuários finais.