BRM APIs
The IoT.live BRM APIs provide programmatic access to Business Rules Management functionality.
These APIs support:
- Creating and updating BRM rules
- Managing BRM topics
- Listing BRM notifications
- Updating notification status
- Registering or unregistering accounts from BRM services
[IMAGE PLACEHOLDER: BRM API overview]
BRM API overview
BRM APIs are used to manage business rules, topics, categories, and notifications.
Core BRM API areas include:
Area | Purpose |
|---|---|
Rules | Create, update, list, retrieve, and delete BRM rules |
Topics | Manage BRM topics and topic names |
Categories | List BRM topic categories |
Notifications | List and update BRM notifications |
Service Registration | Register or unregister an account from BRM services |
Rule management APIs
Rule management APIs include:
API | Purpose |
|---|---|
updateBrmRule | Create a new BRM rule or update an existing rule |
deleteBrmRules | Delete BRM rules |
listBrmRules | Search and list BRM rules |
getBrmRuleDetails | Retrieve details for a specific BRM rule |
[IMAGE PLACEHOLDER: BRM rule management workflow]
Example listBrmRules request
Example updateBrmRule request
Field-level rule configuration should be documented from the Swagger schema before production use.
Topic management APIs
BRM topics can be managed using:
API | Purpose |
|---|---|
listBrmTopics | Search and list BRM topics |
listBrmTopicNames | Search and list BRM topic names |
updateBrmTopic | Create or update a BRM topic |
deleteBrmTopics | Delete BRM topics and associated rules |
[IMAGE PLACEHOLDER: BRM topic management workflow]
Category APIs
The listBrmCategories API returns searchable and paginated BRM topic category information.
Typical use cases include:
- Building rule configuration interfaces
- Grouping BRM topics
- Supporting notification workflows
- Synchronising category lists externally
Notification APIs
BRM notification APIs include:
API | Purpose |
|---|---|
listBrmNotifications | Search and list BRM notifications |
updateBrmNotificationStatus | Update the status of selected notifications |
updateAllBrmNotificationsStatus | Update notification status for all notifications for a specific user |
getNewBrmNotificationsCount | Retrieve filtered notification counts |
[IMAGE PLACEHOLDER: BRM notification workflow]
Example listBrmNotifications request
Service registration APIs
BRM service registration APIs include:
API | Purpose |
|---|---|
registerToBrmService | Register an account to the BRM service |
unregisterFromBrmService | Deregister an account from the BRM service |
These APIs are used when enabling or disabling BRM service participation for an account.
Common BRM integration scenarios
Typical BRM integrations include:
- Business alert configuration
- Notification dashboards
- Rule management portals
- Operational alert workflows
- Customer-facing alert management tools
Permissions and access
BRM APIs may require specific account permissions or service contracts.
If access is unavailable, the API may return:
- Not_Allowed
- No_Contract
- Contract_Expired
BRM rules and notifications may trigger operational or customer-facing workflows. Restrict write access carefully.
Best practices
Recommended BRM API practices include:
- Use dedicated API users for BRM integrations
- Validate rule schemas before updates
- Log corrId values for traceability
- Review notification state changes carefully
- Test new rule behaviour before production use