---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# v_query -- Champ d'application, global

# v_query -- Champ d'application, global {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes de lecture

L'API v_query fournit des méthodes permettant d'obtenir des informations sur un objet pouvant contenir des scripts qui représente une requête exécutée sur une table distante.

Cette API nécessite l'activation du module d'extension Tables distantes (com.glide.script.vtable). Pour plus d'informations, consultez [Récupération de données externes à l'aide de tables et de scripts distants](https://www.servicenow.com/docs/access?context=remote-tables&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US).

Les lignes des tables distantes sont créées à l'aide de l'API [v_table](https://servicenow-prod.fluidtopics.net/y2D4NggIpieLAhp2dJy84w#v_tableAPI "L’API v_table fournit des méthodes pour ajouter des lignes à une table distante via un objet pouvant contenir des scripts.") .

## v_query : getCondition(champ de chaîne) {#ariaid-title2}

Obtient une chaîne de requête codée pour le champ spécifié.
Voir aussi [v_table](https://servicenow-prod.fluidtopics.net/y2D4NggIpieLAhp2dJy84w#v_tableAPI "L’API v_table fournit des méthodes pour ajouter des lignes à une table distante via un objet pouvant contenir des scripts.") API.
{#vquery-getCondition_S__table_j3v_xm3_nlb__entry__3}

| Nom | Type | Description |
|-|-|-|
| champ | Chaîne | Nom du champ. |
[Tableau 1. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Renvoie une [chaîne de requête codée](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US) pour le champ donné. |
[Tableau 2. Renvoie]

{#vquery-getCondition_S__table_k3v_xm3_nlb}  
L'exemple suivant montre les résultats pour un champ avec une requête codée de `number=INC0001^active=true`.

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

Sortie :

    number=INC0001

## v_query : getEncodedQuery() {#ariaid-title3}

Renvoie la requête par rapport à une table distante sous la forme d'une chaîne de requête codée
Pour plus [d'informations, consultez Chaînes de requêtes codées](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}

Voir aussi [v_table](https://servicenow-prod.fluidtopics.net/y2D4NggIpieLAhp2dJy84w#v_tableAPI "L’API v_table fournit des méthodes pour ajouter des lignes à une table distante via un objet pouvant contenir des scripts.") API.
{#vquery-getEncodedQuery__table_j3v_xm3_nlb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 3. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Requête codée sous forme de chaîne. |
[Tableau 4. Renvoie]

{#vquery-getEncodedQuery__table_k3v_xm3_nlb}  
L'exemple suivant est un extrait de [Récupération d'enregistrements spécifiques à partir d'une source tierce](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());

Sortie :

    active=true^priority=1

## v_query : getParameter(champ String) {#ariaid-title4}

Obtient la valeur d'un champ dans une condition de requête d'égalité.
Voir aussi :

* [Récupération d'enregistrements spécifiques à partir d'une source tierce](https://www.servicenow.com/docs/access?context=remote-table-script-def-example2&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)
* [v_table](https://servicenow-prod.fluidtopics.net/y2D4NggIpieLAhp2dJy84w#v_tableAPI "L’API v_table fournit des méthodes pour ajouter des lignes à une table distante via un objet pouvant contenir des scripts.") API
{#vquery-getParameter_S__ul_y54_hnd_sqb} {#vquery-getParameter_S__table_j3v_xm3_nlb__entry__3}

| Nom | Type | Description |
|-|-|-|
| champ | Chaîne | Nom du champ à interroger. |
[Tableau 5. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Valeur du champ dans la condition de requête. Par exemple, si `name=John` est la requête codée, alors getParameter(\<\< name \>\>) renvoie `<< John` \>\>. |
[Tableau 6. Renvoie]

{#vquery-getParameter_S__table_k3v_xm3_nlb}  
L'exemple suivant montre comment obtenir la valeur d'un champ d'ID d'appelant.

    v_query.getParameter("caller_id");

Sortie :

    12345123451234512345123451234501

## v_query : getSysId() {#ariaid-title5}

Renvoie la valeur sys_id dans une requête GET.
{#vquery-getSysId__table_j3v_xm3_nlb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 7. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Sys_id valeur dans la requête GET, par exemple, si `sys_id=123`, cette méthode renvoie 123. |
[Tableau 8. Renvoie]

{#vquery-getSysId__table_k3v_xm3_nlb}  
L'exemple suivant est un extrait de [Récupération d'enregistrements spécifiques à partir d'une source tierce](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();

Sortie :

    a3a7ffb6dba41010db2051735e4619b7

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

Obtient un paramètre de requête de recherche de texte.
Voir aussi :

* [Chaînes de requêtes codées](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US)
* [Interrogation des tables dans le script](https://www.servicenow.com/docs/access?context=c_UsingGlideRecordToQueryTables&version=xanadu&pubname=xanadu-application-development&ft:locale=en-US)
* [v_table](https://servicenow-prod.fluidtopics.net/y2D4NggIpieLAhp2dJy84w#v_tableAPI "L’API v_table fournit des méthodes pour ajouter des lignes à une table distante via un objet pouvant contenir des scripts.") API
{#vquery-getTextSearch__ul_a2q_rkp_nlb}
{#vquery-getTextSearch__table_j3v_xm3_nlb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 9. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Paramètre de requête de recherche de texte, par exemple e-mail. |
[Tableau 10. Renvoie]

{#vquery-getTextSearch__table_k3v_xm3_nlb}  
Dans l'exemple suivant, la méthode renvoie true si la requête contient un paramètre de requête textuel, tel que `GOTO123TEXTQUERY321=email`.

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

Sortie :

    email

## v_query : isGet() {#ariaid-title7}

Détermine si la requête est une requête d'obtention, c'est-à-dire une requête qui récupère un enregistrement par sys_id.
Voir aussi :

* [Récupération d'enregistrements spécifiques à partir d'une source tierce](https://www.servicenow.com/docs/access?context=remote-table-script-def-example2&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)
* [v_table](https://servicenow-prod.fluidtopics.net/y2D4NggIpieLAhp2dJy84w#v_tableAPI "L’API v_table fournit des méthodes pour ajouter des lignes à une table distante via un objet pouvant contenir des scripts.") API
{#vquery-isGet__ul_y54_hnd_sqb} {#vquery-isGet__table_j3v_xm3_nlb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 11. Paramètres]

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

| Type | Description |
|-|-|
| Booléen | Le marqueur indique que le format de requête d'une requête pour un enregistrement spécifique est `sys_id=` . Valeurs valides : * vrai : la requête contient une condition de requête d'égalité dans le champ sys_id. * faux : la requête n'inclut pas la condition de requête d'égalité dans le champ sys_id. {#vquery-isGet__ul_jdl_pfb_add} |
[Tableau 12. Renvoie]

{#vquery-isGet__table_k3v_xm3_nlb}  
Dans l'exemple suivant, si la requête codée est `sys_id=d1954c744662010bd7e061e67a6776e`, la méthode v_query.isGet() renvoie vrai. Si la requête codée est autre chose, comme `Number=INC0000001`, la méthode v_query.isGet() renvoie false.

    // 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}

Indique si la requête contient un paramètre de requête de texte.
Voir aussi :

* [Chaînes de requêtes codées](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US)
* [Interrogation des tables dans le script](https://www.servicenow.com/docs/access?context=c_UsingGlideRecordToQueryTables&version=xanadu&pubname=xanadu-application-development&ft:locale=en-US)
* [v_table](https://servicenow-prod.fluidtopics.net/y2D4NggIpieLAhp2dJy84w#v_tableAPI "L’API v_table fournit des méthodes pour ajouter des lignes à une table distante via un objet pouvant contenir des scripts.") API
{#vquery-isTextSearch__ul_a2q_rkp_nlb}
{#vquery-isTextSearch__table_j3v_xm3_nlb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 13. Paramètres]

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

| Type | Description |
|-|-|
| Booléen | Marqueur indiquant si la requête contient un paramètre de requête de texte. Valeurs valides : * vrai : la requête contient un paramètre de requête de texte. * faux : la requête ne contient pas de paramètre de requête de texte. {#vquery-isTextSearch__ul_jdl_pfb_add} |
[Tableau 14. Renvoie]

{#vquery-isTextSearch__table_k3v_xm3_nlb}  
Dans l'exemple suivant, la méthode renvoie true si la requête contient un paramètre de requête textuel, tel que `GOTO123TEXTQUERY321=email`.

    v_query.isTextSearch();

## v_query : setLastErrorMessage(message de chaîne) {#ariaid-title9}

Définit le dernier message d'erreur dans le GlideRecord.
Voir aussi :

* [GlideRecord inclus dans le champ d'application : getLastErrorMessage()](https://servicenow-prod.fluidtopics.net/2WySz5FCvQHHbdfx6_dFUg#c_GlideRecordScopedAPI "L’API GlideRecord incluse dans le périmètre d’application est utilisée pour les opérations de base de données.")
* [Récupération d'enregistrements spécifiques à partir d'une source tierce](https://www.servicenow.com/docs/access?context=remote-table-script-def-example2&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)
* [v_table](https://servicenow-prod.fluidtopics.net/y2D4NggIpieLAhp2dJy84w#v_tableAPI "L’API v_table fournit des méthodes pour ajouter des lignes à une table distante via un objet pouvant contenir des scripts.") API
{#vquery-setLastErrorMessage_S__ul_dbm_rvc_sqb}
{#vquery-setLastErrorMessage_S__table_j3v_xm3_nlb__entry__3}

| Nom | Type | Description |
|-|-|-|
| message | Chaîne | Message d'erreur. |
[Tableau 15. Paramètres]

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

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 16. Renvoie]

{#vquery-setLastErrorMessage_S__table_k3v_xm3_nlb}  
L'exemple suivant montre la structure de base utilisée pour définir un message d'erreur.

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

L'exemple suivant montre comment définir le dernier message d'erreur dans une 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);