TOTVS - RESTFul API

DELETE

monitor/v1/filters/{filterID}

Description

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

DELETE

configurator/v1/apps/{AppId}

Description

Deleta o aplicativo solicitado

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
appid	character	required

DELETE

configurator/v1/integrations/{integrationId}

Description

Deleta a integração solicitada

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
integrationid	character	required

DELETE

configurator/v1/apps/{appId}/routes/{appIdExt}/transactions/{transactionId}

Description

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

DELETE

standardmessage/v1/transactions

Description

Valida a comunicação de uma integração

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

GET

monitor/v1/apps

Description

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

GET

configurator/v1/apps

Description

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

GET

monitor/v1/apps/{AppId}

Description

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

GET

standardmessage/v1/contents/{transactionID}

Description

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

GET

monitor/v1/msgs/summary/contexts

Description

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

GET

monitor/v1/msgs/summary/contexts/{context}

Description

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

GET

monitor/v1/filters

Description

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

GET

monitor/v1/admin/context

Description

Retorna informações de administração do serviço do usuário logado.

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

GET

configurator/v1/apps/{AppId}

Description

Retorna o aplicativo solicitado

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
appid	character	required

GET

standardmessage/v1/contents/{transactionID}/{InternalID}

Description

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

GET

monitor/v1/filters/{filterID}

Description

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

GET

configurator/v1/integrations/{integrationId}

Description

Retorna a integração solicitada

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
integrationid	character	required

GET

monitor/v1/mappings/definitions/{mappingID}

Description

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

GET

monitor/v1/mappings/values/{mappingID}

Description

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

GET

configurator/v1/apps/{appId}/transactions/{transactionId}

Description

Retorna o adapter solicitado

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
appid	character	required
transactionid	character	required

GET

configurator/v1/integrations

Description

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

GET

monitor/v1/msgs/{MsgUUID}/linked-msgs

Description

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

GET

monitor/v1/msgs/list

Description

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

GET

monitor/v1/msgs/{MsgUUID}/logs/download

Description

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

GET

monitor/v1/msgs/{MsgUUID}/logs

Description

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

GET

monitor/v1/mappings/definitions

Description

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

GET

monitor/v1/mappings/values

Description

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

GET

monitor/v1/msgs/{MsgUUID}/content

Description

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

GET

monitor/v1/msgs/{MsgUUID}/download

Description

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

GET

monitor/v1/msgs/{MsgUUID}

Description

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

GET

configurator/v1/apps/{appId}/routes/{appIdExt}/transactions/{transactionId}

Description

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

GET

configurator/v1/apps/{appId}/routes

Description

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

GET

monitor/v1/msgs/summary/applications

Description

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

GET

monitor/v1/msgs/summary/applications/{sourceApp}

Description

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

GET

monitor/v1/msgs/summary/transactions/{TransactionId}

Description

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

GET

monitor/v1/msgs/summary/receiving

Description

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

GET

monitor/v1/msgs/summary/sending

Description

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

GET

monitor/v1/msgs/summary/transactions

Description

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

GET

monitor/v1/apps/{AppId}/transactions

Description

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

GET

configurator/v1/apps/{appId}/transactions

Description

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

GET

monitor/v1/apps/{AppId}/transactions/{TransactionId}

Description

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

GET

/diagnosis/v1/healthcheck/wsintegration/{targetAppID}/{companyID}/{branchID}

Description

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

POST

configurator/v1/apps

Description

Cria um novo aplicativo

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

POST

monitor/v1/filters

Description

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

POST

configurator/v1/integrations

Description

Cria uma nova integração

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

POST

configurator/v1/apps/{appId}/routes

Description

Cria uma nova rota

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
appid	character	required

POST

standardmessage/v1/transactions

Description

Valida a comunicação de uma integração

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

PUT

monitor/v1/filters/{filterID}

Description

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

PUT

configurator/v1/apps/{AppId}

Description

Atualiza o aplicativo solicitado

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
appid	character	required

PUT

configurator/v1/integrations/{integrationId}

Description

Atualiza a integração solicitada

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined
_pathparam	Undefined	Undefined
integrationid	character	required

PUT

configurator/v1/apps/{appId}/routes/{appIdExt}/transactions/{transactionId}

Description

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

PUT

standardmessage/v1/transactions

Description

Valida a comunicação de uma integração

Response Content Type

Parameters

Parameter	Data Type	Value
_queryparam	Undefined	Undefined

TOTVS - RESTFul API

Service: /totvseai/

Métodos

DELETE monitor/v1/filters/{filterID}

Description

DELETE configurator/v1/apps/{AppId}

Description

DELETE configurator/v1/integrations/{integrationId}

Description

DELETE configurator/v1/apps/{appId}/routes/{appIdExt}/transactions/{transactionId}

Description

DELETE standardmessage/v1/transactions

Description

GET monitor/v1/apps

Description

GET configurator/v1/apps

Description

