Consultar componentes do formulário

Retorna os componentes de um formulário dinâmico exatamente como estão configurados no CUBE, incluindo posição na tela e opções.

dica

Para gravar registros, prefira Consultar modelo de registro: ele já devolve o body esperado na gravação e o formato de cada campo. Use este endpoint quando precisar de informações de configuração que o modelo não traz, como dica, posição na tela e somente leitura (colunaReadonly).

Endpoints

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

Respostas

Exemplo de corpo da resposta

[
	{
		"id": 101,
		"htmlId": "sl_tipo_imovel",
		"htmlTipo": "SELECT",
		"htmlTop": 0,
		"htmlLeft": 0,
		"comboTipo": "ESTATICO",
		"comboValor": "Residencial;Comercial",
		"descricaoComponente": "Tipo de imóvel",
		"colunaTipo": "VARCHAR",
		"colunaNome": "sl_tipo_imovel",
		"colunaNotNull": true,
		"colunaReadonly": false,
		"jsonOptions": []
	},
	{
		"id": 102,
		"htmlId": "ip_referencia",
		"htmlTipo": "INPUT",
		"htmlTop": 1,
		"htmlLeft": 0,
		"descricaoComponente": "Ponto de referência",
		"dica": "Informe um ponto próximo",
		"colunaTipo": "VARCHAR",
		"colunaNome": "ip_referencia",
		"colunaNotNull": false,
		"colunaReadonly": false,
		"jsonOptions": []
	}
]

Dicionário dos dados retornados na API

Chave	Descrição
htmlId	Identificador do componente. É a chave do campo em Consultar modelo de registro
htmlTipo	Tipo do componente (INPUT, SELECT, CHECKBOX, DATE etc.)
descricaoComponente	Rótulo exibido no formulário
colunaNome / colunaTipo	Coluna e tipo de dado em que o valor é gravado
colunaNotNull	Indica se o campo é obrigatório
colunaReadonly	Indica se o campo é somente leitura
mascara	Máscara do campo, quando houver
dica	Texto de ajuda do campo
parentComponent	Componente pai, quando o campo está agrupado em outro
comboTipo / comboValor	Opções de campos SELECT e RADIO, separadas por ; em comboValor (ex.: SIM;NÃO). Em SELECT com opções fixas, comboTipo vem ESTATICO. Se comboValor vier sem opções (ex.: ; ou ;;), as opções são preenchidas pela tela do CUBE e não estão disponíveis na API
jsonOptions	Configurações do componente (ex.: {"componente": "BUTTONSCRIPT", "option": "style", "value": "primary"}). value pode não vir quando a configuração não foi preenchida
htmlTop, htmlLeft, htmlWidth, htmlHeight	Posição e tamanho do componente na tela

Campos sem valor (por exemplo dica ou mascara) não aparecem na resposta.

cuidado

A consulta devolve apenas os componentes. O script e as regras de exibição do formulário (mostrar ou ocultar um campo conforme a resposta de outro) não vêm nesta consulta: use Consultar regras e script do formulário. Campos preenchidos pela tela do CUBE, como botões BUTTONSCRIPT e campos somente leitura que eles preenchem, ou seleções sem opções em comboValor, não podem ser preenchidos pela API.

Status da resposta

Status	Descrição
200	OK - Componentes retornados.
401	Credenciais de acesso inválidas ou não informadas.