Ler todos os Template View

GET https://.account-name.krzlabs.io/api/v1/template-view

Realiza a leitura de todos os template views.


Request

paginação / link de referência
Entenda como aplicar paginação e ordenação na sua listagem
Entenda como aplicar filtros na sua listagem
Entenda como expandir entidades relacionadas nos documentos da listagem

Responses

Resposta de sucesso

200
Successfully retrieved API registry entry.
Field Type Description Optional Searchable
name string Nome do template. required true
feature string Funcionalidade à qual o template está relacionado. required false
type enum(TemplateViewEnum) Tipo de visualização do template
Possíveis valores:
   - table = 'table',
   - dashboard = 'dashboard'
required false
config object (dinâmico) Configuração do template baseada no tipo selecionado. Ver estrutura condicional abaixo.
requer uma chave:
   - type = 'table' ou 'dashboard'
required false

Config dict

Quando Type = ‘table’

columns array(Object) Lista de colunas do template.
requer duas chaves:
   - enable: boolean - required
   - field: string - required
required false

Quando Type = ‘dashboard’

array required false
Exemplo em JSON
{
   "page": 1,
    "skip": 0,
    "limit": 10,
    "sort": {
        "campo": "asc"
    },
    "pages": 5,
    "total": 50,
    "next": true,
    "previous": "2",
    "nextUrl": "https://api.exemplo.com?page=2",
    "previousUrl": false,
    "filters": {
        "status": "ativo"
    },
    "data": [{
        "name": "Template de Produtos",
        "feature": "Gestão de Produtos",
        "type": "table",
        "config": {
            "columns": [
            {
                "enabled": true,
                "name": "Código do Produto"
            },
            {
                "enabled": true,
                "name": "Nome do Produto"
            },
            {
                "enabled": false,
                "name": "Preço"
            }
            ]
        }
    }]
}

Resposta de erro

400
Bad Request
Field Type Description
code Number Código da resposta http
kind String Tipo de mensagem
name String Nome da exceção lançada pela plataforma
title String Titulo do erro lançado pela plataforma
message String Mensagem indicando o probloma ocorrido
solution String Mensagem indicando uma possível solução para o problema

Copyright © 2025 kruzer | All Rights Reserved