RESTMessageV2 - Incluse dans le périmètre, globale

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 15 minutes de lecture
  • L’API RESTMessageV2 vous permet d’envoyer des messages REST sortants à l’aide de JavaScript.

    Utilisez l’API RESTResponseV2 pour gérer la réponse renvoyée par le fournisseur REST.

    La valeur de l’agent utilisateur est « ServiceNow/1.0 ». Pour modifier cela, ajoutez la propriété système glide.http.user.agent dans la table Propriétés système [sys_properties].

    Cette API s’exécute dans l’espace de noms sn_ws .

    RESTMessageV2 : disableForcedVariableSubstitution()

    Désactive la substitution forcée de variable dans les messages REST sortants.

    Remarque :
    L’utilisation d’accolades ou de signes dollar dans votre demande peut renvoyer par inadvertance une sortie tronquée. Si votre demande tronque par erreur la réponse ou la divise sur de nouvelles lignes, reportez-vous à cet article de Community pour une solution potentielle.
    Tableau 1. Paramètres
    Nom Type Description
    Aucun
    Tableau 2. Renvoie
    Type Description
    nul
    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get");
    sm.disableForcedVariableSubstitution();
    var response = sm.execute();

    RESTMessageV2 - execute()

    Envoie le message REST au point de terminaison.

    Tableau 3. Paramètres
    Nom Type Description
    Aucun
    Tableau 4. Renvoie
    Type Description
    RESTResponse Réponse renvoyée par le fournisseur REST.

    Dans l’exemple suivant, remplacez REST_message_record par le nom de l’enregistrement de message REST de votre instance.

    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    var response = sm.execute(); //Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.

    RESTMessageV2 - executeAsync()

    Envoie le message REST au point de terminaison de manière asynchrone. L’instance n’attend pas de réponse du fournisseur de services Web lorsqu’elle passe des appels asynchrones.

    Tableau 5. Paramètres
    Nom Type Description
    Aucun
    Tableau 6. Renvoie
    Type Description
    RESTResponse Réponse renvoyée par le fournisseur REST.

    Dans l’exemple suivant, remplacez REST_message_record par le nom de l’enregistrement de message REST de votre instance. Lors de l’utilisation d’executeAsync, envisagez de traiter le corps de la réponse dans une règle métier distincte pour tirer parti de l’appel asynchrone.

    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    var response = sm.executeAsync(); //Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.
    

    RESTMessageV2 : getEndpoint()

    Obtient l’URL du point de terminaison pour le message REST.

    Tableau 7. Paramètres
    Nom Type Description
    Aucun
    Tableau 8. Renvoie
    Type Description
    Chaîne URL du fournisseur de service Web REST.

    Dans l’exemple suivant, remplacez REST_message_record par le nom de l’enregistrement de message REST de votre instance.

    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    var endpoint = sm.getEndpoint();

    RESTMessageV2 : getRequestBody()

    Obtient le contenu du corps du message REST.

    Tableau 9. Paramètres
    Nom Type Description
    Aucun
    Tableau 10. Renvoie
    Type Description
    Chaîne le corps du message REST.

    Dans l’exemple suivant, remplacez REST_message_record par le nom de l’enregistrement de message REST de votre instance.

    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    var body = sm.getRequestBody();

    RESTMessageV2 : getRequestHeader(String headerName)

    Obtient la valeur d’un en-tête HTTP spécifié dans le message REST.

    Par défaut, cette méthode ne peut pas renvoyer la valeur d’un en-tête définie automatiquement par le système. Pour accorder à cette méthode l’accès à tous les en-têtes, définissez la propriété glide.http.log_debug sur vrai.

    Tableau 11. Paramètres
    Nom Type Description
    headerName Chaîne En-tête de demande dont vous souhaitez obtenir la valeur.
    Tableau 12. Renvoie
    Type Description
    Chaîne Valeur de l’en-tête spécifié.

    Dans l’exemple suivant, remplacez REST_message_record par le nom de l’enregistrement de message REST de votre instance.

    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    var header = sm.getRequestHeader("Accept");

    RESTMessageV2 : getRequestHeaders()

    Obtient les en-têtes HTTP qui ont été définis par le client REST et les valeurs associées.

    Cette méthode ne renvoie pas les en-têtes définis automatiquement par le système. Pour configurer cette méthode afin de renvoyer tous les en-têtes, définissez la propriété glide.http.log_debug sur vrai.

    Tableau 13. Paramètres
    Nom Type Description
    Aucun
    Tableau 14. Renvoie
    Type Description
    Objet Objet qui mappe le nom de chaque en-tête à la valeur associée.

    Dans l’exemple suivant, remplacez REST_message_record par le nom de l’enregistrement de message REST de votre instance.

    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    var headers = sm.getRequestHeaders();

    RESTMessageV2 - RESTMessageV2()

    Instancie un objet RESTMessageV2 vide.

    Lorsque vous utilisez un objet instancié de cette façon, vous devez spécifier manuellement une méthode HTTP et un point de terminaison.

    Tableau 15. Paramètres
    Nom Type Description
    Néant
    var sm = new sn_ws.RESTMessageV2();

    RESTMessageV2 : RESTMessageV2(nom de chaîne, nom de chaîne methodName)

    Instancie un objet RESTMessageV2 à l’aide des informations d’un enregistrement de message REST.

    Vous devez avoir un enregistrement de message REST défini avant de pouvoir utiliser ce constructeur.

    Tableau 16. Paramètres
    Nom Type Description
    nom Chaîne Nom de l’enregistrement de message REST.
    Methodname Chaîne Nom de la méthode HTTP à utiliser, par exemple GET/get ou PUT/put - sans respect de la casse.

    Dans l’exemple suivant, remplacez REST_message_record par le nom de l’enregistrement de message REST de votre instance.

    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.

    RESTMessageV2 – saveResponseBodyAsAttachment(String tableName, String recordSysId, String fileName)

    Configure le message REST pour enregistrer le corps de réponse renvoyé en tant qu’enregistrement de pièce jointe.

    Lorsque vous utilisez cette fonction avec un message REST envoyé via un MID Server, l’utilisateur du MID Server doit disposer de tous les rôles nécessaires pour lire et écrire les enregistrements de pièces jointes, ainsi que de tous les rôles requis pour lire et écrire les enregistrements sur la table spécifiée dans le tableName paramètre.

    Le corps de la réponse n’a pas besoin d’être un fichier binaire pour être enregistré en tant que pièce jointe. Il est également possible d’enregistrer les corps des réponses utilisant des formats texte tels que JSON ou XML. Si l’instance ne parvient pas à enregistrer la pièce jointe, appelez getErrorMessage() sur l’objet RESTResponseV2 connexe pour plus de détails sur l’erreur.

    Tableau 17. Paramètres
    Nom Type Description
    tableName Chaîne Spécifiez la table qui contient l’enregistrement auquel vous souhaitez joindre le fichier enregistré.
    recordSysId Chaîne Spécifiez le sys_id de l’enregistrement auquel vous souhaitez joindre le fichier enregistré.
    fileName Chaîne Spécifiez le nom de fichier à donner au fichier enregistré.
    Tableau 18. Renvoie
    Type Description
    nul
    (function sampleRESTMessageV2() {
      try{
        var request  = new sn_ws.RESTMessageV2();        
        request.setHttpMethod('get');
    
        var attachment_sys_id  = '<attachment_record_sys_id>', 
          tablename = 'incident',
          recordSysId = '<incident_sys_id>',            
          response,            
          httpResponseStatus,             
          filename ='<filename>';
    
        //endpoint - ServiceNow REST Attachment API        
        request.setEndpoint('https://<instance_name>.service-now.com/api/now/attachment/' + attachment_sys_id  +'/file');        
        request.setBasicAuth('<username>', '<password>');
    
        //RESTMessageV2 - saveResponseBodyAsAttachment(String tableName, String recordSysId, String fileName)        
        request.saveResponseBodyAsAttachment(tablename, recordSysId, filename);        
    
        response = request.execute();        
        httpResponseStatus = response.getStatusCode();  
          
        gs.info(" http response status_code:  " + httpResponseStatus);    
      }
      catch(ex){
        var message  = ex.getMessage();        
        gs.info(message);    
      }
    })();

    RESTMessageV2 – saveResponseBodyAsAttachment(String tableName, String recordSysId, String fileName, String encryptContext)

    Configure le message REST pour enregistrer le corps de la réponse renvoyé en tant qu’enregistrement de pièce jointe chiffrée.

    Lorsque vous utilisez cette fonction avec un message REST envoyé via un MID Server, l’utilisateur du MID Server doit disposer de tous les rôles nécessaires pour lire et écrire les enregistrements de pièces jointes, ainsi que de tous les rôles requis pour lire et écrire les enregistrements sur la table spécifiée dans le tableName paramètre.

    Le corps de la réponse n’a pas besoin d’être un fichier binaire pour être enregistré en tant que pièce jointe. Il est également possible d’enregistrer les corps des réponses utilisant des formats texte tels que JSON ou XML. Si l’instance ne parvient pas à enregistrer la pièce jointe, appelez getErrorMessage() sur l’objet RESTResponseV2 connexe pour plus de détails sur l’erreur.

    Tableau 19. Paramètres
    Nom Type Description
    tableName Chaîne Spécifiez la table qui contient l’enregistrement auquel vous souhaitez joindre le fichier enregistré.
    recordSysId Chaîne Spécifiez le sys_id de l’enregistrement auquel vous souhaitez joindre le fichier enregistré.
    fileName Chaîne Spécifiez le nom de fichier à donner au fichier enregistré.
    encryptContext (encryptContext) Chaîne Spécifiez la sys_id d’un contexte de chiffrement. Le fichier enregistré est chiffré dans ce contexte.
    Tableau 20. Renvoie
    Type Description
    nul

    RESTMessageV2 : setAuthenticationProfile(Type de chaîne, ID de profil de chaîne)

    Définit les informations d’identification pour le message REST à l’aide d’une authentification de base existante ou d’un profil OAuth 2.0.

    Tableau 21. Paramètres
    Nom Type Description
    type Chaîne Le type de profil d’authentification à utiliser. Les valeurs valides sont « basic » pour utiliser l’authentification de base ou « oauth2 » pour utiliser OAuth 2.0.
    ID de profil Chaîne sys_id d’un enregistrement de profil d’authentification. Lorsque vous utilisez l’authentification de base, spécifiez le sys_id d’un enregistrement de configuration de l’authentification de base [sys_auth_profile_basic]. Lors de l’utilisation d’OAuth 2.0, spécifiez le sys_id d’un enregistrement de profil d’entité OAuth [oauth_entity_profile].
    Tableau 22. Renvoie
    Type Description
    nul

    Dans l’exemple suivant, remplacez REST_message_record par le nom de l’enregistrement de message REST de votre instance.

    var requestBody;
    var responseBody;
    var status;
    var sm;
    try{
           // Might throw exception if message doesn't exist or not visible due to scope.
    	sm = new sn_ws.RESTMessageV2("<REST_message_record>", "get");  
    
           //set auth profile to an OAuth 2.0 profile record.
    	sm.setAuthenticationProfile('oauth2', '1234adsf123212131123qasdsf'); 
    
    	sm.setStringParameter("symbol", "NOW");
    	sm.setStringParameterNoEscape("xml_data","<data>test</data>");
    
           //In milliseconds. Wait at most 10 seconds for response from http request.
    	sm.setHttpTimeout(10000); 
           //Might throw exception if http connection timed out or some issue 
           //with sending request itself because of encryption/decryption of password.
    	response = sm.execute();	
           responseBody = response.haveError() ? response.getErrorMessage() : response.getBody();
    	status = response.getStatusCode();
    } catch(ex) {
    	responseBody = ex.getMessage();
    	status = '500';
    } finally {
    	requestBody = sm ? sm.getRequestBody():null;
    }

    RESTMessageV2 : setBasicAuth(String userName, String userPass)

    Définit les en-têtes d’authentification de base pour le message REST.

    La définition de valeurs de sécurité à l’aide de cette méthode remplace les valeurs d’authentification de base définies pour l’enregistrement de message REST.

    Tableau 23. Paramètres
    Nom Type Description
    userName Chaîne Nom d’utilisateur que vous souhaitez utiliser pour authentifier le message REST.
    UserPass Chaîne Mot de passe de l’utilisateur spécifié.
    Tableau 24. Renvoie
    Type Description
    nul

    Dans l’exemple suivant, remplacez REST_message_record par le nom de l’enregistrement de message REST de votre instance.

    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setBasicAuth("username","password");

    RESTMessageV2 : setEccCorrelator(corrélateur de chaînes)

    Associe les demandes sortantes et l’enregistrement de réponse qui en résulte dans la file d’attente ECC. Cette méthode s’applique uniquement aux messages REST envoyés via un Serveur MIDfichier .

    Le corrélateur indiqué renseigne le champ Agent corrélatif sur l’enregistrement de file d’attente ECC pour la réponse. Fournissez un corrélateur unique pour chaque demande sortante afin d’associer les résultats corrects de la file d’attente ECC à la demande lors de la conception d’une automatisation asynchrone via un MID Server.

    Tableau 25. Paramètres
    Nom Type Description
    Correlator Chaîne Identificateur unique
    Tableau 26. Renvoie
    Type Description
    nul

    Dans l’exemple suivant, remplacez REST_message_record par le nom de l’enregistrement de message REST de votre instance.

    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setEccCorrelator("unique_identifier");

    RESTMessageV2 : setEccParameter(nom de chaîne, valeur de chaîne)

    Remplace une valeur de la base de données en écrivant dans la charge utile du message REST. Cette méthode s’applique uniquement aux messages REST envoyés via un MID Server.

    Utilisez cette méthode lorsqu’une valeur du message REST dans la base de données n’est pas valide, par exemple lorsque l’URL du point de terminaison est plus longue que la longueur maximale du champ de point de terminaison REST. Vous pouvez définir uniquement l’URL du point de terminaison à l’aide de cette méthode en transmettant source comme paramètre de nom.

    Tableau 27. Paramètres
    Nom Type Description
    nom Chaîne Nom du paramètre, par exemple source.
    valide Chaîne Valeur à affecter au paramètre spécifié.
    Tableau 28. Renvoie
    Type Description
    nul

    Dans l’exemple suivant, remplacez REST_message_record par le nom de l’enregistrement de message REST de votre instance.

    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setEccParameter("source","http://very.long.endpoint.url");

    RESTMessageV2 : setEndpoint(point de terminaison de chaîne)

    Définit le point de terminaison pour le message REST.

    Par défaut, le message REST utilise le point de terminaison spécifié dans l’enregistrement du message REST. Utilisez cette méthode pour remplacer cette valeur par défaut. Vous devez appeler cette méthode lorsque vous utilisez le RESTMessageV2 - RESTMessageV2() constructeur sans paramètres.

    Tableau 29. Paramètres
    Nom Type Description
    point de terminaison Chaîne URL du fournisseur REST avec lequel vous souhaitez établir une interface.
    Tableau 30. Renvoie
    Type Description
    nul
    var sm = new sn_ws.RESTMessageV2();
    sm.setEndpoint("http://web.service.endpoint");

    RESTMessageV2 - setHttpMethod(méthode String)

    Définit la méthode HTTP exécutée par ce message REST, telle que GET ou PUT.

    Vous devez définir une méthode HTTP lorsque vous utilisez le RESTMessageV2 - RESTMessageV2() constructeur sans paramètres.

    Tableau 31. Paramètres
    Nom Type Description
    method Chaîne Méthode HTTP à exécuter.
    Tableau 32. Renvoie
    Type Description
    nul
    var sm = new sn_ws.RESTMessageV2();
    sm.setHttpMethod("post");

    RESTMessageV2 : setHttpTimeout(Number timeoutMs)

    Définit la durée pendant laquelle le message REST attend une réponse du fournisseur de service Web avant que la demande n’expire.

    Tableau 33. Paramètres
    Nom Type Description
    timeoutMs Numéro Durée, en millisecondes, avant que l’appel au fournisseur REST n’expire.
    Remarque :
    Cette valeur définit un délai d’expiration sur le socket et n’expire que si le socket ne reçoit pas de données dans le délai spécifié. Pour les environnements dans lesquels les réponses sont diffusées, il est possible que les connexions durent beaucoup plus longtemps que la valeur du délai d’expiration.
    Tableau 34. Renvoie
    Type Description
    Néant

    Pour utiliser l’exemple suivant, remplacez &lt;REST_message_record> par le nom de l’enregistrement de message REST de votre instance.

    // Might throw exception if message doesn't exist or not visible due to scope.
    var sm = new sn_ws.RESTMessageV2("<REST_message_record>", "get");
    sm.setHttpTimeout(6000);

    RESTMessageV2 : setLogLevel(niveau de chaîne)

    Définit le niveau de journalisation de ce message et de la réponse correspondante.

    La définition d’un niveau de journal à l’aide de l’API RESTMessageV2 remplace le niveau de journal configuré sur l’enregistrement de message REST. Ce niveau de journal peut ne pas s’appliquer si le domaine de point de terminaison est exclu ou si la propriété glide.outbound_http_log.override est définie sur vrai. Pour afficher les journaux de service Web sortants, accédez à Journaux système > Demandes HTTP sortantes.

    Tableau 35. Paramètres
    Nom Type Description
    niveau Chaîne Le niveau de journal. Les valeurs valides sont les suivantes : de base, élevé et tout.
    Tableau 36. Renvoie
    Type Description
    nul
    var rm = new sn_ws.RESTMessageV2();
    rm.setLogLevel('all');

    RESTMessageV2 - setMIDServer(String midServer)

    Configure le message REST pour communiquer via un Serveur MIDfichier .

    Tableau 37. Paramètres
    Nom Type Description
    Serveur MID Chaîne Nom du Serveur MID fichier à utiliser. Votre instance doit avoir un actif Serveur MID avec le nom spécifié.
    Tableau 38. Renvoie
    Type Description
    nul

    Dans l’exemple suivant, remplacez REST_message_record par le nom de l’enregistrement de message REST de votre instance.

    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setMIDServer("mid_server_name");

    RESTMessageV2 : setMutualAuth(String profileName)

    Définit le profil du protocole d’authentification réciproque pour le message REST.

    La définition d’un profil de protocole à l’aide de cette méthode remplace le profil de protocole sélectionné pour l’enregistrement de message REST.

    Tableau 39. Paramètres
    Nom Type Description
    profileName Chaîne Le nom du profil de protocole à utiliser pour l’authentification réciproque.
    Tableau 40. Renvoie
    Type Description
    nul

    Dans l’exemple suivant, remplacez REST_message_record par le nom de l’enregistrement de message REST de votre instance.

    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setMutualAuth("mutual_auth_profile_name");

    RESTMessageV2 - setQueryParameter(nom de chaîne, valeur de chaîne)

    Ajoute un paramètre à la fin de l’URL de demande avec la forme nom=valeur.

    Par exemple, le code setQueryParameter(« sysparm_query »,&quot;active=true^ORDERBYnumber^ORDERBYDESCcategory ») ; ajoute le texte sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCà l’URL de la demande.

    Tableau 41. Paramètres
    Nom Type Description
    nom Chaîne Nom du paramètre d’URL à transmettre.
    valide Chaîne Valeur pour affecter le paramètre d’URL.
    Tableau 42. Renvoie
    Type Description
    nul
    var sm = new sn_ws.RESTMessageV2();
    //Set up message, including endpoint and authentication
    sm.setQueryParameter("sysparm_query","active=true^ORDERBYnumber^ORDERBYDESCcategory");

    RESTMessageV2 : setRequestBody(corps de chaîne)

    Définit le contenu du corps à envoyer au fournisseur de services Web lors de l’utilisation des méthodes HTTP PUT ou POST.

    Lorsque vous définissez le contenu du corps à l’aide de cette méthode, les variables du corps ne sont pas substituées aux paramètres de l’enregistrement de fonction de message REST. Vous devez définir explicitement toutes les valeurs dans le corps du message REST.

    Tableau 43. Paramètres
    Nom Type Description
    body Chaîne Corps de la demande à envoyer.
    Tableau 44. Renvoie
    Type Description
    nul
    var sm = new sn_ws.RESTMessageV2("Update user","post"); //Might throw exception if message doesn't exist or not visible due to scope.
    var body = "<Message body content>";
    sm.setRequestBody(body);

    RESTMessageV2 : setRequestBodyFromAttachment(String attachmentSysId)

    Définit le corps de la demande à l’aide d’un enregistrement de pièce jointe existant.

    Lorsque vous utilisez cette fonction avec un message REST envoyé via un Serveur MID, l’utilisateur Serveur MID doit disposer de tous les rôles requis pour lire les enregistrements de pièces jointes.

    Tableau 45. Paramètres
    Nom Type Description
    attachmentSysId Chaîne Sys_id de l’enregistrement de pièce jointe [sys_attachment] que vous souhaitez envoyer dans ce message REST.
    Tableau 46. Renvoie
    Type Description
    nul
    (function sampleRESTMessageV2() {
        try {
            var request = new sn_ws.RESTMessageV2();
            request.setHttpMethod('post');
            request.setEndpoint('<web service endpoint URL>');
            request.setRequestBodyFromAttachment('<attachment sys_id>');
            
            var response = request.execute();
            var httpResponseStatus = response.getStatusCode();
          
            gs.info("http response status_code: " + httpResponseStatus);        
        }
        catch (ex) {
            var message = ex.getMessage();
            gs.info(message);
        }
    })();

    RESTMessageV2 - setRequestHeader(nom de chaîne, valeur de chaîne)

    Définit un en-tête HTTP dans le message REST sur la valeur spécifiée.

    Tableau 47. Paramètres
    Nom Type Description
    nom Chaîne Nom de l’en-tête.
    valide Chaîne Valeur à affecter à l’en-tête spécifié.
    Tableau 48. Renvoie
    Type Description
    nul

    Dans l’exemple suivant, remplacez REST_message_record par le nom de l’enregistrement de message REST de votre instance.

    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setRequestHeader("Accept","Application/json");

    RESTMessageV2 : setRequestorProfile(String requestorContext, String requestorId)

    Remplace le profil du demandeur par défaut pour le message REST afin de récupérer un jeton d’accès OAuth associé à un demandeur différent.

    Cette méthode s’applique uniquement aux messages REST configurés pour utiliser l’authentification OAuth 2.0. Cette méthode est facultative et inutile dans la plupart des configurations.

    Tableau 49. Paramètres
    Nom Type Description
    requestorContext Chaîne
    ID du demandeur Chaîne
    Tableau 50. Renvoie
    Type Description
    nul

    RESTMessageV2 - setStringParameter(nom de chaîne, valeur de chaîne)

    Définit une variable de fonction de message REST avec le nom spécifié à partir de l’enregistrement de message REST sur la valeur spécifiée.

    Les caractères XML réservés dans la valeur sont convertis en caractères d’échappement équivalents. Utilisez setStringParameterNoEscape pour définir une variable sans échapper les caractères réservés XML.

    Tableau 51. Paramètres
    Nom Type Description
    nom Chaîne Nom de la variable de message REST. Ce paramètre doit être défini dans l’enregistrement de message REST avant que vous puissiez lui affecter une valeur.
    valide Chaîne Valeur pour affecter la variable.
    Tableau 52. Renvoie
    Type Description
    nul

    Dans l’exemple suivant, remplacez REST_message_record par le nom de l’enregistrement de message REST de votre instance.

    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setStringParameter("s","NOW");

    RESTMessageV2 - setStringParameterNoEscape(nom de chaîne, valeur de chaîne)

    Définit une variable de fonction de message REST avec le nom spécifié à partir de l’enregistrement de message REST sur la valeur spécifiée.

    Cette méthode est équivalente à setStringParameter mais n’échappe pas les caractères réservés XML.

    Tableau 53. Paramètres
    Nom Type Description
    nom Chaîne Nom de la variable de message REST. Ce paramètre doit être défini dans l’enregistrement de message REST avant que vous puissiez lui affecter une valeur.
    valide Chaîne Valeur pour affecter la variable.
    Tableau 54. Renvoie
    Type Description
    nul

    Dans l’exemple suivant, remplacez REST_message_record par le nom de l’enregistrement de message REST de votre instance.

    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
    sm.setStringParameterNoEscape("s","NOW");