Pesquisar Tipos Solicitação

warning

Em desenvolvimento - ainda não disponível em produção

Retorna uma lista paginada de tipos solicitação cadastrados na aplicação com base em um termo de busca, utilizando Elasticsearch. Permite filtrar os resultados por meio de comunicação e por disponibilidade para usuários anônimos.

info

Caso tenha interesse em fazer uso desta funcionalidade, entre em contato.

Endpoints

Método	URL
GET	https://{{url}}/cube/api/v3/tipos-solicitacao/search?query={{query}}&idMeioComunicacao={{idMeioComunicacao}}&anonimo={{anonimo}}

Exemplo de Corpo

Não se aplica para este endpoint.

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
query	`string`	Sim	Termo utilizado para busca dos tipos solicitação
idMeioComunicacao	`number`	Não	ID do meio de comunicação para filtrar os resultados
anonimo	`boolean`	Não	Quando `true`, retorna apenas tipos solicitação disponíveis para usuários anônimos

Respostas

Exemplo de corpo da resposta

{
  "total": 3,
  "resultado": [
    {
      "id": 4041,
      "titulo": "Castrar Cães e Gatos gratuitamente",
      "descricao": "",
      "navegacao": [
        {
          "id": 1654,
          "nome": "Animais"
        },
        {
          "id": 1930,
          "nome": "Exames, vacinas e castração"
        }
      ],
      "tipo": "SOLICITACAO",
      "meiosComunicacao": [
        2,
        6
      ],
      "ai": {
        "aliases": [],
        "keywords": [],
        "generated_questions": [],
        "summary": "",
        "embeddingText": "",
        "score": 100,
        "explain": {
          "knn": 0.8,
          "bm25": 300
        }
      }
    }
  ]
}

Chave	Descrição
total	Quantidade total de tipos solicitação encontrados
resultado	Lista de tipos solicitação retornados pela busca
resultado[].id	ID do serviço
resultado[].titulo	Título do serviço
resultado[].descricao	Descrição do serviço em formato HTML
resultado[].navegacao	Trilha de navegação (breadcrumb) do serviço
resultado[].navegacao[].id	ID do nível de navegação
resultado[].navegacao[].nome	Nome do nível de navegação
resultado[].tipo	Tipo do registro (ex: `SOLICITACAO`)
resultado[].meiosComnuicacao[]	Canais habilitadas do serviço
resultado[].ai	Detalhes sobre como a consulta foi montada e suas variantes
resultado[].score	Pontuação utilizada para ordenação dos documentos
resultado[].explain	Detalhes referentes à pontuação de cada consulta utilizada
resultado[].explain.knn	Contribuição vetorial
resultado[].explain.bm25	Contribuição lexical, baseada em frequência e raridade das palavras

Status da resposta

Status	Descrição
200	OK - Retorna os tipos solicitação encontrados com base nos parâmetros informados
204	Nenhum resultado encontrado para os parâmetros informados

Endpoints​

Exemplo de Corpo​

Parâmetros​

Respostas​

Exemplo de corpo da resposta​

Status da resposta​