SOAPMessageV2 - com escopo, global

SOAPMessageV2 – execute()

Envia a mensagem SOAP para o endpoint.

Tabela 1. Parâmetros
Nome	Tipo	Descrição
Nenhum

Tabela 2. Retorna
Tipo	Descrição
SOAPResponseV2 - com escopo, global	Resposta retornada pelo provedor SOAP.

var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //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.

SOAPMessageV2 – executeAsync()

Envia a mensagem SOAP para a fila do ECC.

As mensagens SOAP na fila do ECC são processadas pela regra de negócios SOAPClient.

Por padrão, esta regra de negócios não é executada de forma assíncrona. Para configurar esta regra de negócios para ser executada de forma assíncrona, defina o valor Quando como Assíncrono e adicione current.update() ao final do Script. A instância não espera por uma resposta do provedor de serviço Web ao enviar uma mensagem por meio da fila do ECC.

Tabela 3. Parâmetros
Nome	Tipo	Descrição
Nenhum

Tabela 4. Retorna
Tipo	Descrição
SOAPResponseV2 - com escopo, global	Resposta retornada pelo provedor SOAP. Nota: Tentar usar o objeto de resposta SOAP antes que a resposta seja processada pode resultar em um erro de tempo limite.

var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
var response = sm.executeAsync();

SOAPMessageV2 – getEndpoint()

Obtém o endpoint da mensagem SOAP.

Tabela 5. Parâmetros
Nome	Tipo	Descrição
Nenhum

Tabela 6. Retorna
Tipo	Descrição
Cadeia de caracteres	URL do provedor de serviço Web SOAP.

var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
var endpoint = sm.getEndpoint();

SOAPMessageV2 – getRequestBody()

Retorna o conteúdo do corpo da mensagem SOAP.

Nota:

Antes de chamar o método getRequestBody(), você deve chamar o método execute() para obter o objeto de resposta.

Tabela 7. Parâmetros
Nome	Tipo	Descrição
Nenhum

Tabela 8. Retorna
Tipo	Descrição
Cadeia de caracteres	Corpo da mensagem SOAP.

