---
sourceDocument: Yokohama Administração da Now Platform
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/yokohama/platform-administration

 Release :

    - yokohama

ft:locale :

    - pt-BR

ft:publication_title :

    - Yokohama Administração da Now Platform

ft:clusterId :

    - platadm

bundleId :

    - platadm

workflow :

    - Platform


---

# Use a REST API GraphQL para exibir sugestões criadas a partir de pesquisas de usuários externos

# Use a REST API GraphQL para exibir sugestões criadas a partir de pesquisas de usuários externos {#ariaid-title1}

* Versão de lançamento: Yokohama
* 
* Atualizado 30 de jan. de 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 min. de leitura

Envie uma solicitação para o endpoint da REST API GraphQL para recuperar sugestões de pesquisa criadas a partir de pesquisas por usuários externos autoregistrados. Este endpoint permite o acesso de usuários convidados não autenticados.

## Antes de Iniciar

Certifique-se de que as seguintes condições sejam atendidas em sua instância:

* O plug-in Separação de domínio não está ativado. Para obter detalhes sobre este plug-in, consulte [Plug-in de separação de domínio](https://www.servicenow.com/docs/access?context=domain-sep-plugin&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US).
* O plug-in de funções explícitas (com.glide.explicit_roles) está ativado. Para saber mais sobre este plug-in, consulte [Funções explícitas](https://www.servicenow.com/docs/access?context=explicit-roles&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US).
* Os usuários externos com a função snc_external enviaram pesquisas em aplicações de pesquisa que geram sugestões de pesquisa, como ServiceNow® Portal de serviços, Now Mobile, ou ServiceNow® Virtual Agent.
* . glide.search.suggestions.allow_guest_usera propriedade do sistema está definida como verdadeiro . Para obter detalhes sobre como definir um valor de propriedade do sistema, consulte [Adicionar propriedade do sistema](https://servicenow-prod.fluidtopics.net/KfTr86WVVXuPMmk0LEzCzQ#t_AddAPropertyUsingSysPropsList "Adicione ou crie uma propriedade para controlar o comportamento do sistema.").
{#view-ext-user-search-suggestions__ul_fg1_wfq_wpb}  
Obtenha o sys_id da aplicação de pesquisa para a qual você deseja recuperar sugestões de pesquisa de usuário externo.  
Nota:  
Os usuários com as funções search_application_admin, agent_workspace_user ou workspace_user podem obter este sys_id copiando-o do registro da aplicação de pesquisa na tabela Configuração da aplicação de pesquisa \[sys_search_context_config\].

Faça o download de um cliente GraphQL de terceiros, como o cliente GraphiQL, Insomnia ou Postman.

Função necessária: nenhuma

## Por Que e Quando Desempenhar Esta Tarefa

As sugestões de pesquisa criam sugestões para pesquisas realizadas por usuários externos registrados automaticamente. Quando o. glide.search.suggestions.allow_guest_usera propriedade do sistema está definida como verdadeiro , Usuários convidados não autenticados podem acessar o endpoint da REST API GraphQL para sua instância para recuperar sugestões de pesquisa de usuário externo para uma aplicação de pesquisa.  
Nenhuma autenticação é necessária ou imposta para este endpoint da REST API GraphQL.  
Nota:  
Usuários convidados não autenticados só podem recuperar sugestões de pesquisa do domínio global. Se a separação de domínio estiver habilitada em sua instância, os usuários convidados não poderão recuperar sugestões de pesquisa.

## Procedimento

1. Em seu cliente GraphQL de terceiros, configure uma nova solicitação que use o método HTTP POST.
2. Defina o endpoint da solicitação para o endpoint da REST API GraphQL para sua instância, https://\<instance name\>.service-now.com/api/now/graphql .
3. Defina o corpo da solicitação para a seguinte consulta GraphQL, substituindo `<search_application_sys_id> `com o sys_id da aplicação de pesquisa para a qual você deseja recuperar sugestões de pesquisa de usuário externo:  

       {
         GlideSearch_Query {
           suggestions(searchContextConfigId: "<search_application_sys_id>", searchTerm: "") {
             term
             data {
               name
               records {
                 type
                 columns {
                   label
                   fieldName
                   value
                   displayValue
                 }
               }
             }
           }
         }
       }

## Resultado

O sistema retorna sugestões de pesquisa de pesquisas de aplicações por usuários externos registrados automaticamente como um objeto JSON, conforme mostrado neste exemplo:

    {
      "data": {
        "GlideSearch_Query": {
          "suggestions": {
            "term": "",
            "data": [
              {
                "records": [
                  {
                    "type": "POPULAR_QUERY",
                    "columns": [
                      {
                        "label": "name",
                        "displayValue": "automatic replies",
                        "value": "automatic replies",
                        "fieldName": "name"
                      }
                    ]
                  },
                  {
                    "type": "POPULAR_QUERY",
                    "columns": [
                      {
                        "label": "name",
                        "displayValue": "contact group",
                        "value": "contact group",
                        "fieldName": "name"
                      }
                    ]
                  },
                  {
                    "type": "POPULAR_QUERY",
                    "columns": [
                      {
                        "label": "name",
                        "displayValue": "tablet",
                        "value": "tablet",
                        "fieldName": "name"
                      }
                    ]
                  },
                  {
                    "type": "POPULAR_QUERY",
                    "columns": [
                      {
                        "label": "name",
                        "displayValue": "laptop",
                        "value": "laptop",
                        "fieldName": "name"
                      }
                    ]
                  },
                  {
                    "type": "POPULAR_QUERY",
                    "columns": [
                      {
                        "label": "name",
                        "displayValue": "new email account",
                        "value": "new email account",
                        "fieldName": "name"
                      }
                    ]
                  }
                ],
                "name": "Popular searches"
              }
            ]
          }
        }
      }
    }