Consultar regras e script do formulário

atenção

Em desenvolvimento - ainda não disponível em produção

Retorna as regras de exibição e o script de um formulário dinâmico. São as informações que não vêm em Consultar componentes do formulário.

A consulta é apenas de leitura: a API não avalia as regras nem executa os scripts. Cabe ao sistema que preenche o formulário decidir, com base nas regras, quais campos mostrar.

Endpoints

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

Respostas

Exemplo de corpo da resposta

{
	"idFormulario": 45,
	"regras": [
		{
			"identificador": "ip_numero_imovel",
			"condicoes": [
				{
					"item": "sl_tipo_imovel",
					"valor": "Residencial",
					"operador": "=="
				}
			],
			"acao": "Mostrar",
			"conectivo": "||"
		}
	],
	"script": "// script do formulário",
	"scriptsComponentes": []
}

Dicionário dos dados retornados na API

Chave	Descrição
idFormulario	ID do formulário
regras	Lista de regras de exibição. Vem vazia ([]) quando o formulário não tem regras
regras[].identificador	Campo afetado pela regra (htmlId do componente)
regras[].acao	O que fazer com o campo quando a regra é atendida (ex.: Mostrar)
regras[].conectivo	Como combinar as condições: || (basta uma)
regras[].condicoes[].item	Campo avaliado (htmlId do componente)
regras[].condicoes[].operador	Comparação (ex.: ==, igual a)
regras[].condicoes[].valor	Valor comparado com a resposta do campo avaliado
script	Script do formulário, em JavaScript. Não aparece quando o formulário não tem script
scriptsComponentes	Scripts configurados em componentes do formulário (htmlId e script). Vem vazio quando não há

Status da resposta

Status	Descrição
200	OK - Regras e scripts retornados (inclusive quando o formulário não tem regras).
401	Credenciais de acesso inválidas ou não informadas.