Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Introdução


    O Web Service wsConsultaSQL é responsável pela execução de consultas sql do sistema


Como funciona


   Estão expostos no wsConsultaSQL alguns serviços, onde para consumi-los é necessário enviar através de uma requisição um envelope SOAP, passando os parâmetros de cada serviço.

  

Serviços Disponíveis


Expandir
titleRealizarConsultaSQL

Serviço responsável por executar consultas sql do sistema

Deck of Cards
id1
Card
labelRequest

Os parâmetros solicitado pelo RealizarConsultaSQL são:

codSentenca tipo String

codColigada tipo Int

codSistema tipo String

parameters tipo String

Bloco de código
languagexml
titleRequest
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <tot:RealizarConsultaSQL>
         <!--Optional:-->
         <tot:codSentenca>wsExemplo</tot:codSentenca>
         <!--Optional:-->
         <tot:codColigada>1</tot:codColigada>
         <!--Optional:-->
         <tot:codSistema>G</tot:codSistema>
         <!--Optional:-->
         <tot:parameters>CODUSUARIO=MESTRE</tot:parameters>
      </tot:RealizarConsultaSQL>
   </soapenv:Body>
</soapenv:Envelope>
Card
labelResponse
Bloco de código
languagexml
titleResponse
 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <RealizarConsultaSQLResponse xmlns="http://www.totvs.com/">
         <RealizarConsultaSQLResult><![CDATA[<NewDataSet>
  <Resultado>
    <CODUSUARIO>mestre</CODUSUARIO>
    <NOME>Usuário Mestre</NOME>
    <STATUS>1</STATUS>
    <DATAINICIO>1997-01-01T00:00:00</DATAINICIO>
    <SENHA>oaEGFhDF</SENHA>
    <CONTROLE>27621</CONTROLE>
    <ULTIMACOLIGADA>1</ULTIMACOLIGADA>
    <CODACESSO>Acesso02</CODACESSO>
    <DTAEXPSENHA>2014-05-08T00:00:00</DTAEXPSENHA>
    <OBRIGAALTERARSENHA>F</OBRIGAALTERARSENHA>
    <NUMLOGININVALIDO>0</NUMLOGININVALIDO>
    <EMAIL>[email protected]</EMAIL>
    <ACESSONET>T</ACESSONET>
    <DATAULTIMOACESSO>2015-07-14T13:48:54.417</DATAULTIMOACESSO>
    <CODUSUARIOREDE>matheus.sena</CODUSUARIOREDE>
    <DOMINIOREDE>BH01</DOMINIOREDE>
    <DATAULTIMOACESSOVALIDO>2015-07-14T13:48:54.44</DATAULTIMOACESSOVALIDO>
    <RECMODIFIEDBY>mestre</RECMODIFIEDBY>
    <RECMODIFIEDON>2015-07-14T13:48:54</RECMODIFIEDON>
    <USERID>5ddcc1c2-94b4-4974-8ed3-99aeb3dee5cf</USERID>
  </Resultado>
</NewDataSet>]]></RealizarConsultaSQLResult>
      </RealizarConsultaSQLResponse>
   </s:Body>
</s:Envelope>
Expandir
titleRealizarConsultaSQLContexto

Serviço responsável por executar consultas sql do sistema, possibilitando informar um contexto para execução.

Deck of Cards
id1
Card
labelRequest

Os parâmetros solicitado pelo RealizarConsultaSQLContexto são:

codSentenca tipo String

codColigada tipo Int

codSistema tipo String

parameters tipo String

context tipo Stringcontext tipo String  (a partir das versões 12.1.31.xxx. 12.1.32.xxx, 12.1.33.xxx e 12.1.34)

Bloco de código
languagexml
titleRequest
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <tot:RealizarConsultaSQL>RealizarConsultaSQLContexto>
         <!--Optional:-->
         <tot:codSentenca>wsExemplo</tot:codSentenca>
         <!--Optional:-->
         <tot:codColigada>1</tot:codColigada>
         <!--Optional:-->
         <tot:codSistema>G</tot:codSistema>
         <!--Optional:-->
         <tot:parameters>CODUSUARIO=MESTRE</tot:parameters>
         <!--Optional:-->
         <tot:context>CODCOLIGADA=1</tot:context>
      </tot:RealizarConsultaSQL>RealizarConsultaSQLContexto>
   </soapenv:Body>
