Detalhe completo do template (com fields)

Retorna a estrutura completa de um template: todos os fields (colunas)
com type, label, key, required, visible, summable, data.type
(tipo de dado: string, int, customer_name, customer_cpfcnpj,
customer_photo, auto_increment, etc) e data.column (nome real da
coluna no banco).

Use pra montar dinamicamente formulários, validações e payloads de
POST /data/set. O campo fields_serialized (string) é uma versão
pré-montada do esqueleto do objeto pra criação.

Tipos de campo (`fields[i].type`)

simple — coluna comum

join_object — FK que retorna 1 objeto

join_object_list — FK que retorna lista de objetos

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Template completo com fields[].

Bodyapplication/json

Exemplo

{
    "id": "26cd301a-5c82-468b-9c23-af3c915d9720",
    "name": "Cliente",
    "table_name": "cliente",
    "template_customer_table": true,
    "template_contact_table": false,
    "template_business_table": false,
    "template_default": true,
    "template_default_tenant": false,
    "fields": [
        {
            "column": "id",
            "label": "ID",
            "type": "simple",
            "key": true,
            "constraint_unique": false,
            "summable": false,
            "visible": true,
            "required": true,
            "data": {
                "source_type": "internal_table",
                "type": "auto_increment",
                "table": "cliente",
                "column": "id",
                "foreign_key": false,
                "related_customer_table": false
            },
            "position": 0
        },
        {
            "column": "nome",
            "label": "Nome",
            "type": "simple",
            "key": false,
            "constraint_unique": false,
            "summable": false,
            "visible": true,
            "required": false,
            "data": {
                "source_type": "internal_table",
                "type": "customer_name",
                "table": "cliente",
                "column": "nome",
                "foreign_key": false,
                "related_customer_table": false
            },
            "position": 0
        },
        {
            "column": "cpf_cnpj",
            "label": "CPF/CNPJ",
            "type": "simple",
            "key": false,
            "constraint_unique": true,
            "summable": false,
            "visible": true,
            "required": true,
            "data": {
                "source_type": "internal_table",
                "type": "customer_cpfcnpj",
                "table": "cliente",
                "column": "cpf_cnpj",
                "foreign_key": false,
                "related_customer_table": false
            },
            "position": 0
        }
    ],
    "fields_serialized": "{\"foto\":{\"filename\":\"\",\"url\":\"\"},\"nome\":\"\",\"cpf_cnpj\":\"\",\"teste\":0}",
    "created_at": "2024-05-20T16:05:50.607396Z",
    "updated_at": "2024-08-14T10:57:54.584985Z",
    "created_by": 0
}

🟠401Não Autorizado

Detalhe completo do template (com fields)

Tipos de campo (fields[i].type)#

Requisição

Códigos de solicitação

Respostas

Tipos de campo (`fields[i].type`)