Parâmetros da requisição - Pesquisar Artigos da Base de Conhecimento
Campo
Tipo
Obrigatório
Tamanho máximo
Descrição
query
string
Sim
250
Termo de pesquisa utilizado para localizar um artigo.
JSON de saída
JSON de saída - Pesquisar Artigos da Base de Conhecimento
Campo
Tipo
Descrição
error
boolean
Informa se ocorreu um erro na operação. Se o retorno for false, significa que a operação ocorreu com sucesso e não ocorreram problemas. Caso o retorno seja true, ocorreu um erro e será necessário verificar o campo message para identificar o problema.
message
string
Detalhes da operação, caso tenha ocorrido ou não um problema.
success
boolean
Retorna true caso a operação tenha sido concluída com sucesso.
size
integer
Total de itens encontrados.
data
array
Lista com os artigos localizados.
title
string
Título do artigo.
url
string
URL pública para leitura do artigo.
private
boolean
Informa se o artigo é apenas para clientes com login. Caso o retorno seja false, o acesso ao artigo é público. Caso o retorno seja true, apenas clientes autenticados poderão ler o artigo.
Possíveis erros
Status HTTP
Mensagem
Quando ocorre
200
Operação realizada com sucesso.
Quando a pesquisa é concluída com sucesso.
401
Token ou valores enviados não autorizados para uso.
Quando o token ou os valores enviados não são autorizados.