Business Rules API

A business rule is a decision of the business the system must honour: a limit it refuses to cross, a fact derived from others, a number worked out from others, a conclusion drawn when conditions hold, an action it takes when they do, or a standing policy. Every rule numbers on the rules' own sequence (CRM-BR-7) whatever its kind, and carries the rule in plain words, the condition it fires on and what follows, the exceptions, worked examples of an input and what is expected, who has the authority to change it, its MoSCoW priority, the dates it is in force, who answers for it and where it stands, from draft through review to approved, baselined or deprecated.

Every save of a rule writes a version. The versions are read and put back through the endpoints below, under the rule's own abilities.

The reads here see the rules of the projects the token may see; a client guest's token sees the approved and baselined ones only, because a draft is the analyst's working note until the client signs it off. A rule outside that set is a 404 RESOURCE_NOT_FOUND, never a 403. Every write runs the same action the Business Rules page runs, under the project permissions, and announces itself as a business_rule.* event.

EndpointsCopy Anchor Link

Related

Requirements APIThe requirements the rules constrain, once links land.Stakeholders APIThe people a rule's authority can be.Activity APIWho changed a rule and when, beside the versions themselves.business_rule.* eventsThe lifecycle of a project's business rules: a rule added, changed, moved along its review lifecycle, put back to an earlier version and deleted.