var sm = new sn_ws.SOAPMessageV2("StockQuote","StockQuoteSoap.GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
var response = sm.execute();
var requestBody = response.getRequestBody();

SOAPMessageV2 - getRequestHeader(cadeia de caracteres "headerName")

Obtém o valor de um cabeçalho HTTP especificado pelo cliente SOAP.

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 9. Parâmetros
Nome	Tipo	Descrição
headerName	Cadeia de caracteres	Cabeçalho da solicitação para o qual você deseja obter o valor.

Tabela 10. Retorna
Tipo	Descrição
Cadeia de caracteres	Valor do cabeçalho especificado.

var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
var header = sm.getRequestHeader("Accept");

SOAPMessageV2 – getRequestHeaders()

Obtém cabeçalhos HTTP que foram definidos pelo cliente SOAP 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 11. Parâmetros
Nome	Tipo	Descrição
Nenhum

Tabela 12. Retorna
Tipo	Descrição
Objeto	Objeto que mapeia o nome de cada cabeçalho para o valor associado.

var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
var requestHeaders = sm.getRequestHeaders();

SOAPMessageV2 - setBasicAuth(cadeia de caracteres userName, cadeia de caracteres userPass)

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

Definir cabeçalhos de autenticação básica usando este método substitui os valores de autenticação básica definidos no registro da mensagem SOAP.

Tabela 13. Parâmetros
Nome	Tipo	Descrição
userName	Cadeia de caracteres	Nome de usuário a ser usado ao autenticar a mensagem SOAP.
userPass	Cadeia de caracteres	Senha para o usuário especificado.

Tabela 14. Retorna
Tipo	Descrição
vazio

var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setBasicAuth("username","password");

SOAPMessageV2 - setEccCorrelato(correlator 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 SOAP 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 15. Parâmetros
Nome	Tipo	Descrição
correlacionador	Cadeia de caracteres	Identificador exclusivo

Tabela 16. Retorna
Tipo	Descrição
vazio

var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setEccCorrelator("unique_id");

SOAPMessageV2 - setEccParameter(cadeia de caracteres nome, cadeia de caracteres valor)

Substitui um valor do banco de dados gravando na carga da mensagem SOAP.

Este método se aplica somente a mensagens SOAP enviadas por meio de um MID Server. Use este método quando um valor da mensagem SOAP 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 SOAP.

Esses são valores válidos para o parâmetro de nome.

source: a URL do endpoint.
name: A função de mensagem SOAP a ser executada.

Tabela 17. Parâmetros
Nome	Tipo	Descrição
nome	Cadeia de caracteres	Nome do parâmetro ECC.
valor	Cadeia de caracteres	Valor a ser atribuído ao parâmetro ECC especificado.

Tabela 18. Retorna
Tipo	Descrição
vazio

var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setEccParameter("source","http://very.long.endpoint");

SOAPMessageV2 - setEndpoint(endpoint de cadeia de caracteres)

Define o endpoint da mensagem SOAP.

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

Tabela 19. Parâmetros
Nome	Tipo	Descrição
endpoint	Cadeia de caracteres	URL do provedor de serviço Web SOAP com o qual você deseja interagir.

Tabela 20. Retorna
Tipo	Descrição
vazio

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

SOAPMessageV2 - setHttpTimeout(Number timeoutMs)

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

Tabela 21. Parâmetros
Nome	Tipo	Descrição
tempo limiteM	Número	Quantidade de tempo de espera por uma resposta do provedor de serviço Web, em milissegundos.

Tabela 22. Retorna
Tipo	Descrição
vazio

var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setHttpTimeout(6000);

SOAPMessageV2 - 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 SOAPMessageV2 substitui o nível de log configurado no registro da mensagem SOAP. 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 23. 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 24. Retorna
Tipo	Descrição
vazio

SOAPMessageV2 - setMIDServer(cadeia de caracteres midServerName)

Configura a mensagem SOAP a ser enviada por meio de um MID Server.

Por padrão, a mensagem SOAP usa o MID Server especificado no registro de função da mensagem SOAP. Use este método para substituir o padrão.

Tabela 25. Parâmetros
Nome	Tipo	Descrição
midServerName	Cadeia de caracteres	Nome do MID Server pelo qual você deseja enviar a mensagem SOAP. Sua instância deve ter um ativo MID Server com o nome especificado.

Tabela 26. Retorna
Tipo	Descrição
vazio

SOAPMessageV2 - setMutualAuth(cadeia de caracteres profileName)

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

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

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

Tabela 28. Retorna
Tipo	Descrição
vazio

var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setMutualAuth("auth_profile_name");

SOAPMessageV2 - setRequestBody(cadeia de caracteres requestBody)

Define o conteúdo do corpo a ser enviado ao provedor de serviço Web.

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 da mensagem SOAP. Você deve definir explicitamente todos os valores no corpo da mensagem SOAP.

Tabela 29. Parâmetros
Nome	Tipo	Descrição
requestBody	Cadeia de caracteres	Corpo da mensagem SOAP.

Tabela 30. Retorna
Tipo	Descrição
vazio

var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
var body = "<SOAP message body>";
sm.setRequestBody(body);

SOAPMessageV2 - setRequestHeader(cadeia de caracteres headerName, cadeia de caracteres headerValue)

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

Tabela 31. Parâmetros
Nome	Tipo	Descrição
headerName	Cadeia de caracteres	Nome do cabeçalho.
headerValue	Cadeia de caracteres	Valor a ser atribuído ao cabeçalho especificado.

Tabela 32. Retorna
Tipo	Descrição
vazio

var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setRequestHeader("Accept","Application/json");

SOAPMessageV2 - setSOAPAction(cadeia de caracteres soapAction)

Define a ação SOAP que esta mensagem SOAP executa.

O WSDL do seu provedor de serviço Web lista as ações SOAP que você pode executar. Você deve chamar este método ao usar o construtor SOAPMessageV2() sem parâmetros.

Tabela 33. Parâmetros
Nome	Tipo	Descrição
ação_soap	Cadeia de caracteres	A ação SOAP que esta mensagem SOAP executa.

Tabela 34. Retorna
Tipo	Descrição
vazio

var sm = new sn_ws.SOAPMessageV2();
sm.setSOAPAction("GetQuote");
//construct SOAP message by specifying endpoint and auth
sm.execute();

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

Define uma variável com o nome especificado do registro de mensagem SOAP para o valor especificado.

Os caracteres XML reservados no valor são convertidos para os caracteres de escape equivalentes.

Tabela 35. Parâmetros
Nome	Tipo	Descrição
nome	Cadeia de caracteres	Nome da variável da mensagem SOAP.
valor	Cadeia de caracteres	Valor a ser atribuído à variável especificada.

Tabela 36. Retorna
Tipo	Descrição
vazio

var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setStringParameter("symbol","NOW");

SOAPMessageV2 - setStringParameterNoEscape(cadeia de caracteres nome, cadeia de caracteres valor)

Define uma variável com o nome especificado do registro de mensagem SOAP para o valor especificado.

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

Tabela 37. Parâmetros
Nome	Tipo	Descrição
nome	Cadeia de caracteres	Nome da variável da mensagem SOAP.
valor	Cadeia de caracteres	Valor a ser atribuído à variável especificada.

Tabela 38. Retorna
Tipo	Descrição
vazio

var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setStringParameterNoEscape("symbol","NOW");

SOAPMessageV2 - setWSSecurity(cadeia de caracteres keystoreId, cadeia de caracteres keystoreAlias, cadeia de caracteres keystorePassword, cadeia de caracteres certificateId)

Define valores de segurança do serviço Web para a mensagem SOAP.

Definir valores de segurança usando este método substitui os valores de segurança do serviço Web definidos para o registro da mensagem SOAP.

Tabela 39. Parâmetros
Nome	Tipo	Descrição
keystoreId	Cadeia de caracteres	Sys_id do armazenamento de chaves Java ou PKCS12 a ser usado.
keystoreAlias	Cadeia de caracteres	Alias que identifica as chaves públicas e privadas.
keystoreSenha	Cadeia de caracteres	Senha atribuída ao registro de armazenamento de chaves.
ID do certificado	Cadeia de caracteres	Sys_id do certificado do servidor confiável.

Tabela 40. Retorna
Tipo	Descrição
vazio

var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setWSSecurity("70d65e074f3812001f6eac118110c71a","Quote keys","UXr82cqX75Z7MaSa+EyjGA==","ba969a074f3812001f6eac118110c76d");

SOAPMessageV2 - SOAPMessageV2()

Instancia um objeto SOAPMessageV2 vazio.

Ao usar um objeto instanciado dessa forma, você deve especificar manualmente uma ação SOAP e um endpoint.

Tabela 41. Parâmetros
Nome	Tipo	Descrição
Nenhum

var sm = new sn_ws.SOAPMessageV2();

SOAPMessageV2 - SOAPMessageV2 (cadeia de caracteres soapMessage, cadeia de caracteres soapFunction)

Instancia um objeto SOAPMessageV2 de um registro de mensagem SOAP e uma função associada a esse registro.

Valores como as configurações de endpoint, autenticação ou MID Server do registro da mensagem SOAP se aplicam a este objeto.

Tabela 42. Parâmetros
Nome	Tipo	Descrição
SOAPMessage	Cadeia de caracteres	Registro de mensagem SOAP que você deseja usar como base para este objeto.
SOAPFunction	Cadeia de caracteres	Função SOAP que você deseja executar. As funções SOAP disponíveis dependem do WSDL fornecido pelo provedor de serviço Web.

var sm = new sn_ws.SOAPMessageV2("StockQuote","GetQuote"); //Might throw exception if message doesn't exist or not visible due to scope.