Oracle Beehive
  Oracle® Beehive RESTful Web Services API Reference
  Release 2 (2.0.1.7)
  E16658-04

Contents

Overview

A Rule is an instance of the rule defintion with all the attribute values bound from a rule definition.

If the Rule is based on RuleTemplate then AttributeApplication values need to be provided for corresponding AttributeTemplates defined at the RuleTemplate.

Members

Name Type Description

actionPreferences

associativeArray<stringstring>

preferences of the rule action. Each rule can have action preferences. This will return the action preferences of the of the rule if the rule is based on the rule template otherwise action preferences are part of Rule Defition.

attributes

attributeApplication[]

the property values of the corresponding AttributeDefinition defined in the RuleDefinition are returned if the rule is defined based on the Template If the rule is not based on template then returns empty attributes.

collabId

beeId

definition

ruleDefinition

The rule defintion to which policy refers to.

ruleTemplate

ruleTemplate

returns Rule Template if the rule is based on the template otherwise returns null.

Hierarchy

Applied Markers

Examples

Below are examples in JSON and XML formats. All examples are shown with all inherited members. Quoting when required is part of the examples, but you must obviously populate with your own data.

XML Example

(show inherited members)

<obh:rule xsi:type="obh:rule" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:actionPreferences>your_associativeArray_0</obh:actionPreferences>
        <obh:attributes>your_attributeApplication_0</obh:attributes>
        <obh:attributes>your_attributeApplication_1</obh:attributes>
        <obh:attributes>your_attributeApplication_2</obh:attributes>
        <obh:collabId>your_beeId_0</obh:collabId>
        <obh:definition>your_ruleDefinition_0</obh:definition>
        <obh:ruleTemplate>your_ruleTemplate_0</obh:ruleTemplate>
</obh:rule>

JSON Example

(show inherited members)

{
    "beeType":"rule",
        "actionPreferences":{ your_{http://www.oracle.com/beehive}actionPreferences_as_associativeArray0 },
        "attributes":[
            { your_{http://www.oracle.com/beehive}attributes_as_attributeApplication0 },
            { your_{http://www.oracle.com/beehive}attributes_as_attributeApplication1 },
            { your_{http://www.oracle.com/beehive}attributes_as_attributeApplication2 }
        ],
        "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
        "definition":{ your_{http://www.oracle.com/beehive}definition_as_ruleDefinition0 },
        "ruleTemplate":{ your_{http://www.oracle.com/beehive}ruleTemplate_as_ruleTemplate0 }
}

XML Schema


<xs:complexType final="extension restriction" name="rule">
    <xs:sequence>
        <xs:element minOccurs="0" name="actionPreferences" type="tns:associativeArray"/>
        <xs:element maxOccurs="unbounded" minOccurs="0"
            name="attributes" nillable="true" type="tns:attributeApplication"/>
        <xs:element minOccurs="0" name="collabId" type="tns:beeId"/>
        <xs:element minOccurs="0" name="definition" type="tns:ruleDefinition"/>
        <xs:element minOccurs="0" name="ruleTemplate" type="tns:ruleTemplate"/>
    </xs:sequence>
</xs:complexType>

        

References

The following data represents the references to rule

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions