TOTVS Jurídico - Gestão Jurídica by Legal Desk - Pré-Faturamento de Serviços (SIGAPFS) - Atualização de campo usando API FWRESTMODEL

⏱ Tempo aproximado para leitura: 00:04:25 min

Dúvida:
Qual seria o procedimento correto para realizar o PUT e atualizar informações via API utilizando as APIs do SIGAPFS no padrão FWRESTMODEL

Ambiente:
TOTVS Jurídico - Gestão Jurídica by Legal Desk - Pré Faturamento de Serviços (SIGAPFS) - Todas as versões

Solução:
Para realizar a atualização do conteúdo de campos utilizando a API do Protheus, você deve criar a estrutura do JSON do PUT utilizando a estrutura completa de retorno do GET ( copie do GET e cole no PUT ) conforme demonstrado no vídeo em anexo e especificado na documentação das APIs do SIGAPFS no padrão FWRESTMODEL - item 07 da documentação: APIs do SIGAPFS no padrão FWRESTMODEL
 

"...A estrutura de retorno é a mesma estrutura que deve ser usada em operações como PUT e POST..."

1. Verifique a estrutura do payload que você está enviando. Assegure que estão sendo enviados todos os campos obrigatórios conforme a documentação acima. No caso de exemplo do PUT ( vídeo ), o payload deve conter os campos obrigatórios relacionados ao cliente.
2. Considere o uso do endpoint correto, exemplifiquei a atualização do e-mail do cliente ( vídeo ), o endpoint é endereço do REST/fwmodel/jura148/{PK}, onde {PK} deve ser substituído pelo identificador específico do registro que você está atualizando (  conforme vídeo).

Poderá ser utilizado as seguintes QueryStrings

• COUNT = Quantidade de registro que devem ser retornados (padrão: 10)
• STARTINDEX = Indica a partir que qual index deverá ser retornado (padrão: 1)
• FILTER = Filtro que será aplicado no método SetFilter()
• FIELDDETAIL = Habilita mostrar mais informações nos campos do modelo (padrão: 10)
• FIELDVIRTUAL = Habilita o retorno de campos virtuais (padrão: false)
• FIELDEMPTY = Habilita o retorno de campos sem valores (padrão: false)
• FIRSTLEVEL = Habilita o retorno dos sub modelos (padrão: true)
• FIELDS = Indica os campos a serem filtrados no retorno do modelo, incluindo os sub modelos, caso não informado todos os campos serão retornados
• DEBUG = Valor booleano para habilitar o modo debug (padrão: false)
• CACHE = Indica se sera feito cache do total de registros por alias, refere-se ao valor do total no retorno (padrão: true)
• INTERNALID = Indica se deve retornar o ID(Recno) como informação complementar das linhas do GRID (padrão: false)
• USESX3ORDER = Indica se deve ignorar a ordem dos campos passado no body e carregar os dados de acordo com a ordem da SX3 (padrão: false) - Disponível a partir da lib 20240812

Para utilizar as querystrings, basta colocar após endpoint o simbolo ? seguido do nome da querystring = valor

Exemplo:  

http://localhost:13581/rest/fwmodel/jura148?FIELDEMPTY=true ( Habilita o retorno de campos sem valores )

Seguindo esses passos é possível realizar a atualização do campos corretamente via API do SIGAPFS utilizando o PUT.

Saiba Mais:

APIs do SIGAPFS no padrão FWRESTMODEL