v_query – Inclus dans le champ d’application, global

  • Rversion finale: Zurich
  • Mis à jour 31 juil. 2025
  • 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 en cours d’exécution 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.

    Les lignes de table distantes sont créées à l’aide de l’API v_table .

    v_query : getCondition(champ de chaîne)

    Obtient une chaîne de requête codée pour le champ spécifié.

    Voir aussi API v_table .

    Tableau 1. Paramètres
    Nom Type Description
    champ Chaîne Nom du champ.
    Tableau 2. Renvoie
    Type Description
    Chaîne Renvoie une chaîne de requête codée pour le champ donné.

    L’exemple suivant montre les résultats pour un champ avec une requête codée numéro=INC0001^active=vrai.

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

    Sortie :

    number=INC0001

    v_query : getEncodedQuery()

    Renvoie la requête sur une table distante sous forme de chaîne de requête codée.

    Pour plus d’informations, consultez Chaînes de requête codées .

    Voir aussi API v_table .

    Tableau 3. Paramètres
    Nom Type Description
    Aucun
    Tableau 4. Renvoie
    Type Description
    Chaîne Requête codée sous forme de chaîne.

    L’exemple suivant est un extrait de Récupération d’enregistrements spécifiques à partir d’une source tierce.

    gs.info(v_query.getEncodedQuery());

    Sortie :

    active=true^priority=1

    v_query : getParameter(champ de chaîne)

    Obtient la valeur d’un champ dans une condition de requête d’égalité.

    Voir aussi :
    Tableau 5. Paramètres
    Nom Type Description
    champ Chaîne Nom du champ à interroger.
    Tableau 6. Renvoie
    Type Description
    Chaîne Valeur du champ dans la condition de requête. Par exemple, si name=John est la requête codée, getParameter(« name ») renvoie « John ».

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

    Renvoie la valeur sys_id dans une requête get.

    Tableau 7. Paramètres
    Nom Type Description
    Aucun
    Tableau 8. Renvoie
    Type Description
    Chaîne Sys_id valeur dans la requête get, par exemple, si sys_id=123, cette méthode renvoie 123.

    L’exemple suivant est un extrait de Récupération d’enregistrements spécifiques à partir d’une source tierce.

    v_query.getSysId();

    Sortie :

    a3a7ffb6dba41010db2051735e4619b7

    v_query : getTextSearch()

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

    Voir aussi :
    Tableau 9. Paramètres
    Nom Type Description
    Aucun
    Tableau 10. Renvoie
    Type Description
    Chaîne Paramètre de requête de recherche de texte, par exemple e-mail.

    Dans l’exemple suivant, la méthode renvoie la valeur true si la requête contient un paramètre de requête de texte, tel que GOTO123TEXTQUERY321=email.

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

    Sortie :

    email

    v_query : isGet()

    Détermine si la requête est une requête get, c’est-à-dire une requête qui récupère un enregistrement par sys_id.

    Voir aussi :
    Tableau 11. Paramètres
    Nom Type Description
    Aucun
    Tableau 12. Renvoie
    Type Description
    Booléen Le marqueur indique que la requête d’un enregistrement spécifique a sys_id = comme format de requête.
    Valeurs valides :
    • vrai : la requête contient une condition de requête d’égalité sur le champ sys_id.
    • faux : la requête n’inclut pas de condition de requête d’égalité dans le champ sys_id.

    Dans l’exemple suivant, si la requête codée est sys_id=d1954c744662010bd7e061e67a6776e, la méthode v_query.isGet() renvoie la valeur vrai. Si la requête codée est autre chose, telle que 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()

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

    Voir aussi :
    Tableau 13. Paramètres
    Nom Type Description
    Aucun
    Tableau 14. Renvoie
    Type Description
    Booléen Marqueur indiquant si la requête contient un paramètre de requête de texte.
    Valeurs valides :
    • true : la requête contient un paramètre de requête de texte.
    • false : la requête ne contient pas de paramètre de requête de texte.

    Dans l’exemple suivant, la méthode renvoie la valeur true si la requête contient un paramètre de requête de texte, tel que GOTO123TEXTQUERY321=email.

    v_query.isTextSearch();

    v_query : setLastErrorMessage(Message de chaîne)

    Définit le dernier message d’erreur dans le GlideRecord.

    Voir aussi :
    Tableau 15. Paramètres
    Nom Type Description
    message Chaîne Message d'erreur.
    Tableau 16. Renvoie
    Type Description
    Aucun

    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 API REST.

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