Histórico da Página
...
| 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
...
| Painel | ||
|---|---|---|
| ||
| http://<servidor>[:<porta>]/totvseai/standardmessage/v1/transactions?batchType={batchType} |
...
Onde:
- 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 será 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.
...
- Submeter mensagem em lote;
- Submeter uma mensagem;
- Eliminar uma mensagem;
- Eliminar um lote de mensagens.
Predicado /contents
| Painel |
|---|
...
| ||
| http://<servidor>[:<porta>]/totvseai/standardmessage/v1/contents/{transactionID_version}/{internalID}. |
Onde:
- transactionID_version: identificador que designa a transação e versão a ser considerada;
- internalID: identificador da instância da entidade indicada pela transação e versão informados no parâmetro anterior. Por exemplo: quando a transação e versão for "customervendor_1_000", o parâmetro internalID deve conter um valor que identifique um registro de cliente/fornecedor no originador da requisição. Consequentemente, no recebedor da requisição, será necessário uma estrutura de tradução - de-para - que permita identificar o registro equivalente no destino.
...
| Informações | ||
|---|---|---|
| ||
| O formato de mensagem utilizado nas requisições para o endpoint /contents é mais simples, já que não requer as informações de cabeçalho para realizar o controle da mensagem. A proposta é apenas utilizar-se do modelo de mensagem padronizada para trafegar informações entre as partes. Na prática, o modelo de dados que será trafegado nas requisições corresponde apenas ao atributo content do modelo completo, usado pelo endpoint /transactions. |
Exemplos de utilização
Exemplos de utilização deste predicado podem ser vistos aquinos link a seguir:
- Recuperar um lote de entidades;
- Recuperar uma entidade;
- Submeter uma entidade;
- Submeter um lote de entidades;
- Alterar uma entidade;
- Eliminar uma entidade.
Coexistência com o formato XML
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas