Os serviços Rest identificarão a base de dados a ser utilizada através da tag DefaultDB, que informa o Alias que será utilizado no acesso. Essa tag deve existir no arquivo de configuração do Host (RM.Host.Service.exe.config ou RM.Host.exe.config).

Exemplo de utilização da tag DefaultDB
<add key=”DefaultDB” value=”<ALIAS_DO_BANCO_RM>

A variável <ALIAS_DO_BANCO_RM> deverá ser substituída pelo nome do alias cadastrado para acesso ao banco de dados.

Exemplo de config com a tag DefaultDB.
<?xml version="1.0"?>
<configuration>
 <appSettings>
  <add key="JobServer3Camadas" value="false" />
  <add key="Port" value="12120" />
  <add key="ActionsPath" value="C:\totvs\CorporeRM\RM.Net;" />
  <add key="LibPath" value="C:\totvs\CorporeRM\RM.Net" />
  <add key="EnableDynamicLocalization" value="false" />
  <add key="EnableCompression" value="false" />
  <add key="LocalizationLanguage" value="pt-BR" />
  <add key="HttpPort" value="8051" />
  <add key="ApiPort" value="8052" />    
  <add key="DefaultDB" value="CorporeRM" />
 </appSettings>
 <runtime>
  <NetFx40_LegacySecurityPolicy enabled="true" />
  <generatePublisherEvidence enabled="false" />
 </runtime>
 <startup useLegacyV2RuntimeActivationPolicy="true">
  <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0" />
 </startup>
</configuration>

Atenção

Para que o sistema carregue corretamente os parâmetros no momento de utilização do Rest, é necessário que sejam inclusas as informações do contexto no Headers: Coligada, Filial, Tipo de curso e Código do Sistema.

Exemplo de uso no Postman:



Importante

Liberação de acesso a porta do Host Service

Caso o Host utilizado seja o RM.Host.Service.exe é necessário a execução do comando, abaixo, para liberação da porta configurada na tag HttpPort, via prompt de comando: 

  • Adicionar

netsh http add urlacl url=http://+:8051/ user=NetworkService 

  • Apagar

netsh http delete urlacl url=http://+:8051/ 

  • Exibir

netsh http show urlacl

A porta 8051 é padrão no sistema e caso seja alterada na tag HttpPort no arquivo de configuração do Host, precisa ser alterada no link acima.


Documentações REST

Documentações de apoio da Framework para utilização de REST para execução de Processos.

Antiga API: 

RestProcess - https://tdn.totvs.com/x/WBJnF

Nova API:

Job Execution - https://tdn.totvs.com/x/1gp7GQ 

Job Schedule - https://tdn.totvs.com/x/e0F0GQ


Páginas:

  • Sem rótulos