</soapenv:Envelope>
Card
labelResponse
Bloco de código
languagexml
titleResponse
 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <RealizarConsultaSQLResponse<RealizarConsultaSQLContextoResponse xmlns="http://www.totvs.com/">
         <RealizarConsultaSQLResult><<RealizarConsultaSQLContextoResult><![CDATA[<NewDataSet>
  <Resultado>
    <CODUSUARIO>mestre</CODUSUARIO>
    <NOME>Usuário Mestre</NOME>
    <STATUS>1</STATUS>
    <DATAINICIO>1997-01-01T00:00:00</DATAINICIO>
    <SENHA>oaEGFhDF</SENHA>
    <CONTROLE>27621</CONTROLE>
    <ULTIMACOLIGADA>1</ULTIMACOLIGADA>
    <CODACESSO>Acesso02</CODACESSO>
    <DTAEXPSENHA>2014-05-08T00:00:00</DTAEXPSENHA>
    <OBRIGAALTERARSENHA>F</OBRIGAALTERARSENHA>
    <NUMLOGININVALIDO>0</NUMLOGININVALIDO>
    <EMAIL>[email protected]</EMAIL>
    <ACESSONET>T</ACESSONET>
    <DATAULTIMOACESSO>2015-07-14T13:48:54.417</DATAULTIMOACESSO>
    <CODUSUARIOREDE>matheus.sena</CODUSUARIOREDE>
    <DOMINIOREDE>BH01</DOMINIOREDE>
    <DATAULTIMOACESSOVALIDO>2015-07-14T13:48:54.44</DATAULTIMOACESSOVALIDO>
    <RECMODIFIEDBY>mestre</RECMODIFIEDBY>
    <RECMODIFIEDON>2015-07-14T13:48:54</RECMODIFIEDON>
    <USERID>5ddcc1c2-94b4-4974-8ed3-99aeb3dee5cf</USERID>
  </Resultado>
</NewDataSet>]]></RealizarConsultaSQLResult>RealizarConsultaSQLContextoResult>
      </RealizarConsultaSQLResponse>RealizarConsultaSQLContextoResponse>
   </s:Body>
</s:Envelope>
Avisoinfo
titleContext

A partir das versões 12.1.31.xxx. 12.1.32.xxx12.1.33.xxx e 12.1.34 será obrigatório o preenchimento do contexto para as sentenças As Sentenças SQL cadastradas na Coligada Global (coligada zero) para fins de segurança de perfil/usuário. Caso o mesmo não seja informado será exibida uma mensagem de validação.são executadas levando em consideração todas as coligadas que o usuário possui permissão.

Exemplo: Um usuário possui permissão na coligada 1 e na coligada 2 e possui filtro por perfil cadastrados em ambas as coligadas.  Ao executar uma sentença da Coligada Global o sistema irá restringir o resultado de acordo com os filtros cadastrados em ambas as coligadas.

Caso o usuário queira restringir o resultado levando em consideração apenas uma coligada específica, basta informar a coligada no contexto, conforme exemplo abaixo.

Bloco de código
languagexml
<soapenv
Bloco de código
<s:Envelope xmlns:ssoapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
   <s<soapenv:Header/>
   <soapenv:Body>
      <s<tot:Fault>RealizarConsultaSQLContexto>
         <!--Optional:-->
        <faultcode xmlns:a="http://schemas.microsoft.com/net/2005/12/windowscommunicationfoundation/dispatcher">a:InternalServiceFault</faultcode><tot:codSentenca>wsExemplo</tot:codSentenca>
         <faultstring xml:lang="pt-BR">Para executar consultas sql pertencentes a Coligada Global (Coligada 0), deve-se informar também uma Coligada válida para o Contexto de Execução. Exemplo: '<tot:context>CODCOLIGADA=1</tot:context>'</faultstring><!--Optional:-->
         <tot:codColigada>0</tot:codColigada>
         <!--Optional:-->
         <tot:codSistema>G</tot:codSistema>
         <!--Optional:-->
         <tot:parameters>CODUSUARIO=MESTRE</tot:parameters>
         <!--Optional:-->
         <tot:context>CODCOLIGADA=1</tot:context>
      </stot:Fault>RealizarConsultaSQLContexto>
   </ssoapenv:Body>
</s:Envelope>soapenv:Envelope>
Nota
titleImportante saber que:
  • Sentenças SQL cadastradas em uma coligada específica, por exemplo Coligada 1, sempre será executada no contexto da Coligada 1 mesmo que seja informada uma outra coligada no contexto.
  • Sentenças SQL cadastradas na Coligada Global será executada preferencialmente na coligada informada no contexto.

Na dúvida consulte o quadro a seguir:

Coligada da Sentença SQL

Coligada informada no Contexto

Coligada que será Considerada 

0null0
011
1null1
121
Aviso
titleVersões:

Disponível a partir das versões 12.1.31.273. 12.1.32.219, 12.1.33.146 e 12.1.34



Para utilização dos Web Services através do aplicativo "Totvs Web Service Test", clique aqui.


Informações
titlePara maiores informações:

@FRAMEWORK

Canais de Atendimento

Chamado: Através do Portal TOTVS - www.suporte.totvs.com.br

Telefônico: 4003-0015 Escolhendo as opções 2-2-3-9-5 (Framework) ou 2-2-3-9-4 (BI)

Produto

Framework

Versão

11.82.XX

Processo

Web Services

Subprocesso

Utilizando o Web Service wsConsultaSQL

Status do Documento:Finalizado
Data:14/07/2015
Versão:11.82.XX
Versão Anterior:11.82.XX
Autores: