Criar regra

Cria uma regra condicional associada a um campo de uma configuração de cliente. Uma regra descreve um gatilho (trigger) e um entre dois comportamentos possíveis:

Exibição condicional (operations): uma lista de operações, cada uma combinando condições (conditions, com fieldId, operator e value) e ações (actions, com type — mostrar ou ocultar — e targetFieldId, o campo afetado). Uma mesma regra pode conter múltiplas operações, e cada operação pode disparar múltiplas ações.

Cálculo automático (calculation): uma expressão aritmética (expression) que referencia outros campos pelo identificador, um campo de destino (targetFieldId) que recebe o resultado, e opcionalmente a precisão decimal (precision) e se o campo de destino permanece editável (editable).

Importante: as regras são avaliadas na interface do usuário, no momento do preenchimento do formulário de cadastro. A API armazena a definição da regra, mas não a executa sobre registros de clientes criados ou atualizados diretamente — ou seja, enviar valores para os campos de um cliente pela API não aciona o cálculo automático nem reflete o estado de exibição ou ocultação.

curl --location '/v1/client-config//fields//rules' \ --header 'Content-Type: application/json' \ --data '{ "trigger": "string", "operations": [ { "conditions": [ { "fieldId": "string", "operator": "string", "value": null } ], "actions": [ { "type": "show", "targetFieldId": "string", "value": null } ] } ], "calculation": { "expression": "string", "targetFieldId": "string", "precision": 0, "editable": true }, "active": true }'

{ "id": "string", "trigger": "string", "operations": [ { "conditions": [ { "fieldId": "string", "operator": "string", "value": null } ], "actions": [ { "type": "show", "targetFieldId": "string", "value": null } ] } ], "calculation": { "expression": "string", "targetFieldId": "string", "precision": 0, "editable": true }, "active": true }

Requisição

Respostas