v_query - com escopo, global

A API v_query 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 Recuperação de dados externos usando tabelas e scripts remotos.

As linhas da tabela remota são criadas usando a API v_table.

v_query - getCondition(cadeia de caracteres campo)

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

Consulte também a API v_table.

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 uma cadeia de caracteres de consulta codificada para o campo fornecido.

O exemplo a seguir mostra resultados para um campo com uma consulta codificada de number=INC0001^active=true.

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

Saída:

number=INC0001

v_query – getEncodedQuery()

Retorna a consulta em relação a uma tabela remota como uma cadeia de caracteres de consulta codificada

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

Consulte também a API v_table.

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 (cadeia de caracteres do campo)

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

Consulte também:

• Recuperando registros específicos de uma origem de terceiros
• APIv_table

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 name=John for a consulta codificada, getParameter("name") retornará "John".

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 de sys_id em uma consulta de obtenção.

Tabela 7. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 8. Retorna

Tipo	Descrição
Cadeia de caracteres	Valor Sys_id na consulta de obtenção, por exemplo, se sys_id=123, este método retornará 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.

Consulte também:

• Cadeias de caracteres de consulta codificadas
• Consultando tabelas no script
• APIv_table

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=email.

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

Saída:

email

v_query – isGet()

Determina se a consulta é uma consulta de obtenção, ou seja, uma consulta que recupera um registro por sys_id.

Consulte também:

• Recuperando registros específicos de uma origem de terceiros
• APIv_table

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 sys_id=d1954c744662010bd7e061e67a6776e, o método v_query.isGet() retornará verdadeiro. Se a consulta codificada for qualquer outra, como Number=INC0000001, o método v_query.isGet() retornará 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();

v_query – isTextSearch()

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

Consulte também:

• Cadeias de caracteres de consulta codificadas
• Consultando tabelas no script
• APIv_table

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=email.

v_query.isTextSearch();

v_query - setLastErrorMessage (cadeia de caracteres mensagem)

Define a última mensagem de erro no GlideRecord.

Consulte também:

• GlideRecord com escopo - getLastErrorMessage()
• Recuperando registros específicos de uma origem de terceiros
• APIv_table

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);