Consultar modelo de registro

Retorna, para um formulário dinâmico, o body esperado pelo CUBE para gravar um registro desse formulário (exemploBody) e o dicionário dos campos (campos).

O exemploBody é exatamente o JSON a ser enviado no endpoint Criar registro de formulário: basta substituir os valores de exemplo pelos dados reais, mantendo as chaves e os formatos.

Endpoints

Método	URL
GET	https://{{url}}/cube/api/v3/formularios/{{idFormulario}}/registros/modelo

Respostas

Exemplo de corpo da resposta

{
	"idFormulario": 123,
	"nome": "Vistoria",
	"versao": 3,
	"exemploBody": {
		"ip_nome": "texto",
		"ip_cpf": "000.000.000-00",
		"dt_visita": "2026-10-20T14:30",
		"ip_quantidade": 0,
		"cb_aceite": 1,
		"sl_tipo": "Residencial",
		"up_foto": "https://exemplo.com/arquivo.pdf"
	},
	"campos": [
		{
			"chave": "ip_nome",
			"label": "Nome",
			"tipoComponente": "INPUT",
			"tipoDado": "VARCHAR",
			"obrigatorio": true,
			"somenteLeitura": false,
			"mascara": null,
			"formato": null,
			"opcoes": []
		},
		{
			"chave": "sl_tipo",
			"label": "Tipo de imóvel",
			"tipoComponente": "SELECT",
			"tipoDado": "VARCHAR",
			"obrigatorio": false,
			"somenteLeitura": false,
			"mascara": null,
			"formato": "um dos valores de opcoes",
			"opcoes": [
				{ "valor": "Residencial", "descricao": "Residencial" },
				{ "valor": "Comercial", "descricao": "Comercial" }
			]
		}
	]
}

Dicionário dos dados retornados na API

Chave	Descrição
idFormulario	Numérico - ID do formulário dinâmico.
nome	Texto - Nome do formulário.
versao	Numérico - Versão do formulário. Informativo, não é enviado na gravação.
exemploBody	Objeto - Body de exemplo para a gravação do registro. Cada chave é a chave de um campo do formulário.
campos	Lista - Dicionário das chaves do exemploBody.
campos.chave	Texto - Chave do campo no body da gravação.
campos.label	Texto - Rótulo do campo exibido no formulário.
campos.tipoComponente	Texto - Tipo do componente: INPUT, TEXTAREA, SELECT, RADIO, CHECKBOX, DATE, TIME, INPUTFILE, LATITUDE, LONGITUDE, AUTOCOMPLETE, entre outros.
campos.tipoDado	Texto - Tipo do dado gravado: VARCHAR, TEXT, INT, FLOAT, DATETIME, TIMESTAMP, TIME.
campos.obrigatorio	Booleano - Indica se o campo deve ser preenchido.
campos.somenteLeitura	Booleano - Indica se o campo é somente leitura no formulário.
campos.mascara	Texto - Máscara do campo, quando houver.
campos.formato	Texto - Formato esperado do valor (ver tabela abaixo).
campos.opcoes	Lista - Valores aceitos em campos SELECT e RADIO (valor e descricao). Envie o valor.

Formato dos valores por tipo de campo

Tipo de campo	Formato do valor	Exemplo
CHECKBOX	1 marcado, 0 desmarcado	1
SELECT / RADIO	Um dos valor de opcoes	"Residencial"
INPUTFILE	Texto - URL/referência do arquivo	"https://meuwebsite.com/arquivos/foto.jpg"
Dado DATETIME / TIMESTAMP	yyyy-MM-dd'T'HH:mm	"2026-10-20T14:30"
DATE com dado texto	yyyy-MM-dd	"2026-10-20"
Dado TIME ou componente TIME	HH:mm	"14:30"
Dado INT	Inteiro	10
Dado FLOAT	Decimal	10.5
Texto com máscara	Conforme a máscara	"000.000.000-00"
Texto	Texto livre	"texto"

tip

O exemploBody contém apenas campos do formulário. Nenhuma propriedade do formulário (id, versão, usuário) deve ser enviada no body da gravação.

Status da resposta

Status	Descrição
200	OK - Modelo retornado com sucesso.
401	Credenciais de acesso inválidas ou não informadas.
404	Formulário não encontrado.