CONTEÚDO
- Visão Geral
- Exemplo de utilização
01. VISÃO GERAL
O objetivo deste documento é mostrar como deve ser utilizado os modelos de dados existentes no produto TOTVS Jurídico Departamentos, que usam o modelo padrão, FWMODEL. Além disso, documentar quais modelos estão disponíveis.
Modelos disponíveis:
Modelo | Descrição |
---|---|
JURA001 | Natureza Jurídica |
JURA003 | Cadastro de relatórios |
JURA004 | Assunto |
JURA005 | Comarcas |
JURA006 | Prognóstico |
JURA009 | Tipos de envolvimento |
JURA011 | Fase processual |
JURA013 | Motivo de encerramento |
JURA014 | Configuração de relatórios |
JURA016 | Prepostos |
JURA017 | Resultados de Followup |
JURA021 | Tipos de Followup |
JURA022 | Tipos de Ação |
JURA024 | Tipos de Garantia |
JURA025 | Motivo de alteração |
JURA051 | Ato processual |
JURA052 | Cargo |
JURA061 | Formas de correção |
JURA085 | Tipos de Pedidos/Objetos |
JURA087 | Tipo de despesa |
JURA093 | Justificativa de alteração de correspondentes |
JURA094 | Pedidos layout 1 |
JURA095 | Assuntos jurídicos |
JURA098 | Depósitos Judiciais |
JURA099 | Despesas Jurídicas |
JURA100 | Andamentos |
JURA106 | Follow-ups |
JURA107 | Local de trabalho |
JURA132 | Escritórios Credenciados |
JURA133 | Tipo de aditivos |
JURA134 | Tipos de Contrato |
JURA156 | Tipos de solicitação |
JURA158 | Cadastro de assuntos jurídico |
JURA163 | Configuração de pesquisa |
JURA166 | Justificativa |
JURA184 | Partes Contrárias |
JURA185 | Equipes |
JURA218 | Usuários x Grupo |
JURA233 | E-social 1070 |
JURA251 | Tipos de Subsídio |
JURA254 | Solicitações de subsídio |
JURA257 | Ato Processual Automático |
JURA258 | Redutores |
JURA259 | Tipo de liminares |
JURA260 | Liminares |
JURA269 | Favoritos |
JURA270 | Pedidos layout 2 |
JURA276 | Modelos de exportação |
JURA018 | Rito |
JURA279 | Distribuição |
JURA280 | Notificações |
JURA282 | Histórico de alteração de pedidos |
JURA283 | Publicações |
JURA285 | Rotinas customizadas |
JURA286 | Preferências do usuário |
JURA287 | Causa raiz |
JURA288 | Gestão de relatórios |
JURA289 | Relacionamentos |
JURA293 | Configurações do produto |
JURA294 | Tipo de certidões e licenças |
JURA295 | Certidões e licenças |
02. EXEMPLO DE UTILIZAÇÃO
Todos os modelos listados acima usam o padrão FWMODEL. Suportam todas as operações (POST PUT, GET, DELETE) RESTFUL. A documentação completa pode ser vista no documento FWRestModel.
A api pode retornar todos os registros ou apenas um registro específico. Para acessar um registro específico, deve ser informada a chave única do registro em formato BASE64.
Exemplo para o modelo de processos:
A chave da tabela de processos é NSZ_FILIAL + NSZ_COD
Get para retornar todos os registros:
<HTTPRESTCLIENTE:/fwmodel/jura095/
Se quisermos retornar um registro específico (registro filial 01 código 0000000001:
<HTTPRESTCLIENTE:/fwmodel/jura095/MDEwMDAwMDAwMDAx
Exemplo de retorno:
{ "id": "JURA095", "operation": 1, "pk": "MDEwMDAwNTI5NTgz", "models": [ { "id": "NSZMASTER", "modeltype": "FIELDS", "fields": [ { "id": "NSZ_FILIAL", "order": 1, "value": "01" }, { "id": "NSZ_CCLIEN", "order": 2, "value": "000001" }, { "id": "NSZ_LCLIEN", "order": 3, "value": "01" }, { "id": "NSZ_NUMCAS", "order": 8, "value": "000802" }, { "id": "NSZ_COD", "order": 9, "value": "0000529583" },
A estrutura de retorno é a mesma estrutura que deve ser usada em operações como PUT e POST.
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)
Consulte a documentação https://tdn.totvs.com/pages/releaseview.action?pageId=271671548 para mais detalhes técnicos.IMPORTANTE!