Se você precisar encontrar informações sobre um cliente específico, use o parâmetro filter da API Cloud Channel pelo método customers.list.
Se você usar um filtro, haverá um pequeno atraso (geralmente alguns segundos) durante a
criação de um cliente. Se você precisar acessar um cliente imediatamente após
a criação, recomendamos usar customers.list sem um filtro ou
customers.get.
Filtros disponíveis
As strings do parâmetro de filtro oferecem suporte à correspondência exata ou à correspondência exata com filtragem de prefixo. Os filtros não diferenciam maiúsculas de minúsculas.
A tabela a seguir descreve os campos disponíveis para pesquisa e os métodos compatíveis.
| Chave de pesquisa externa | Suporte para correspondência exata | Compatível com o prefixo |
|---|---|---|
| domínio | Sim | Sim |
| org_display_name | Sim | Sim |
| cloud_identity_id | Sim | Não |
| channel_partner_id | Sim | Não |
Confira a sintaxe completa de filtros no guia de filtragem de APIs.
Sintaxe de correspondência exata
Os filtros de correspondência exata só vão encontrar clientes que contêm os mesmos campos que os da string enviada.
Sintaxe:
<domain | org_display_name | cloud_identity_id | channel_partner_id> = <value>
Exemplo: domain = "domain.com" AND channel_partner_id = "12345"
Sintaxe do prefixo
Os filtros de prefixo permitem o uso de um asterisco como símbolo curinga. Esse filtro encontrará clientes que têm campos com o prefixo, independentemente do conteúdo que vem depois dele.
Sintaxe: <domain | org_display_name> : <value>*
Exemplo: domain : "uw.com*" AND org_display_name : "prefix*"
Exemplos de filtros com operadores lógicos
Os filtros da API Cloud Channel oferecem suporte ao uso dos operadores lógicos AND e OR. É possível usar os dois operadores em um filtro usando uma instrução entre parênteses.
Exemplo de AND
domain = "domain.com" AND channel_partner_id = "12345" AND org_display_name :
"display*"
Exemplo de OR
domain = "domain.com" OR channel_partner_id = "12345" OR org_display_name :
"display*"
Exemplo de AND + OR
domain = "domain.com" OR (channel_partner_id = "12345" AND org_display_name :
"display*" )
Use parênteses se o filtro tiver uma instrução AND e OR. O exemplo a seguir não é uma string de filtro válida.
domain = "domain.com" OR channel_partner_id = "12345" AND org_display_name :
"display*