v_query - com escopo, global

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 4 min. de leitura
  • . v_query A API fornece métodos para obter informações sobre um objeto programável que representa uma consulta em execução em uma tabela remota.

    Esta API requer que o plug-in Tabelas remotas (com.glide.script.vtable) seja ativado. Para obter informações adicionais, consulte Recuperando dados externos usando tabelas e scripts remotos .

    Linhas de tabela remota são criadas usando v_table API.

    v_query - getCondition (campo de cadeia de caracteres)

    Obtém uma cadeia de caracteres de consulta codificada para o campo especificado.

    Consulte também v_table API.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Assunto: Cadeia de caracteres Nome do campo.
    Tabela 2. Retornos
    Tipo Descrição
    Cadeia de caracteres Retorna um cadeia de caracteres de consulta codificada para o campo fornecido.

    O exemplo a seguir mostra os resultados de um campo com uma consulta codificada de INC0001 ativo: Verdadeiro .

    var result = v_query.getCondition("number");
    gs.info(result);

    Saída:

    number=INC0001

    v_query - getEncodedQuery()

    Retorna a consulta em uma tabela remota como uma cadeia de caracteres de consulta codificada

    Para obter detalhes, consulte Cadeias de caracteres de consulta codificadas .

    Consulte também v_table API.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 4. Retorna
    Tipo Descrição
    Cadeia de caracteres A consulta codificada como uma cadeia de caracteres.

    O exemplo a seguir é um snippet de Recuperando registros específicos de uma origem de terceiros .

    gs.info(v_query.getEncodedQuery());

    Saída:

    active=true^priority=1

    v_query - getParameter(campo de cadeia de caracteres)

    Obtém o valor de um campo em uma condição de consulta de igualdade.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    Assunto: Cadeia de caracteres Nome do campo a ser consultado.
    Tabela 6. Retornos
    Tipo Descrição
    Cadeia de caracteres Valor do campo na condição de consulta. Por exemplo, se John é a consulta codificada, então GetParameter("name") retorna "João" .

    O exemplo a seguir mostra como obter o valor de um campo de ID de chamador.

    v_query.getParameter("caller_id");

    Saída:

    12345123451234512345123451234501

    v_query - getSysId()

    Retorna o valor sys_id em uma consulta GET.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 8. Retorna
    Tipo Descrição
    Cadeia de caracteres Valor sys_id na consulta GET, por exemplo, if sys_id: 123 este método retorna 123 .

    O exemplo a seguir é um snippet de Recuperando registros específicos de uma origem de terceiros .

    v_query.getSysId();

    Saída:

    a3a7ffb6dba41010db2051735e4619b7

    v_query - getTextSearch()

    Obtém um parâmetro de consulta de pesquisa de texto.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 10. Retorna
    Tipo Descrição
    Cadeia de caracteres Parâmetro de consulta de pesquisa de texto, por exemplo e-mail .

    No exemplo a seguir, o método retornará verdadeiro se a consulta contiver um parâmetro de consulta de texto, como GOTO123TEXTQUERY321: E-mail .

    // for query value GOTO123TEXTQUERY321=email
    v_query.getTextSearch();

    Saída:

    email

    IsGet()

    Determina se a consulta é uma consulta GET, ou seja, uma consulta que recupera um registro por sys_id.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 12. Retorna
    Tipo Descrição
    Booliano O sinalizador indica que a consulta de um registro específico tem sys_id como o formato de consulta.
    Valores válidos:
    • Verdadeiro: A consulta contém a condição de consulta de igualdade no campo sys_id.
    • Falso: A consulta não inclui a condição de consulta de igualdade no campo sys_id.

    No exemplo a seguir, se a consulta codificada for para obter mais informações, consulte o manual de instruções do usuário . v_query.isGet() o método retorna verdadeiro. Se a consulta codificada for qualquer outra coisa, como INC0000001 . v_query.isGet() o método retorna falso.

    // Virtual table to query
    var row = {
     sys_id: "d1954c744662010bd7e061e67a6776e",
     number: "INC0000001",
     short_description: "New laptop request",
     u_balance: 1200.23
    };
    
    v_table.addRow(row);
    
    v_query.isGet();

    IsTextSearch()

    Indica se a consulta contém um parâmetro de consulta de texto.

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 14. Retorna
    Tipo Descrição
    Booliano Sinalizador que indica se a consulta contém um parâmetro de consulta de texto.
    Valores válidos:
    • Verdadeiro: A consulta contém um parâmetro de consulta de texto.
    • Falso: A consulta não contém um parâmetro de consulta de texto.

    No exemplo a seguir, o método retornará verdadeiro se a consulta contiver um parâmetro de consulta de texto, como GOTO123TEXTQUERY321: E-mail .

    v_query.isTextSearch();

    v_query - setLastErrorMessage (mensagem de cadeia de caracteres)

    Define a última mensagem de erro no GlideRecord.

    Tabela 15. Parâmetros
    Nome Tipo Descrição
    message Cadeia de caracteres Mensagens de erro
    Tabela 16. Retornos
    Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra a estrutura básica usada para definir uma mensagem de erro.

    (function executeQuery (v_table, v_query) {
     try {
    
     // Add code to test for errors during execution
     } catch(ex) {
    
      v_query.setLastErrorMessage(ex.message);
    
     }
    
    }) (v_table, v_query);

    O exemplo a seguir mostra como definir a última mensagem de erro em uma REST API.

    (function executeQuery (v_table, v_query) { 
     try {
    
     // call a REST API
     } catch(ex) {
    
      v_query.setLastErrorMessage("Error obtaining results from remote service");
    
     }
    
    }) (v_table, v_query);