Definir regras condicionais do formulário

Define, substituindo por completo as regras vigentes, o comportamento condicional do formulário inicial — reações a mudanças de valor em um campo, ou o cálculo automático do valor de um campo.

Cada regra é vinculada a um campo gatilho (fieldId) e usa um trigger: onChange (dispara quando o valor do campo muda), onLoad (dispara ao carregar o formulário — uma lista de condições vazia significa que dispara sempre) ou onCalculate (calcula o valor de um campo a partir de uma expressão matemática envolvendo outros campos).

Para onChange/onLoad, cada operação combina uma lista de condições (conditions, com fieldId, operator e value) com uma lista de ações (actions, com type e targetFieldId). O campo value é obrigatório em toda condição, mesmo para operadores unários como is_empty/is_not_empty, que não o utilizam semanticamente — nesses casos, envie uma string vazia.

Para onCalculate, utiliza-se calculation, com uma expressão matemática livre (expression) referenciando outros campos pelo identificador, o campo de destino (targetFieldId), a precisão decimal (precision) e se o campo calculado permanece editável (editable).

Esta chamada substitui integralmente o conjunto de regras vigente — envie sempre a lista completa desejada, não apenas as regras novas.

Um efeito colateral importante: esta chamada apaga o texto de ajuda (help) de todos os campos do formulário. Recomendamos aplicar as regras condicionais antes de uma atualização de campos que defina o texto de ajuda, encerrando sempre a configuração do formulário com essa atualização de campos.

Se o valor usado em uma condição não corresponder exatamente a uma das opções cadastradas em um campo do tipo seleção (incluindo acentuação e espaços), a regra correspondente nunca disparará — sem gerar qualquer erro.

curl --location --request PUT '/v1/flows//start-form/rules' \ --header 'Content-Type: application/json' \ --data '{ "items": [ { "fieldId": "string", "rules": { "trigger": "onChange", "active": true, "operations": [ { "conditions": [ { "fieldId": "string", "operator": "=", "value": null } ], "actions": [ { "type": "show", "targetFieldId": "string", "value": null } ] } ], "calculation": { "expression": "string", "targetFieldId": "string", "precision": 0, "editable": true } } } ] }'

Definir regras condicionais do formulário

Requisição

Respostas