Se precisar de encontrar informações sobre um cliente específico, pode usar o parâmetro filter da API Cloud Channel através do método customers.list.
Se usar um filtro, existe um pequeno atraso (normalmente, alguns segundos) durante a criação de um cliente. Se precisar de aceder a um cliente imediatamente após a criação, recomendamos que use customers.list sem um filtro ou customers.get.
Filtros disponíveis
As strings para o parâmetro de filtro suportam a correspondência exata ou a correspondência exata mais a filtragem de prefixos. Os filtros não são sensíveis a maiúsculas e minúsculas.
A tabela seguinte descreve os campos disponíveis que pode pesquisar e os métodos que suportam.
| Chave de pesquisa externa | Suporte de correspondência exata | Suporte de prefixos |
|---|---|---|
| domínio | Sim | Sim |
| org_display_name | Sim | Sim |
| cloud_identity_id | Sim | Não |
| channel_partner_id | Sim | Não |
Pode encontrar a sintaxe de filtro completa no guia de filtragem da API.
Sintaxe de correspondência exata
Os filtros de correspondência exata só encontram 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 a utilização de um asterisco como símbolo universal. Este filtro encontra clientes que têm campos com o prefixo, independentemente do conteúdo que se segue.
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 suportam a utilização de operadores lógicos AND e OR. Pode usar ambos os operadores num filtro através de uma declaração entre parênteses.
Exemplo de E
domain = "domain.com" AND channel_partner_id = "12345" AND org_display_name :
"display*"
Exemplo de OU
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*" )
Tem de usar parênteses se o filtro contiver uma declaração AND e uma declaração OR. O exemplo seguinte não é uma string de filtro válida.
domain = "domain.com" OR channel_partner_id = "12345" AND org_display_name :
"display*