Referência de busca
Parâmetros
| Parâmetro | Finalidade |
|---|---|
| Consulta | O termo de busca |
| Atributo | Escopa a busca a um atributo |
| Filtro de tipo de entidade | Restringe a um tipo |
| Filtro de situação | Restringe por situação da entidade |
| Incluir consolidados | Inclui registros consolidados, excluídos por padrão |
| Tolerante | Seleciona correspondência tolerante de rótulo em vez de texto completo |
| Ordenação | Ordena os resultados |
| Página, tamanho de página | Paginação — padrão 25, máximo 1000 |
O esquema de consulta repassa parâmetros não reconhecidos silenciosamente. Um parâmetro com erro de grafia ou inventado não produz erro — simplesmente não tem efeito, e você recebe resultados não filtrados que parecem filtrados. Confira os nomes contra esta tabela.
hasDuplicates em particular é um campo de resposta, não um parâmetro de
consulta.
Parâmetros são validados. Um valor malformado retorna 400 nomeando o parâmetro problemático, em vez de 500 — um número de página negativo ou um filtro que não é identificador é erro de quem chama e é reportado como tal.
Estratégias
| Estratégia | Acionada por | Casa com |
|---|---|---|
| Texto completo | Consulta sem escopo de atributo e sem o sinalizador tolerante | Texto indexado da entidade |
| Rótulo tolerante | Consulta com o sinalizador tolerante | O rótulo de exibição, tolerante a erros |
| Escopada a atributo | Consulta mais um atributo | O valor daquele atributo, e seu rótulo resolvido quando vinculado a lookup |
Campos de resultado
| Campo | Contém |
|---|---|
| Identificador e tipo da entidade | O registro correspondido |
| Rótulo | Rótulo de exibição, mascarado se o mascaramento se aplicar |
| Atributo correspondido | Qual atributo casou, na busca escopada |
| Valor correspondido | O valor que casou, mascarado se o mascaramento se aplicar |
| Rótulo do valor correspondido | O rótulo resolvido, quando vinculado a lookup |
A correspondência de rótulo tem um limite
Casar rótulos resolvidos é limitado em 1000. Quando uma consulta casaria com mais rótulos que o limite, os resultados carregam um sinal de truncamento.
O limite existe porque uma consulta muito curta pode casar com um número enorme de rótulos. Gerar erro foi descartado: uma consulta de um caractere é uma busca por prefixo legítima, e falhá-la seria pior que devolver as melhores correspondências com um sinal honesto de que há mais.
Controle de acesso
| Camada | Efeito |
|---|---|
| Isolamento entre organizações | Apenas a organização de quem consulta é pesquisável |
| Políticas ABAC | Registros negados ficam ausentes dos resultados |
| Mascaramento de campos | Valores correspondidos são mascarados como em toda parte |
A busca não é uma porta lateral. Um valor mascarado ao ler uma entidade está mascarado nos resultados de busca para quem consulta.
A seguir
Última verificação no commit d3c2586b (2026-08-03)