---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# v_query - com escopo, global

# v_query - com escopo, global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 min. de leitura

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](https://www.servicenow.com/docs/access?context=remote-tables&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US).

As linhas da tabela remota são criadas usando a API [v_table](https://servicenow-prod.fluidtopics.net/bcMJ9sR1sIU68hL1Gkh27g#v_tableAPI "A API v_table fornece métodos para adicionar linhas a uma tabela remota por meio de um objeto programável.").

## v_query - getCondition(cadeia de caracteres campo) {#ariaid-title2}

Obtém uma cadeia de caracteres de consulta codificada para o campo especificado.
Consulte também a API [v_table](https://servicenow-prod.fluidtopics.net/bcMJ9sR1sIU68hL1Gkh27g#v_tableAPI "A API v_table fornece métodos para adicionar linhas a uma tabela remota por meio de um objeto programável.").
{#vquery-getCondition_S__table_j3v_xm3_nlb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Assunto: | Cadeia de caracteres | Nome do campo. |
[Tabela 1. Parâmetros]

{#vquery-getCondition_S__table_j3v_xm3_nlb} {#vquery-getCondition_S__table_k3v_xm3_nlb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Retorna uma [cadeia de caracteres de consulta codificada](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US) para o campo fornecido. |
[Tabela 2. Retorna]

{#vquery-getCondition_S__table_k3v_xm3_nlb}  
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() {#ariaid-title3}

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](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US) .{#vquery-getEncodedQuery__link_encoded_query_strings}

Consulte também a API [v_table](https://servicenow-prod.fluidtopics.net/bcMJ9sR1sIU68hL1Gkh27g#v_tableAPI "A API v_table fornece métodos para adicionar linhas a uma tabela remota por meio de um objeto programável.").
{#vquery-getEncodedQuery__table_j3v_xm3_nlb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 3. Parâmetros]

{#vquery-getEncodedQuery__table_j3v_xm3_nlb} {#vquery-getEncodedQuery__table_k3v_xm3_nlb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | A consulta codificada como uma cadeia de caracteres. |
[Tabela 4. Retorna]

{#vquery-getEncodedQuery__table_k3v_xm3_nlb}  
O exemplo a seguir é um snippet de [Recuperando registros específicos de uma origem de terceiros](https://www.servicenow.com/docs/access?context=remote-table-script-def-example2&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US).

    gs.info(v_query.getEncodedQuery());

Saída:

    active=true^priority=1

## v_query - getParameter (cadeia de caracteres do campo) {#ariaid-title4}

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](https://www.servicenow.com/docs/access?context=remote-table-script-def-example2&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)
* API[v_table](https://servicenow-prod.fluidtopics.net/bcMJ9sR1sIU68hL1Gkh27g#v_tableAPI "A API v_table fornece métodos para adicionar linhas a uma tabela remota por meio de um objeto programável.")
{#vquery-getParameter_S__ul_y54_hnd_sqb} {#vquery-getParameter_S__table_j3v_xm3_nlb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Assunto: | Cadeia de caracteres | Nome do campo a ser consultado. |
[Tabela 5. Parâmetros]

{#vquery-getParameter_S__table_j3v_xm3_nlb} {#vquery-getParameter_S__table_k3v_xm3_nlb__entry__2}

| 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"`. |
[Tabela 6. Retorna]

{#vquery-getParameter_S__table_k3v_xm3_nlb}  
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() {#ariaid-title5}

Retorna o valor de sys_id em uma consulta de obtenção.
{#vquery-getSysId__table_j3v_xm3_nlb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 7. Parâmetros]

{#vquery-getSysId__table_j3v_xm3_nlb} {#vquery-getSysId__table_k3v_xm3_nlb__entry__2}

| 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. |
[Tabela 8. Retorna]

{#vquery-getSysId__table_k3v_xm3_nlb}  
O exemplo a seguir é um snippet de [Recuperando registros específicos de uma origem de terceiros](https://www.servicenow.com/docs/access?context=remote-table-script-def-example2&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US).

    v_query.getSysId();

Saída:

    a3a7ffb6dba41010db2051735e4619b7

## v_query -- getTextSearch() {#ariaid-title6}

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

* [Cadeias de caracteres de consulta codificadas](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US)
* [Consultando tabelas no script](https://www.servicenow.com/docs/access?context=c_UsingGlideRecordToQueryTables&version=xanadu&pubname=xanadu-application-development&ft:locale=en-US)
* API[v_table](https://servicenow-prod.fluidtopics.net/bcMJ9sR1sIU68hL1Gkh27g#v_tableAPI "A API v_table fornece métodos para adicionar linhas a uma tabela remota por meio de um objeto programável.")
{#vquery-getTextSearch__ul_a2q_rkp_nlb}
{#vquery-getTextSearch__table_j3v_xm3_nlb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 9. Parâmetros]

{#vquery-getTextSearch__table_j3v_xm3_nlb} {#vquery-getTextSearch__table_k3v_xm3_nlb__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Parâmetro de consulta de pesquisa de texto, por exemplo, e- mail. |
[Tabela 10. Retorna]

{#vquery-getTextSearch__table_k3v_xm3_nlb}  
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() {#ariaid-title7}

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](https://www.servicenow.com/docs/access?context=remote-table-script-def-example2&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)
* API[v_table](https://servicenow-prod.fluidtopics.net/bcMJ9sR1sIU68hL1Gkh27g#v_tableAPI "A API v_table fornece métodos para adicionar linhas a uma tabela remota por meio de um objeto programável.")
{#vquery-isGet__ul_y54_hnd_sqb} {#vquery-isGet__table_j3v_xm3_nlb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 11. Parâmetros]

{#vquery-isGet__table_j3v_xm3_nlb} {#vquery-isGet__table_k3v_xm3_nlb__entry__2}

| 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. {#vquery-isGet__ul_jdl_pfb_add} |
[Tabela 12. Retorna]

{#vquery-isGet__table_k3v_xm3_nlb}  
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() {#ariaid-title8}

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

* [Cadeias de caracteres de consulta codificadas](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US)
* [Consultando tabelas no script](https://www.servicenow.com/docs/access?context=c_UsingGlideRecordToQueryTables&version=xanadu&pubname=xanadu-application-development&ft:locale=en-US)
* API[v_table](https://servicenow-prod.fluidtopics.net/bcMJ9sR1sIU68hL1Gkh27g#v_tableAPI "A API v_table fornece métodos para adicionar linhas a uma tabela remota por meio de um objeto programável.")
{#vquery-isTextSearch__ul_a2q_rkp_nlb}
{#vquery-isTextSearch__table_j3v_xm3_nlb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 13. Parâmetros]

{#vquery-isTextSearch__table_j3v_xm3_nlb} {#vquery-isTextSearch__table_k3v_xm3_nlb__entry__2}

| 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. {#vquery-isTextSearch__ul_jdl_pfb_add} |
[Tabela 14. Retorna]

{#vquery-isTextSearch__table_k3v_xm3_nlb}  
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) {#ariaid-title9}

Define a última mensagem de erro no GlideRecord.
Consulte também:

* [GlideRecord com escopo - getLastErrorMessage()](https://servicenow-prod.fluidtopics.net/FBR_zQLvGAsgQtw7~4MAGA#c_GlideRecordScopedAPI "A API GlideRecord com escopo é usada para operações de banco de dados.")
* [Recuperando registros específicos de uma origem de terceiros](https://www.servicenow.com/docs/access?context=remote-table-script-def-example2&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)
* API[v_table](https://servicenow-prod.fluidtopics.net/bcMJ9sR1sIU68hL1Gkh27g#v_tableAPI "A API v_table fornece métodos para adicionar linhas a uma tabela remota por meio de um objeto programável.")
{#vquery-setLastErrorMessage_S__ul_dbm_rvc_sqb}
{#vquery-setLastErrorMessage_S__table_j3v_xm3_nlb__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| message | Cadeia de caracteres | Mensagens de erro |
[Tabela 15. Parâmetros]

{#vquery-setLastErrorMessage_S__table_j3v_xm3_nlb} {#vquery-setLastErrorMessage_S__table_k3v_xm3_nlb__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 16. Retorna]

{#vquery-setLastErrorMessage_S__table_k3v_xm3_nlb}  
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);