RESTMessageV2 - escopo, global

. RESTMessageV2 A API fornece métodos que permitem enviar mensagens REST de saída usando JavaScript.

Use esta API 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 sn_ws namespace.

RESTMessageV2 - RESTMessageV2()

Instancia um objeto RESTMessageV2 vazio.

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

Tabela 1. Parâmetros

Nome	Tipo	Descrição
Nenhum

var sm = new sn_ws.RESTMessageV2();

RESTMessageV2 - RESTMessageV2 (nome da cadeia de caracteres, nome do método da cadeia de caracteres)

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

Um registro de mensagem REST deve ser definido antes de usar este construtor. Para obter instruções, consulte Criar uma mensagem REST.

Tabela 2. Parâmetros

Nome	Tipo	Descrição
nome	Cadeia de caracteres	O nome do registro de mensagem REST na tabela Mensagem REST [sys_rest_message].
NomeMétodo	Cadeia de caracteres	O nome do método HTTP a ser usado, como GET/GET ou PUT/PUT - não diferencia maiúsculas de minúsculas.

No exemplo a seguir, substitua REST_message_record Com o nome do registro de 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 - disableForcedVariableSubstitution()

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

Nota:

O uso de chaves ou cifrões em sua solicitação pode retornar inadvertidamente uma saída truncada. Se sua solicitação truncar incorretamente a resposta ou dividir a resposta em novas linhas, consulte Este artigo da Comunidade para uma possível solução.

Tabela 3. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 4. 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 5. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 6. Retorna

Tipo	Descrição
RESTResponse	A resposta retornada pelo provedor REST.

No exemplo a seguir, substitua REST_message_record Com o nome do registro de 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 aguarda uma resposta do provedor de serviços da Web ao fazer chamadas assíncronas.

Tabela 7. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 8. Retorna

Tipo	Descrição
RESTResponse	A resposta retornada pelo provedor REST.

No exemplo a seguir, substitua REST_message_record Com o nome do registro de mensagem REST da sua instância. Ao usar ExecutoAsync considere processar o corpo da resposta em uma regra de negócios separada para aproveitar a 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 da mensagem REST.

Tabela 9. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 10. Retorna

Tipo	Descrição
Cadeia de caracteres	O URL do provedor de serviços web REST.

No exemplo a seguir, substitua REST_message_record Com o nome do registro de 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 11. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 12. Retorna

Tipo	Descrição
Cadeia de caracteres	O corpo da mensagem REST.

No exemplo a seguir, substitua REST_message_record Com o nome do registro de 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 acesso a este método a todos os cabeçalhos, defina a propriedade glide.http.log_debug como verdadeira.

Tabela 13. Parâmetros

Nome	Tipo	Descrição
headerName	Cadeia de caracteres	Cabeçalho da solicitação para o qual você deseja obter o valor.

Tabela 14. Retornos

Tipo	Descrição
Cadeia de caracteres	O valor do cabeçalho especificado.

No exemplo a seguir, substitua REST_message_record Com o nome do registro de 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 verdadeira.

Tabela 15. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 16. 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 Com o nome do registro de 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 - saveResponseBodyAsAttachment(cadeia de caracteres tablename, cadeia de caracteres recordSysId, cadeia de caracteres do nome do arquivo)

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

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

O corpo da resposta não precisa ser um arquivo binário para ser salvo como um anexo. Corpos de resposta que usam 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.
nomeArquivo	Cadeia de caracteres	Especifique o nome do arquivo a ser fornecido ao arquivo salvo.

Tabela 18. Retornos

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 de resposta retornado como um registro de anexo criptografado.

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

O corpo da resposta não precisa ser um arquivo binário para ser salvo como um anexo. Corpos de resposta que usam 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.
nomeArquivo	Cadeia de caracteres	Especifique o nome do arquivo a ser fornecido ao arquivo salvo.
EncryptContext	Cadeia de caracteres	Especifique o sys_id de um contexto de criptografia. O arquivo salvo é criptografado usando este contexto.

Tabela 20. Retornos

Tipo	Descrição
vazio

RESTMessageV2 - setAllowedRedirectURIs(URIs de matriz)

Define um ou mais URIs com permissão para serem redirecionados. Controlar os URIs de saída permitidos reduz as preocupações de segurança e ajuda a impedir ataques de redirecionamento de URL que enviam os usuários para sites mal-intencionados.

Para obter um meio mais abrangente de redirecionar URIs, consulte UriMatcher - Com escopo.

Tabela 21. Parâmetros

Nome	Tipo	Descrição
URIs	Matriz	Um ou mais URIs permitidos para redirecionamento. Cada URI deve ser listado no formato "cadeia de caracteres".

Tabela 22. Retornos

Tipo	Descrição
Nenhum(a)

O exemplo a seguir mostra como adicionar um ou mais URLs permitidos para redirecionamento para um método de mensagem REST.

// Redirection URI Allow list
try{
	var rm = new sn_ws.RESTMessageV2('<REST_message_record>', '<REST_Msg_method_name>');
	rm.setAllowedRedirectURIs(['https://www.google.com']);

	var response = rm.execute();
	var responseBody = response.getBody();
	var httpStatus = response.getStatusCode();
	gs.info(responseBody);
	gs.info(httpStatus);
} catch(ex) {
	var message = ex.getMessage();
}

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

Define as credenciais da mensagem REST usando um perfil de autenticação básica existente ou OAuth 2,0.

Tabela 23. 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 autenticação básica ou "oAuth2" para usar o OAuth 2,0.
profileId	Cadeia de caracteres	O sys_id de um registro de perfil de autenticação. Ao usar autenticação básica, especifique o sys_id de um registro Configuração de autenticação básica [sys_auth_profile_basic]. Ao usar o OAuth 2,0, especifique o sys_id de um registro Perfil de entidade OAuth [oauth_entity_profile].

Tabela 24. Retornos

Tipo	Descrição
vazio

No exemplo a seguir, substitua REST_message_record Com o nome do registro de 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 de nome de usuário, 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 25. 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 do usuário especificado.

Tabela 26. Retornos

Tipo	Descrição
vazio

No exemplo a seguir, substitua REST_message_record Com o nome do registro de 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 - setEccCorrelacionator(correlacionador de cadeia de caracteres)

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 Correlacionador de agente Campo 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 27. Parâmetros

Nome	Tipo	Descrição
correlacionador	Cadeia de caracteres	Identificador único

Tabela 28. Retornos

Tipo	Descrição
vazio

No exemplo a seguir, substitua REST_message_record Com o nome do registro de 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(nome da cadeia de caracteres, valor da cadeia de caracteres)

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, como quando a URL do endpoint for maior do que o tamanho máximo do campo do endpoint REST. Você pode definir somente o URL do endpoint usando este método passando source como o parâmetro name.

Tabela 29. 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 30. Retornos

Tipo	Descrição
vazio

No exemplo a seguir, substitua REST_message_record Com o nome do registro de 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 da mensagem REST.

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

Tabela 31. Parâmetros

Nome	Tipo	Descrição
endpoint	Cadeia de caracteres	O URL do provedor REST com o qual você deseja fazer interface.

Tabela 32. Retornos

Tipo	Descrição
vazio

var sm = new sn_ws.RESTMessageV2();
sm.setEndpoint("http://web.service.endpoint");

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

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

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

Tabela 33. Parâmetros

Nome	Tipo	Descrição
method	Cadeia de caracteres	Define o método HTTP que esta mensagem REST executa. O método HTTP fornecido não diferencia maiúsculas de minúsculas. Os seguintes métodos HTTP são compatíveis: GET POST PUT PATCH DELETE HEAD

Tabela 34. Retornos

Tipo	Descrição
vazio

var sm = new sn_ws.RESTMessageV2();
sm.setHttpMethod("post");

