01. VISÃO GERAL

Para fins de utilização do projeto Littera, são definidas as respostas de renderização utilizadas para a obtenção de listas.

02. DEFINIÇÃO

Entende-se por renderização a confecção da lista de objetos resultantes de uma consulta à API. Estas listas devem ser definidas conforme as definições adotadas pela TOTVS em seu manual de desenvolvimento de APIs.

Sendo assim, o objeto primário de resposta será, sempre:

{
    "count": 0,
    "hasNext": false,
    "items": []
}

03. TIPOS RENDERIZADOS

São tipos renderizados nas respostas de coleção:

1. Todos os tipos cadastrados como tipos de cadastro na API;
2. Listagem de itens integrantes de um pacote parcial (patch);
3. Listagem de itens integrantes de um pacote de release e;
4. Listagem de pacotes integrantes de uma instalação/atulização consolidada.

04. RENDERIZAÇÃO

A renderização dos tipos cadastradois na API vai ser feita, de maneira geral, com base em seu JSON Schema, o qual fica registrado na base de dados da API. Para as demais renderizações, os objetos devem obedecer as definições a seguir.

{
	"type": "executable",
	"path": "C:\\TOTVS\\Logistica\\Recintos Aduaneiros\\Executaveis",
	"name": "Aduaneiro.exe"
}

{
    "release": "12.1.2507",
	"type": "library",
	"path": "C:\\TOTVS\\Logistica\\Recintos Aduaneiros\\Executaveis\\redist\\win32",
	"name": "UFScanner.dll"
}

{
	"version": "12.1.2507",
	"description": "Pacote para atualização dos artefatos de banco de dados.",
	"path": "C:\\TOTVS\\Logistica\\Recintos Aduaneiros\\Instaladores",
	"name": "TLRA_12.1.2507_Banco_de_dados.exe"
}

04. NOTAS

Para os itens de pacotes parciais e de release, o valores aceitos em type são:

1. executable, destinado a arquivos executáveis;
2. package, destinado a pacotes BPL;
3. library, destinado a bibliotecas DLL, e;
4. script, destinado a arquivos de banco de dados;