Histórico da Página

...

content: contem informações equivalentes a tag BusinessContent, para mensagens de negócio, ou a tag ReturnContent, para mensagens de resposta. Devido a isso, os atributos podem variar de acordo com a definição da transação. Quando a mensagem for de resposta, o atributo content terá a seguinte estrutura:

• receivedMessage: equivalente à tag ReceivedMessage, da mensagem de resposta no padrão SOAP, exceto pela tag filha MessageContent, que não será mais utilizada;
• processingInformation: equivalente à tag ProcessingInformation, do padrão SOAP, exceto pela tag filha ListOfMessages, que foi substituída pelo atributo details, que por sua vez, conterá as mensagens referentes ao processamento da mensagem original, seguindo a estrutura definida no Guia de Implementação de APIs TOTVS, item Mensagens conterá dados relativos à mensagem original, como o UUID e o aplicativo de origem (sentBy).processingInformation: conterá dados relativos ao processamento da mensagem original, como o status geral do processamento, a data de processamento, e eventuais mensagens de erro.
• returnContent: conterá o resultado do processamento da mensagem original, conforme definido para a transação. Além disso, pode conter também o atributo listOfInternalId, o qual conterá todos os internal Ids relacionados a mensagem. A estrutura corresponde ao internal ID terá os seguintes atributos:
  • name: mesma definição da tag do padrão SOAP Name;
  • origin: mesma definição da tag Origin;
  • destination: mesma definição da tag Destination.

...

A nova proposta fornece também um modelo para lote de mensagens, que corresponde a um array JSON, onde cada elemento corresponde a uma mensagem no formato JSON.

...

/totvseai/standardmessage/v1/transactions/{transactionID}?batchType={batchType}

...

Neste endpoint estarão disponíveis dois predicados ou entidades:
/transactions: utilizado para receber mensagens que devem ser gerenciadas pelo Engine de EAI. As mensagens recebidas desta forma terão identificador único e podem ser encaminhadas para uma fila, quando o modo de operação for assíncrono. É o equivalente à operação SOAP receiveMessage do padrão original.
/contents: utilizado para receber mensagens onde apenas o conteúdo é relevante, e não há necessidade de maiores controles. Neste endpoint, o modo de operação será exclusivamente síncrono.

 Informações
Salvo quando explicitamente indicado no documento, deve-se considerar que os endpoints disponibilizam os recursos previstos no Guia de Implementação de APIs para paginação, ordenação e filtro de dados.
Predicado /transactions
URL completa: /totvseai/standardmessage/v1/transactions?batchType={batchType}.
batchType: indica como deve ser tratado o lote de mensagens recebido, se for aplicável. Permite os seguintes valores:
businessTransaction: indica que o lote será tratado como uma transação de negócio, onde todas as mensagens compondo o lote devem ser processadas com sucesso, para que o lote seja considerado processado. Se ocorrer erro em alguma mensagem do lote, todo o lote sera recusado.
simpleBatch: indica que o lote serve apenas como agrupador de mensagens, que serão processadas independentemente. Se ocorrer erro em alguma mensagem do lote, isso não afeta as demais mensagens. Neste caso, o lote sempre será considerado processado.
Os parâmetros de paginação, ordenação e filtro de dados previstos pelo Guia de Implementação de APIs não são aplicáveis para as requisições deste predicado.
...
Os métodos HTTP previstos para o endpoint são:
POST: para mensagens de requisição (requestde requisição (request), ou mensagem de inclusão/alteração (event). Corresponde as às mensagens XML contendo a tag BusinessRequest, ou tag BusinessEvent com Event igual a "upsert".
DELETE: para mensagens de eliminação (delete). Corresponde as mensagens XML contendo a tag BusinessEvent, com Event igual a "delete".
Exemplos de utilização deste endpoint podem ser encontrados nesta página.
Predicado /contents
URL completa: /totvseai/standardmessage/v1/contents/
...
.
Os métodos previstos são:
GET: lkfdkfdpara recuperar entidades.
POST: ldkfldkfpara incluir ou alterar entidades.
DELETE: dkfjdkjfkdpara eliminar entidades.
Coexistência com o formato XML/SOAP
...