RESTMessageV2 - setHtttpTimeout(Number timeoutMs)

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

Tabela 35. Parâmetros

Nome	Tipo	Descrição
TimeoutMs	Número	Tempo em milissegundos antes que a chamada para o provedor REST atinja o tempo limite. Nota: Este valor define um tempo limite no soquete e o tempo limite somente se o soquete não receber dados dentro do tempo especificado. Para ambientes em que as respostas são transmitidas, é possível que as conexões durem muito mais do que o valor do tempo limite.

Tabela 36. Retornos

Tipo	Descrição
Nenhum(a)

Para usar o exemplo a seguir, substitua <REST_message_record> Com o nome do registro de 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 (nível de cadeia de caracteres)

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

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

Tabela 37. Parâmetros

Nome	Tipo	Descrição
nível	Cadeia de caracteres	O nível de log. Os valores válidos são básico, elevado e todos.

Tabela 38. Retornos

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 39. Parâmetros

Nome	Tipo	Descrição
MidServer	Cadeia de caracteres	Nome do MID Server para usar. Sua instância deve ter um ativo MID Server com o nome especificado.

Tabela 40. Retornos

Tipo	Descrição
vazio

No exemplo a seguir, substitua REST_message_record Com o nome do registro de 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 de mensagem REST.

Tabela 41. Parâmetros

Nome	Tipo	Descrição
profileName	Cadeia de caracteres	. Nome do perfil de protocolo a ser usado para autenticação mútua.

Tabela 42. Retornos

Tipo	Descrição
vazio

No exemplo a seguir, substitua REST_message_record Com o nome do registro de 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(nome da cadeia de caracteres, valor da cadeia de caracteres)

Anexa um parâmetro ao final da URL da solicitação com o nome do formulário.

Por exemplo, o código setQueryParameter("sysparm_query","active

Tabela 43. Parâmetros

Nome	Tipo	Descrição
nome	Cadeia de caracteres	Nome do parâmetro de URL a ser aprovado.
valor	Cadeia de caracteres	Valor para atribuir o parâmetro de URL.

Tabela 44. Retornos

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

Define o conteúdo do corpo a ser enviado ao provedor de serviços da Web ao usar 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 de função de mensagem REST. Você deve definir explicitamente todos os valores no corpo da mensagem REST.

Tabela 45. Parâmetros

Nome	Tipo	Descrição
corpo	Cadeia de caracteres	Corpo da solicitação a ser enviado.

Tabela 46. Retornos

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 que é enviada por meio de um MID Server. MID Server o usuário deve ter todas as funções necessárias para ler registros de anexo.

Tabela 47. Parâmetros

Nome	Tipo	Descrição
attachmentSysId	Cadeia de caracteres	Sys_id do registro Anexo [sys_attachment] que você deseja enviar nesta mensagem REST.

Tabela 48. Retornos

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

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

Tabela 49. 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 50. Retornos

Tipo	Descrição
vazio

No exemplo a seguir, substitua REST_message_record Com o nome do registro de 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 do 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 autenticação OAuth 2,0. Este método é opcional e é desnecessário na maioria das configurações.

Tabela 51. Parâmetros

Nome	Tipo	Descrição
Solicitante	Cadeia de caracteres
Solicitante	Cadeia de caracteres

Tabela 52. Retornos

Tipo	Descrição
vazio

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

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 reservados XML no valor são convertidos em caracteres de escape equivalentes. Usar SetStringParameterNoEscape Para definir uma variável sem escapar caracteres reservados XML.

Tabela 53. Parâmetros

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

Tabela 54. Retornos

Tipo	Descrição
vazio

No exemplo a seguir, substitua REST_message_record Com o nome do registro de 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(nome da cadeia de caracteres, valor da cadeia de caracteres)

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 caracteres XML reservados.

Tabela 55. Parâmetros

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

Tabela 56. Retornos

Tipo	Descrição
vazio

No exemplo a seguir, substitua REST_message_record Com o nome do registro de 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");