Pesquisar Artigos da Base de Conhecimento

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

Endpoint

MétodoRotaContent-Type
GEThttps://api.tomticket.com/v2.0/kb/searchform-data

Autenticação

Este endpoint utiliza autenticação Bearer Token.

Authorization: Bearer SEU_TOKEN_AQUI

Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso.

Parâmetros da requisição

Parâmetros da requisição - Pesquisar Artigos da Base de Conhecimento

CampoTipoObrigatórioTamanho máximoDescrição
querystringSim250Termo de pesquisa utilizado para localizar um artigo.

JSON de saída

JSON de saída - Pesquisar Artigos da Base de Conhecimento

CampoTipoDescrição
errorbooleanInforma 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.
messagestringDetalhes da operação, caso tenha ocorrido ou não um problema.
successbooleanRetorna true caso a operação tenha sido concluída com sucesso.
sizeintegerTotal de itens encontrados.
dataarrayLista com os artigos localizados.
titlestringTítulo do artigo.
urlstringURL pública para leitura do artigo.
privatebooleanInforma 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 HTTPMensagemQuando ocorre
200Operação realizada com sucesso.Quando a pesquisa é concluída com sucesso.
401Token ou valores enviados não autorizados para uso.Quando o token ou os valores enviados não são autorizados.
403Recurso não disponível.Quando o recurso não está disponível.
404Recurso não encontrado.Quando o recurso não é encontrado.

Este artigo foi útil?  
Agradecemos sua avaliação.