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

Contents

Overview

A DocumentSubscription is a snapshot of concrete Subscription materialized from a generic Subscription snapshot.

DocumentSubscription can be retrieved by calling getMaterializedSubscription from a Subscription instance.

DocumentSubscription can be created by specifying SubscriptionTriggerType to describe what kind of content operation(s) the subscription is listening to.

SubscriptionTriggerType.ANY_CREATED_IN_ATTACHED_CONTAINER : for any document created or moved into (or under a sub-folder of) a given folder container that subscription is attached to.

SubscriptionTriggerType.ANY_UPDATED_IN_ATTACHED_CONTAINER : for any document updated in (or under a sub-folder of) a given folder container that subscription is attached to.

SubscriptionTriggerType.ANY_DELETED_IN_ATTACHED_CONTAINER : for any document deleted in (or under a sub-folder of) a given folder container that subscription is attached to.

SubscriptionTriggerType.UPDATED_ON_ATTACHED_INSTANCE : for the update on a given document instance that subscription is attached to.

SubscriptionTriggerType.DELETED_ON_ATTACHED_INSTANCE : for the delete on a given document instance that subscription is attached to.

Members

Name Type Description

actions

documentSubscriptionAction[]

List of DocumentSubscriptionAction for the DocumentSubscription

conditions

documentSubscriptionCondition[]

List of DocumentSubscriptionCondition for the DocumentSubscription

triggerType

subscriptionTriggerType

Operation type on the attached Folder container or Document instance the subscription is listening to. For any document under a folder container, the trigger types include: ANY_CREATED_IN_ATTACHED_CONTAINER, ANY_UPDATED_IN_ATTACHED_CONTAINER, ANY_DELETED_IN_ATTACHED_CONTAINER For document instance itself, the trigger types include: UPDATED_ON_ATTACHED_INSTANCE, DELETED_ON_ATTACHED_INSTANCE

Hierarchy

Inherits From

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:documentSubscription xsi:type="obh:documentSubscription" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:actions>your_documentSubscriptionAction_0</obh:actions>
        <obh:actions>your_documentSubscriptionAction_1</obh:actions>
        <obh:actions>your_documentSubscriptionAction_2</obh:actions>
        <obh:conditions>your_documentSubscriptionCondition_0</obh:conditions>
        <obh:conditions>your_documentSubscriptionCondition_1</obh:conditions>
        <obh:conditions>your_documentSubscriptionCondition_2</obh:conditions>
        <obh:triggerType>your_subscriptionTriggerType_0</obh:triggerType>
</obh:documentSubscription>

JSON Example

(show inherited members)

{
    "beeType":"documentSubscription",
        "actions":[
            { your_{http://www.oracle.com/beehive}actions_as_documentSubscriptionAction0 },
            { your_{http://www.oracle.com/beehive}actions_as_documentSubscriptionAction1 },
            { your_{http://www.oracle.com/beehive}actions_as_documentSubscriptionAction2 }
        ],
        "conditions":[
            { your_{http://www.oracle.com/beehive}conditions_as_documentSubscriptionCondition0 },
            { your_{http://www.oracle.com/beehive}conditions_as_documentSubscriptionCondition1 },
            { your_{http://www.oracle.com/beehive}conditions_as_documentSubscriptionCondition2 }
        ],
        "triggerType":{ your_{http://www.oracle.com/beehive}triggerType_as_subscriptionTriggerType0 }
}

XML Schema


<xs:complexType name="documentSubscription">
    <xs:complexContent>
        <xs:extension base="tns:materializedSubscription">
            <xs:sequence>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="actions" type="tns:documentSubscriptionAction"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="conditions" type="tns:documentSubscriptionCondition"/>
                <xs:element minOccurs="0" name="triggerType" type="tns:subscriptionTriggerType"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to documentSubscription

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions

Not Referenced Directly by Representations