Create rule

Creates a conditional rule associated with a field of a client configuration. A rule describes a trigger (trigger) and one of two possible behaviors:

Conditional display (operations): a list of operations, each combining conditions (conditions, with fieldId, operator and value) and actions (actions, with type — show or hide — and targetFieldId, the affected field). A single rule may contain multiple operations, and each operation may trigger multiple actions.

Automatic calculation (calculation): an arithmetic expression (expression) referencing other fields by identifier, a target field (targetFieldId) that receives the result, and optionally the decimal precision (precision) and whether the target field remains editable (editable).

Important: rules are evaluated on the user interface, while the registration form is being filled in. The API stores the rule definition but does not execute it over client records created or updated directly — in other words, sending values for a client's fields through the API does not trigger the automatic calculation nor reflect the show/hide state.

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