The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter describes the Rules API:
The Rules API provides basic functionality to add, remove, activate, deactivate, and find rules. Each rule is identified by a name and a user. A user cannot have two rules with the same name, but different users can have rules with the same name.
When creating new rules, specify the rule name. To create a new rule, use the same syntax used in the Search API.
After creating a rule, the IoT FND Rules API returns a rule ID, which you can use to refer to the rule for removing, activating, and deactivating, operations. By default, IoT FND activates rules when created with actions.
In your IoT FND NB API client application, use this IoT FND server URL to access the Rules API WSDL:
http:// <server_address> /nbapi/rules?wsdl
This call activates a deactivated rule. By default, when you create a rule with actions, IoT FND activates it. Only activated rules receive trigger events on rule matching.
|
|
|
---|---|---|
This call returns the rule object if activation is successful.
|
|
|
---|---|---|
Rule properties such as name, username, status, and lastUpdate. |
||
activateRule SOAP XML Request Format
This call creates a new rule with the specified action and name. The rule language is the same as the search language. The action can be one of the following: create label, remove label, or add event.
|
|
|
---|---|---|
A list of rule actions. For every action, you must provide two strings: |
|
|
|
---|---|---|
Rule properties such as name, username, status, and lastUpdate. |
||
createRule SOAP XML Request Format
This call deactivates the specified rule and returns the rule object if deactivation is successful.
|
|
|
---|---|---|
This call returns the rule object if deactivation is successful.
|
|
|
---|---|---|
Rule properties such as name, username, status, and lastUpdate. |
||
deactivateRule SOAP XML Request Format
This call removes the rule specified in the id parameter.
|
|
|
---|---|---|
|
|
|
---|---|---|
Rule properties such as name, username, status, and lastUpdate. |
||
dropRule SOAP XML Request Format
This call returns all rules specified in the name parameter.
|
|
|
---|---|---|
This call returns a list of rules matching the name string.
|
|
|
---|---|---|
Rule properties such as name, username, status, and lastUpdate. |
||
findRulesByName SOAP XML Request Format
This call returns a list of rules created by the user defined in username.
|
|
|
---|---|---|
|
|
|
---|---|---|
Rule properties such as name, username, status, and lastUpdate. |
||
findRulesByUsername SOAP XML Request Format