Pesquisar Artigos da Base de Conhecimento

Este método permite pesquisar artigos existente em sua base de conhecimento.


Endpoint

https://api.tomticket.com/v2.0/kb/search


Método HTTP

GET


Content Type

form-data


Autenticação

Authorization: Bearer {SEU-TOKEN-AQUI}


Parâmetros Query String

Os parâmetros Query String são enviadas diretamente na URL após o símbolo de "?" ao final do endpoint. Cada parâmetro e valor deve ser enviado com o nome dele e valor, separados pelo símbolo de "=", como por exemplo nomeParametro=ValorParametro. Para enviar mais de um parâmetro, deve separá-los, usando símbolo "&", como por exemplo nomeParametro1=ValorParametro1&nomeParametro2=ValorParametro2.


ChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximo
queryTermo de pesquisa utilizado para localizar um artigo.
Sim-String250

Retorno

Descrição do retorno em JSON.

ColunaDescrição da ColunaTipo
errorInforma se ocorreu um erro na operação. Se o retorno for false, então 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 mensagem para identificar o problema.Boolean
messageDetalhes da operação, caso tenha ocorrido ou não um problema.String
successRetorna true caso a operação tenha sido concluída com sucesso.Boolean
sizeTotal de itens encontrados.Int
dataLista com os artigos localizados.Array
data
title
Título do artigoString
data
url
URL pública para leitura do artigo.String
data
private
Informa se o artigo é apenas para clientes com login. Caso o retorno seja false, então significa que o acesso ao chamado é público. Caso o retorno seja true, apenas clientes autenticados poderão ler o artigo.Boolean

Código de Retorno

Descrição do código HTTP de retorno.

CódigoDescrição
200Operação realizada com sucesso.
401Token ou valores enviados não autorizados para uso.
403Recurso não disponível.
404Recurso não encontrado.

Disponibilidade

Recurso Premium Recurso Enterprise


Was this article helpful?  
We appreciate your review.