Configurar regras condicionais do template

Configura regras condicionais para os campos do template — por exemplo, exibir, ocultar, tornar obrigatório/opcional ou limpar o valor de um campo com base no valor de outro campo (onChange).

Cada item do payload associa um campo-gatilho (fieldId) a um conjunto de operações: cada operação lista as condições (conditions, com fieldId, operator e value) que, quando satisfeitas, disparam uma ou mais ações (actions, com type — show, hide, setRequired, setOptional ou clearValue — e targetFieldId). Os identificadores de campo usados aqui (fieldId e targetFieldId) são os identificadores internos retornados pela consulta do template, não a chave (key) declarada pelo usuário.

Para desativar uma regra existente, envie o objeto de regra com active: false e operations como lista vazia — enviar o valor nulo para o objeto de regra é rejeitado com erro de validação.

Chamar este endpoint desativa o template como efeito colateral. É necessário ativar o template novamente (ver endpoint de ativação) logo em seguida para que ele volte a ficar disponível para geração de documentos.

curl --location --request PUT '/templates//fields/rules' \ --header 'Content-Type: application/json' \ --data '{ "items": [ { "fieldId": "string", "rules": { "trigger": "string", "active": true, "operations": [ { "conditions": [ { "fieldId": "string", "operator": "string", "value": null } ], "actions": [ { "type": "show", "targetFieldId": "string" } ] } ] } } ] }'

Configurar regras condicionais do template

Requisição

Respostas