GET monitor/v1/apps/{AppId}

Description

GET standardmessage/v1/contents/{transactionID}

Description

GET monitor/v1/msgs/summary/contexts

Description

GET monitor/v1/msgs/summary/contexts/{context}

Description

GET monitor/v1/filters

Description

GET monitor/v1/admin/context

Description

GET configurator/v1/apps/{AppId}

Description

GET standardmessage/v1/contents/{transactionID}/{InternalID}

Description

GET monitor/v1/filters/{filterID}

Description

GET configurator/v1/integrations/{integrationId}

Description

GET monitor/v1/mappings/definitions/{mappingID}

Description

GET monitor/v1/mappings/values/{mappingID}

Description

GET configurator/v1/apps/{appId}/transactions/{transactionId}

Description

GET configurator/v1/integrations

Description

GET monitor/v1/msgs/{MsgUUID}/linked-msgs

Description

GET monitor/v1/msgs/list

Description

GET monitor/v1/msgs/{MsgUUID}/logs/download

Description

GET monitor/v1/msgs/{MsgUUID}/logs

Description

GET monitor/v1/mappings/definitions

Description

GET monitor/v1/mappings/values

Description

GET monitor/v1/msgs/{MsgUUID}/content

Description

GET monitor/v1/msgs/{MsgUUID}/download

Description

GET monitor/v1/msgs/{MsgUUID}

Description

GET configurator/v1/apps/{appId}/routes/{appIdExt}/transactions/{transactionId}

Description

GET configurator/v1/apps/{appId}/routes

Description

GET monitor/v1/msgs/summary/applications

Description

GET monitor/v1/msgs/summary/applications/{sourceApp}

Description

GET monitor/v1/msgs/summary/transactions/{TransactionId}

Description

GET monitor/v1/msgs/summary/receiving

Description

GET monitor/v1/msgs/summary/sending

Description

GET monitor/v1/msgs/summary/transactions

Description

GET monitor/v1/apps/{AppId}/transactions

DELETE

monitor/v1/filters/{filterID}

DELETE

configurator/v1/apps/{AppId}

DELETE

configurator/v1/integrations/{integrationId}

DELETE

configurator/v1/apps/{appId}/routes/{appIdExt}/transactions/{transactionId}

DELETE

standardmessage/v1/transactions

GET

monitor/v1/apps

GET

configurator/v1/apps

GET

monitor/v1/apps/{AppId}

GET

standardmessage/v1/contents/{transactionID}

GET

monitor/v1/msgs/summary/contexts

GET

monitor/v1/msgs/summary/contexts/{context}

GET

monitor/v1/filters

GET

monitor/v1/admin/context

GET

configurator/v1/apps/{AppId}

GET

standardmessage/v1/contents/{transactionID}/{InternalID}

GET

monitor/v1/filters/{filterID}

GET

configurator/v1/integrations/{integrationId}

GET

monitor/v1/mappings/definitions/{mappingID}

GET

monitor/v1/mappings/values/{mappingID}

GET

configurator/v1/apps/{appId}/transactions/{transactionId}

GET

configurator/v1/integrations

GET

monitor/v1/msgs/{MsgUUID}/linked-msgs

GET

monitor/v1/msgs/list

GET

monitor/v1/msgs/{MsgUUID}/logs/download

GET

monitor/v1/msgs/{MsgUUID}/logs

GET

monitor/v1/mappings/definitions

GET

monitor/v1/mappings/values

GET

monitor/v1/msgs/{MsgUUID}/content

GET

monitor/v1/msgs/{MsgUUID}/download

GET

monitor/v1/msgs/{MsgUUID}

GET

configurator/v1/apps/{appId}/routes/{appIdExt}/transactions/{transactionId}

GET

configurator/v1/apps/{appId}/routes

GET

monitor/v1/msgs/summary/applications

GET

monitor/v1/msgs/summary/applications/{sourceApp}

GET

monitor/v1/msgs/summary/transactions/{TransactionId}

GET

monitor/v1/msgs/summary/receiving

GET

monitor/v1/msgs/summary/sending

GET

monitor/v1/msgs/summary/transactions

GET

monitor/v1/apps/{AppId}/transactions

GET

configurator/v1/apps/{appId}/transactions

GET

monitor/v1/apps/{AppId}/transactions/{TransactionId}

GET

/diagnosis/v1/healthcheck/wsintegration/{targetAppID}/{companyID}/{branchID}

POST

configurator/v1/apps

POST

monitor/v1/filters

POST

configurator/v1/integrations

POST

configurator/v1/apps/{appId}/routes

POST

standardmessage/v1/transactions

PUT

monitor/v1/filters/{filterID}

PUT

configurator/v1/apps/{AppId}

PUT

configurator/v1/integrations/{integrationId}

PUT

configurator/v1/apps/{appId}/routes/{appIdExt}/transactions/{transactionId}

PUT

standardmessage/v1/transactions