Serviço genérico do EAI TOTVS.
Este serviço permite o uso do EAI em diferentes contextos, de maneira única a todos os produtos TOTVS.
Para detalhes do EAI Protheus, consulte a documentação do EAI Protheus
Remove um filtro cadastrado, identificado pelo parâmetro filterId.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
filterid | character | required |
Deleta o aplicativo solicitado
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
appid | character | required |
Deleta a integração solicitada
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
integrationid | character | required |
Deleta a rota solicitada
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
appid | character | required |
appidext | character | required |
transactionid | character | required |
Valida a comunicação de uma integração
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
Serviço que retorna detalhes do aplicativo logado (externo ou interno).
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
page | integer | optional |
perpage | integer | optional |
Este serviço retornar os aplicativos disponiveis
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
page | integer | optional |
pagesize | integer | optional |
order | character | optional |
Serviço que retorna detalhes do aplicativo logado (externo ou interno). O parâmetro appID deve ser fornecido no formato 'appID+empresa@productCode.'
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
appid | character | required |
Retorna todos os item de um adapter no padrão content
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
page | integer | optional |
pagesize | integer | optional |
order | character | optional |
_pathparam | Undefined | Undefined |
transactionid | character | required |
Este serviço permite obter a quantidade de mensagens por contexto, tanto as enviadas quanto as recebidas.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
date | character | optional |
deliverytype | character | optional |
status | character | optional |
transactions | character | optional |
msgflow | character | optional |
page | integer | optional |
perpage | integer | optional |
sourceapp | character | optional |
Este serviço permite obter a quantidade de mensagens por contexto, tanto as enviadas quanto as recebidas.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
date | character | optional |
deliverytype | character | optional |
status | character | optional |
transactions | character | optional |
msgflow | character | optional |
page | integer | optional |
perpage | integer | optional |
sourceapp | character | optional |
_pathparam | Undefined | Undefined |
context | character | optional |
Este serviço permite recuperar todos os filtros salvos no aplicativo
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
page | integer | optional |
perpage | integer | optional |
Retorna informações de administração do serviço do usuário logado.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
Retorna o aplicativo solicitado
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
appid | character | required |
Retorna um item solicitado de um adapter no padrão content
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
page | integer | optional |
pagesize | integer | optional |
order | character | optional |
_pathparam | Undefined | Undefined |
transactionid | character | required |
internalid | character | required |
Este serviço permite recuperar um filtro salvo no aplicativo, através do ID passado.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
filterid | character | required |
Retorna a integração solicitada
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
integrationid | character | required |
Este serviço retorna a definição (estrutura) do 'de-para' informado – mappingID (também conhecido como 'internalID') –, no contexto do aplicativo interno.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
mappingid | character | required |
Este serviço retorna os valores de 'de-para' registrados no aplicativo para o identificador fornecido – mappingID (ou internalID).
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
page | integer | optional |
perpage | integer | optional |
_pathparam | Undefined | Undefined |
mappingid | character | required |
Retorna o adapter solicitado
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
appid | character | required |
transactionid | character | required |
Retorna as integrações cadastradas
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
page | integer | optional |
pagesize | integer | optional |
order | character | optional |
Este serviço retorna as mensagens vinculadas a uma mensagem informada.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
msguuid | character | required |
Este serviço visa listar as mensagens que atendam aos critérios fornecidos pelos parâmetros.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
status | character | optional |
date | character | optional |
msgtypes | character | optional |
transactions | character | optional |
content | character | optional |
page | integer | optional |
perpage | integer | optional |
orderby | character | optional |
msgflow | character | optional |
context | character | optional |
_pathparam | Undefined | Undefined |
sourceapp | character | optional |
Este serviço permite efetuar o download de todas as mensagens de log associadas a uma mensagem, salvando-as em um arquivo .txt.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
msguuid | character | required |
Este serviço retorna os registros de mudança de estado da mensagem no aplicativo, ou seja, as etapas que a mensagem percorreu durante seu processamento pelo aplicativo interno.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
page | integer | optional |
perpage | integer | optional |
_pathparam | Undefined | Undefined |
msguuid | character | required |
Este serviço retorna a definição (estrutura) do 'de-para' informado – mappingID (também conhecido como 'internalID') –, no contexto do aplicativo interno.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
page | integer | optional |
perpage | integer | optional |
Este serviço retorna os valores de 'de-para' registrados no aplicativo para o identificador fornecido – mappingID (ou internalID).
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
page | integer | optional |
perpage | integer | optional |
Este serviço retorna o conteúdo de uma mensagem informada.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
start | integer | optional |
size | integer | optional |
_pathparam | Undefined | Undefined |
msguuid | character | required |
O serviço download recebe como parâmetro o código da mensagem e retorna o conteúdo da mensagem em formato XML, para download.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
msguuid | character | required |
Serviço que retorna os dados principais de uma mensagem (uuid, data de geração, etc).
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
originalmsguuid | character | optional |
_pathparam | Undefined | Undefined |
msguuid | character | required |
Retorna a rota solicitada
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
page | integer | optional |
pagesize | integer | optional |
order | character | optional |
_pathparam | Undefined | Undefined |
appid | character | required |
appidext | character | required |
transactionid | character | required |
Retorna todas a Rotas cadastradas
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
page | integer | optional |
pagesize | integer | optional |
order | character | optional |
_pathparam | Undefined | Undefined |
appid | character | required |
Este serviço permite obter a quantidade de mensagens por aplicativo, tanto as enviadas quanto as recebidas.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
date | character | optional |
deliverytype | character | optional |
status | character | optional |
transactions | character | optional |
msgflow | character | optional |
context | character | optional |
page | integer | optional |
perpage | integer | optional |
Este serviço permite obter a quantidade de mensagens por aplicativo, tanto as enviadas quanto as recebidas.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
date | character | optional |
deliverytype | character | optional |
status | character | optional |
transactions | character | optional |
msgflow | character | optional |
context | character | optional |
page | integer | optional |
perpage | integer | optional |
_pathparam | Undefined | Undefined |
sourceapp | character | optional |
Este serviço permite obter a quantidade de mensagens por transação. Na totalização serão consideradas somente as mensagens do tipo BusinessMessage.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
sourceapp | character | optional |
date | character | optional |
deliverytype | character | optional |
status | character | optional |
msgflow | character | optional |
context | character | optional |
page | integer | optional |
perpage | integer | optional |
groupbyversion | boolean | optional |
_pathparam | Undefined | Undefined |
transactionid | character | required |
Este método sumarizas as mensagens envidas pelo EAI.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
sourceapp | character | optional |
category | character | optional |
date | character | optional |
transactions | character | optional |
deliverytype | character | optional |
context | character | optional |
Este método sumarizas as mensagens envidas pelo EAI.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
category | character | optional |
date | character | optional |
transactions | character | optional |
deliverytype | character | optional |
context | character | optional |
Este serviço permite obter a quantidade de mensagens por transação. Na totalização serão consideradas somente as mensagens do tipo BusinessMessage.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
sourceapp | character | optional |
date | character | optional |
deliverytype | character | optional |
status | character | optional |
msgflow | character | optional |
context | character | optional |
page | integer | optional |
perpage | integer | optional |
groupbyversion | boolean | optional |
Serviço que retorna a lista de transações (adapters) de um aplicativo.O parâmetro appID deve ser fornecido no formato 'appID+empresa@productCode'
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
page | integer | optional |
perpage | integer | optional |
_pathparam | Undefined | Undefined |
appid | character | required |
Retorna todas os adapters cadastrados
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
order | character | optional |
page | integer | optional |
pagesize | integer | optional |
_pathparam | Undefined | Undefined |
appid | character | required |
Serviço que retorna os detalhes de transações (adapters) de um aplicativo.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
appid | character | required |
transactionid | character | required |
Valida a comunicação de uma integração
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
targetappid | character | required |
companyid | character | required |
branchid | character | required |
Cria um novo aplicativo
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
Este serviço permite salvar os filtros que o usuário realizar na interface do monitor, para utilização futura.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
Cria uma nova integração
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
Cria uma nova rota
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
appid | character | required |
Valida a comunicação de uma integração
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
Este serviço permite modificar um filtro já cadastrado.
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
filterid | character | required |
Atualiza o aplicativo solicitado
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
appid | character | required |
Atualiza a integração solicitada
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
integrationid | character | required |
Atualiza rota solicitada
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |
_pathparam | Undefined | Undefined |
appid | character | required |
appidext | character | required |
transactionid | character | required |
Valida a comunicação de uma integração
Response Content Type
Parameters
Parameter | Data Type | Value |
---|---|---|
_queryparam | Undefined | Undefined |