RESTMessageV2 - com escopo, global

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 16 min. de leitura
  • A API RESTMessageV2 permite que você envie mensagens REST de saída usando JavaScript.

    Use a API RESTResponseV2 para gerenciar a resposta retornada pelo provedor REST.

    O valor do User-Agent é "ServiceNow/1.0". Para mudar isso, adicione a propriedade do sistema glide.http.user.agent na tabela Propriedades do sistema [sys_properties].

    Esta API é executada no namespace sn_ws.

    RESTMessageV2 – disableForcedVariableSubstituição()

    Desabilita a substituição de variável forçada em mensagens REST de saída.

    Nota:
    O uso de colchetes ou cifrões em sua solicitação pode retornar inadvertidamente uma saída truncada. Se sua solicitação truncar erroneamente a resposta ou dividir a resposta em novas linhas, consulte este artigo da comunidade para obter uma possível solução.
    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 2. Retorna
    Tipo Descrição
    vazio
    var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get");
    sm.disableForcedVariableSubstitution();
    var response = sm.execute();

    RESTMessageV2 – execute()

    Envia a mensagem REST para o endpoint.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 4. Retorna
    Tipo Descrição
    Resposta do REST A resposta retornada pelo provedor REST.

    No exemplo a seguir, substitua REST_message_record pelo nome do registro da mensagem REST da sua instância.

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

    Envia a mensagem REST para o endpoint de forma assíncrona. A instância não espera por uma resposta do provedor de serviço Web ao fazer chamadas assíncronas.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 6. Retorna
    Tipo Descrição
    Resposta do REST A resposta retornada pelo provedor REST.

    No exemplo a seguir, substitua REST_message_record pelo nome do registro da mensagem REST da sua instância. Ao usar executeAsync, considere processar o corpo da resposta em uma regra de negócio separada para aproveitar as vantagens da chamada assíncrona.

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

    Obtém o URL do endpoint para a mensagem REST.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 8. Retorna
    Tipo Descrição
    Cadeia de caracteres O URL do provedor de serviço Web REST.

    No exemplo a seguir, substitua REST_message_record pelo nome do registro da mensagem REST da sua instância.

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

    Obtém o conteúdo do corpo da mensagem REST.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 10. Retorna
    Tipo Descrição
    Cadeia de caracteres o corpo da mensagem REST.

    No exemplo a seguir, substitua REST_message_record pelo nome do registro da mensagem REST da sua instância.

    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(cadeia de caracteres "headerName")

    Obtém o valor de um cabeçalho HTTP especificado na mensagem REST.

    Por padrão, este método não pode retornar o valor de um cabeçalho definido automaticamente pelo sistema. Para conceder a este método acesso a todos os cabeçalhos, defina a propriedade glide.http.log_debug como verdadeiro.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    headerName Cadeia de caracteres Cabeçalho da solicitação para o qual você deseja obter o valor.
    Tabela 12. Retorna
    Tipo Descrição
    Cadeia de caracteres O valor do cabeçalho especificado.

    No exemplo a seguir, substitua REST_message_record pelo nome do registro da mensagem REST da sua instância.

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

    Obtém cabeçalhos HTTP que foram definidos pelo cliente REST e os valores associados.

    Este método não retorna cabeçalhos definidos automaticamente pelo sistema. Para configurar este método para retornar todos os cabeçalhos, defina a propriedade glide.http.log_debug como verdadeiro.

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 14. Retorna
    Tipo Descrição
    Objeto Um objeto que mapeia o nome de cada cabeçalho para o valor associado.

    No exemplo a seguir, substitua REST_message_record pelo nome do registro da mensagem REST da sua instância.

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

    Instancia um objeto RESTMessageV2 vazio.

    Ao usar um objeto instanciado dessa forma, você deve especificar manualmente um método HTTP e um endpoint.

    Tabela 15. Parâmetros
    Nome Tipo Descrição
    Nenhum
    var sm = new sn_ws.RESTMessageV2();

    RESTMessageV2 - RESTMessageV2 (cadeia de caracteres nome, cadeia de caracteres "methodName")

    Instancia um objeto RESTMessageV2 usando informações de um registro de mensagem REST.

    Você deve ter um registro de mensagem REST definido antes de usar este construtor.

    Tabela 16. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres O nome do registro da mensagem REST.
    nomeDométodo Cadeia de caracteres O nome do método HTTP a ser usado, como GET/get ou PUT/put - sem distinção entre maiúsculas e minúsculas.

    No exemplo a seguir, substitua REST_message_record pelo nome do registro da mensagem REST da sua instância.

    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(cadeia de caracteres "tableName", cadeia de caracteres "recordSysId", cadeia de caracteres fileName)

    Configura a mensagem REST para salvar o corpo da resposta retornada como um registro de anexo.

    Quando você usa esta função com uma mensagem REST que é enviada por meio de um MID server, o usuário do MID server deve ter as funções necessárias para ler e gravar registros de anexo, bem como as funções necessárias para ler e gravar registros na tabela especificada em tableName parâmetro.

    O corpo da resposta não precisa ser um arquivo binário para ser salvo como anexo. Corpos de resposta usando formatos de texto, como JSON ou XML, também podem ser salvos. Se a instância não salvar o anexo, chame getErrorMessage() no objeto RESTResponseV2 relacionado para obter detalhes do erro.

    Tabela 17. Parâmetros
    Nome Tipo Descrição
    tableName Cadeia de caracteres Especifique a tabela que contém o registro ao qual você deseja anexar o arquivo salvo.
    recordSysId Cadeia de caracteres Especifique o sys_id do registro ao qual você deseja anexar o arquivo salvo.
    fileName Cadeia de caracteres Especifique o nome do arquivo a ser fornecido ao arquivo salvo.
    Tabela 18. Retorna
    Tipo Descrição
    vazio
    (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(cadeia de caracteres "tableName", cadeia de caracteres "recordSysId", cadeia de caracteres fileName, cadeia de caracteres "encryptContext")

    Configura a mensagem REST para salvar o corpo da resposta retornada como um registro de anexo criptografado.

    Quando você usa esta função com uma mensagem REST que é enviada por meio de um MID server, o usuário do MID server deve ter as funções necessárias para ler e gravar registros de anexo, bem como as funções necessárias para ler e gravar registros na tabela especificada em tableName parâmetro.

    O corpo da resposta não precisa ser um arquivo binário para ser salvo como anexo. Corpos de resposta usando formatos de texto, como JSON ou XML, também podem ser salvos. Se a instância não salvar o anexo, chame getErrorMessage() no objeto RESTResponseV2 relacionado para obter detalhes do erro.

    Tabela 19. Parâmetros
    Nome Tipo Descrição
    tableName Cadeia de caracteres Especifique a tabela que contém o registro ao qual você deseja anexar o arquivo salvo.
    recordSysId Cadeia de caracteres Especifique o sys_id do registro ao qual você deseja anexar o arquivo salvo.
    fileName Cadeia de caracteres Especifique o nome do arquivo a ser fornecido ao arquivo salvo.
    criptografiaContexto Cadeia de caracteres Especifique o sys_id de um contexto de criptografia. O arquivo salvo é criptografado usando este contexto.
    Tabela 20. Retorna
    Tipo Descrição
    vazio

    RESTMessageV2 - setAuthenticationProfile(cadeia de caracteres tipo, cadeia de caracteres profileId)

    Define as credenciais para a mensagem REST usando uma autenticação básica existente ou um perfil OAuth 2.0.

    Tabela 21. Parâmetros
    Nome Tipo Descrição
    tipo Cadeia de caracteres O tipo de perfil de autenticação a ser usado. Os valores válidos são "básico" para usar a autenticação básica ou "oauth2" para usar o OAuth 2.0.
    ID do perfil Cadeia de caracteres O sys_id de um registro de perfil de autenticação. Ao usar a autenticação básica, especifique o sys_id de um registro de configuração de autenticação básica [sys_auth_profile_basic]. Ao usar o OAuth 2.0, especifique o sys_id de um registro de perfil de entidade OAuth [oauth_entity_profile].
    Tabela 22. Retorna
    Tipo Descrição
    vazio

    No exemplo a seguir, substitua REST_message_record pelo nome do registro da mensagem REST da sua instância.

    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(cadeia de caracteres userName, cadeia de caracteres userPass)

    Define cabeçalhos de autenticação básica para a mensagem REST.

    Definir valores de segurança usando este método substitui os valores de autenticação básica definidos para o registro de mensagem REST.

    Tabela 23. Parâmetros
    Nome Tipo Descrição
    userName Cadeia de caracteres Nome de usuário que você deseja usar para autenticar a mensagem REST.
    userPass Cadeia de caracteres Senha para o usuário especificado.
    Tabela 24. Retorna
    Tipo Descrição
    vazio

    No exemplo a seguir, substitua REST_message_record pelo nome do registro da mensagem REST da sua instância.

    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 - setEccCorrelato(cadeia de caracteres correlacionador)

    Associa solicitações de saída e o registro de resposta resultante na fila do ECC. Este método se aplica somente a mensagens REST enviadas por meio de um MID Server.

    O correlacionador fornecido preenche o campo Correlacionador do agente no registro da fila do ECC para a resposta. Forneça um correlacionador exclusivo para cada solicitação de saída para associar os resultados corretos na fila do ECC à solicitação ao projetar automação assíncrona por meio de um MID Server.

    Tabela 25. Parâmetros
    Nome Tipo Descrição
    correlacionador Cadeia de caracteres Identificador exclusivo
    Tabela 26. Retorna
    Tipo Descrição
    vazio

    No exemplo a seguir, substitua REST_message_record pelo nome do registro da mensagem REST da sua instância.

    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(cadeia de caracteres nome, cadeia de caracteres valor)

    Substitui um valor do banco de dados gravando na carga da mensagem REST. Este método se aplica somente a mensagens REST enviadas por meio de um MID Server.

    Use este método quando um valor da mensagem REST no banco de dados for inválido, por exemplo, quando o URL do endpoint for maior do que o tamanho máximo do campo de endpoint REST. Você pode definir somente o URL do endpoint usando este método, passando a origem como o parâmetro de nome.

    Tabela 27. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres O nome do parâmetro, como origem.
    valor Cadeia de caracteres O valor a ser atribuído ao parâmetro especificado.
    Tabela 28. Retorna
    Tipo Descrição
    vazio

    No exemplo a seguir, substitua REST_message_record pelo nome do registro da mensagem REST da sua instância.

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

    Define o endpoint para a mensagem REST.

    Por padrão, a mensagem REST usa o endpoint especificado no registro da mensagem REST. Use este método para substituir este padrão. Você deve chamar este método ao usar o construtor RESTMessageV2 - RESTMessageV2() sem parâmetros.

    Tabela 29. Parâmetros
    Nome Tipo Descrição
    endpoint Cadeia de caracteres O URL do provedor REST com o qual você deseja fazer a interface.
    Tabela 30. Retorna
    Tipo Descrição
    vazio
    var sm = new sn_ws.RESTMessageV2();
    sm.setEndpoint("http://web.service.endpoint");

    RESTMessageV2 - setHttpMethod(cadeia de caracteres "método")

    Define o método HTTP que esta mensagem REST executa, como GET ou PUT.

    Você deve definir um método HTTP ao usar o construtor RESTMessageV2 - RESTMessageV2() sem parâmetros.

    Tabela 31. Parâmetros
    Nome Tipo Descrição
    method Cadeia de caracteres Método HTTP a ser executado.
    Tabela 32. Retorna
    Tipo Descrição
    vazio
    var sm = new sn_ws.RESTMessageV2();
    sm.setHttpMethod("post");

    RESTMessageV2 - setHttpTimeout(Number timeoutMs)

    Define a quantidade de tempo que a mensagem REST espera por uma resposta do provedor de serviço Web antes que a solicitação expire.

    Tabela 33. Parâmetros
    Nome Tipo Descrição
    tempo limiteM Número Quantidade de tempo em milissegundos antes que a chamada para o provedor REST expire.
    Nota:
    Este valor define um tempo limite no soquete e somente expira se o soquete não receber dados dentro do tempo especificado. Para ambientes nos quais as respostas são transmitidas, é possível que as conexões durem muito mais do que o valor de tempo limite.
    Tabela 34. Retorna
    Tipo Descrição
    Nenhum

    Para usar o exemplo a seguir, substitua<REST_message_record> com o nome do registro da mensagem REST da sua instância.

    // 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(cadeia de caracteres em nível)

    Define o nível de log para esta mensagem e a resposta correspondente.

    Definir um nível de log usando a API RESTMessageV2 substitui o nível de log configurado no registro da mensagem REST. Este nível de log pode não se aplicar se o domínio de endpoint for excluído ou se a propriedade glide.outbound_http_log.override for verdadeira. Para exibir logs de serviço Web de saída, navegue até Logs do sistema > Solicitações de saída de HTTP.

    Tabela 35. Parâmetros
    Nome Tipo Descrição
    nível Cadeia de caracteres O nível de log. Os valores válidos são básicos, elevados e todos.
    Tabela 36. Retorna
    Tipo Descrição
    vazio
    var rm = new sn_ws.RESTMessageV2();
    rm.setLogLevel('all');

    RESTMessageV2 - setMIDServer(cadeia de caracteres midServer)

    Configura a mensagem REST para se comunicar por meio de um MID Server.

    Tabela 37. Parâmetros
    Nome Tipo Descrição
    midServer Cadeia de caracteres Nome do MID Server a ser usado. Sua instância deve ter um ativo MID Server com o nome especificado.
    Tabela 38. Retorna
    Tipo Descrição
    vazio

    No exemplo a seguir, substitua REST_message_record pelo nome do registro da mensagem REST da sua instância.

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

    Define o perfil do protocolo de autenticação mútua para a mensagem REST.

    Definir um perfil de protocolo usando este método substitui o perfil de protocolo selecionado para o registro da mensagem REST.

    Tabela 39. Parâmetros
    Nome Tipo Descrição
    profileName Cadeia de caracteres O Nome do perfil de protocolo a ser usado para autenticação mútua.
    Tabela 40. Retorna
    Tipo Descrição
    vazio

    No exemplo a seguir, substitua REST_message_record pelo nome do registro da mensagem REST da sua instância.

    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(cadeia de caracteres nome, cadeia de caracteres valor)

    Acrescenta um parâmetro ao final da URL de solicitação com o formulário name=value.

    Por exemplo, o código setQueryParameter("sysparm_query","active=true^ORDERBYnumber^ORDERBYDESCcategory"); anexa o texto sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory ao URL da solicitação.

    Tabela 41. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres Nome do parâmetro de URL a ser passado.
    valor Cadeia de caracteres Valor a ser atribuído ao parâmetro de URL.
    Tabela 42. Retorna
    Tipo Descrição
    vazio
    var sm = new sn_ws.RESTMessageV2();
    //Set up message, including endpoint and authentication
    sm.setQueryParameter("sysparm_query","active=true^ORDERBYnumber^ORDERBYDESCcategory");

    RESTMessageV2 - setRequestBody(cadeia de caracteres corpo)

    Define o conteúdo do corpo a ser enviado ao provedor de serviço Web ao usar os métodos HTTP PUT ou POST.

    Quando você define o conteúdo do corpo usando este método, as variáveis no corpo não são substituídas por parâmetros do registro da função da mensagem REST. Você deve definir explicitamente todos os valores no corpo da mensagem REST.

    Tabela 43. Parâmetros
    Nome Tipo Descrição
    corpo Cadeia de caracteres Corpo da solicitação a ser enviado.
    Tabela 44. Retorna
    Tipo Descrição
    vazio
    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(cadeia de caracteres attachmentSysId)

    Define o corpo da solicitação usando um registro de anexo existente.

    Quando você usa esta função com uma mensagem REST enviada por meio de um MID Server, o usuário MID Server deve ter as funções necessárias para ler registros de anexo.

    Tabela 45. Parâmetros
    Nome Tipo Descrição
    attachmentSysId Cadeia de caracteres Sys_id do registro do anexo [sys_attachment] que você deseja enviar nesta mensagem REST.
    Tabela 46. Retorna
    Tipo Descrição
    vazio
    (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(cadeia de caracteres nome, cadeia de caracteres valor)

    Define um cabeçalho HTTP na mensagem REST para o valor especificado.

    Tabela 47. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres Nome do cabeçalho.
    valor Cadeia de caracteres Valor a ser atribuído ao cabeçalho especificado.
    Tabela 48. Retorna
    Tipo Descrição
    vazio

    No exemplo a seguir, substitua REST_message_record pelo nome do registro da mensagem REST da sua instância.

    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(cadeia de caracteres requestorContext, cadeia de caracteres requestorId)

    Substitui o perfil de solicitante padrão da mensagem REST para recuperar um token de acesso OAuth associado a um solicitante diferente.

    Este método se aplica somente a mensagens REST configuradas para usar a autenticação OAuth 2.0. Este método é opcional e desnecessário na maioria das configurações.

    Tabela 49. Parâmetros
    Nome Tipo Descrição
    Contexto do solicitante Cadeia de caracteres
    ID do solicitante Cadeia de caracteres
    Tabela 50. Retorna
    Tipo Descrição
    vazio

    RESTMessageV2 - setStringParameter(cadeia de caracteres nome, cadeia de caracteres valor)

    Define uma variável de função de mensagem REST com o nome especificado do registro de mensagem REST para o valor especificado.

    Os caracteres XML reservados no valor são convertidos para os caracteres de escape equivalentes. Use setStringParameterNoEscape para definir uma variável sem escapar de caracteres XML reservados.

    Tabela 51. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres Nome da variável da mensagem REST. Este parâmetro deve ser definido no registro da mensagem REST antes que você possa atribuir um valor a ele.
    valor Cadeia de caracteres Valor a ser atribuído à variável.
    Tabela 52. Retorna
    Tipo Descrição
    vazio

    No exemplo a seguir, substitua REST_message_record pelo nome do registro da mensagem REST da sua instância.

    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(cadeia de caracteres nome, cadeia de caracteres valor)

    Define uma variável de função de mensagem REST com o nome especificado do registro de mensagem REST para o valor especificado.

    Este método é equivalente a setStringParameter, mas não escapa de caracteres XML reservados.

    Tabela 53. Parâmetros
    Nome Tipo Descrição
    nome Cadeia de caracteres Nome da variável da mensagem REST. Este parâmetro deve ser definido no registro da mensagem REST antes que você possa atribuir um valor a ele.
    valor Cadeia de caracteres Valor a ser atribuído à variável.
    Tabela 54. Retorna
    Tipo Descrição
    vazio

    No exemplo a seguir, substitua REST_message_record pelo nome do registro da mensagem REST da sua instância.

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