TOTVS - RESTFul API


Service: /fwmodel/

Serviço genérico de integração e manipulação dos modelos de negócios do TOTVS Linha Protheus.

Este serviço permite a utilização das regras de negócio (Model) baseadas em Submodelos, Estrutura de Dados e validações em código desenvolvidas pelas área de negócio, permitindo a sua reutilização em forma de serviços.

O Model é composto basicamente por Submodelos. Um SubModelo representa uma entidade e permite manipular registros.

Existem basicamente dois tipos de Submodelo, o formfield e o formgrid. O primeiro permite manipular somente um registro por vez e o segundo permite manipular vários registros ao mesmo tempo.

A regra de negócio pode definir os seguintes itens:

O Model é totalmente segregado, porém ele mantém todas as regras de negócio originais e permite as operações de Create,Read,Update e Delete.

Para maiores informações, consulte: aqui

O catálogo de serviços pode ser obtido em: /fwmodel.catalog

Métodos

DELETE
/FWModel/{:IdModel}/{:Pk}

Description

(Delete) Método de exclusão dos dados do modelo de negócio do TOTVS Linha Protheus

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
/FWModel/{:IdModel}/{:Pk}

Description

(Read) Método de obtenção dos dados do modelo de negócio do TOTVS Linha Protheus

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
count integer optional
startindex integer optional
filter string optional
fielddetail string optional
fieldvirtual string optional
fieldempty string optional
internalid string optional

POST
/FWModel/{:IdModel}

Description

(Create) Método de inclusão dos dados do modelo de negócio do TOTVS Linha Protheus

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fielddetail string optional
fieldvirtual string optional
fieldempty string optional
internalid string optional

PUT
/FWModel/{:IdModel}/{:Pk}

Description

(Update) Método de alteração dos dados do modelo de negócio do TOTVS Linha Protheus

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
fielddetail string optional
fieldvirtual string optional
fieldempty string optional
internalid string optional