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

Beehive Development Kit » All Representations » subscription
Contents

Overview

A subscription contains the attributes submitted by a user, prescribing how to automatically react or notify the user when some events occur on an entity. A subscription on messages, for example, prescribes how to filter the messages.

A subscription refers to the subscription template that defines the metadata and forms used to construct the subscriptions. The user may enable or disable the subscription at any time. A subscription can be attached to a container to be applied to all entities of the given entity class under the container. It can be overridden by the subscription attached to a specific entity. The Overrides attribute refers to a container-level subscription which it overrides. The subscription rules specify the actions, depending on the conditions around the events, source entities, and action doers, for automatic reaction or notification.

Members

Name Type Required Description

attachedMarkers

marker[]
Set of marker elements associated with the entity.

attachedReminders

reminder[]
List of reminders attached to the entity

attachedSubscriptions

subscription[]
List of subscriptions attached to the entity

attachedTo

beeId<entity>
Gets the EntityHandle the Subscription is attached to

bonds

bond[]
List of artifact bonds

changeStatus

changeStatus
The change status of the artifact

collabId

beeId
CollabId of the snapshot

createdOn

dateTime
Entity's creation date

creator

actor
The actor that created this entity

deleted

boolean
Deletion flag. If this property is set to true the entity is deleted.

enabled

boolean
Returns if the Subscription is enabled

materializedSubscription

materializedSubscription
Get the materialized snapshot of concrete subscription.

modifiedBy

actor
The actor that last modified the entity

modifiedOn

dateTime
The date when entity was last modified

name

string
Name of the entity.

parent

entity
The parent for this entity.

properties

collabProperties
The properties of the artifact that are shared among all the actors

snapshotId

string
Contains the snapshot identifier for this snapshot. Snapshot identifiers are used to implement optimistic locking on the server.

subscriber

organizationUser
Gets the subscriber of the subscription

userCreatedOn

dateTime
The user creation date (if created offline)

userModifiedOn

dateTime
The user last modified date (if modified offline)

viewer

actor
The actor for which this artifact snapshot was loaded. All the artifact viewer properties in this snapshot are loaded for this actor.

viewerProperties

collabProperties
The viewer properties of the artifact that are private to loading actor

Hierarchy

Inherits From

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:subscription xsi:type="obh:subscription" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:attachedMarkers>your_marker_0</obh:attachedMarkers>
        <obh:attachedMarkers>your_marker_1</obh:attachedMarkers>
        <obh:attachedMarkers>your_marker_2</obh:attachedMarkers>
         <obh:attachedReminders>your_reminder_0</obh:attachedReminders>
        <obh:attachedReminders>your_reminder_1</obh:attachedReminders>
        <obh:attachedReminders>your_reminder_2</obh:attachedReminders>
         <obh:attachedSubscriptions>your_subscription_0</obh:attachedSubscriptions>
        <obh:attachedSubscriptions>your_subscription_1</obh:attachedSubscriptions>
        <obh:attachedSubscriptions>your_subscription_2</obh:attachedSubscriptions>
         <obh:attachedTo>your_beeId_0</obh:attachedTo>
         <obh:bonds>your_bond_0</obh:bonds>
        <obh:bonds>your_bond_1</obh:bonds>
        <obh:bonds>your_bond_2</obh:bonds>
         <obh:changeStatus>your_changeStatus_0</obh:changeStatus>
         <obh:collabId>your_beeId_0</obh:collabId>
         <obh:createdOn>your_dateTime_0</obh:createdOn>
         <obh:creator>your_actor_0</obh:creator>
         <obh:deleted>your_boolean_0</obh:deleted>
         <obh:enabled>your_boolean_0</obh:enabled>
         <obh:materializedSubscription>your_materializedSubscription_0</obh:materializedSubscription>
         <obh:modifiedBy>your_actor_0</obh:modifiedBy>
         <obh:modifiedOn>your_dateTime_0</obh:modifiedOn>
         <obh:name>your_string_0</obh:name>
         <obh:parent>your_entity_0</obh:parent>
         <obh:properties>your_collabProperties_0</obh:properties>
         <obh:snapshotId>your_string_0</obh:snapshotId>
         <obh:subscriber>your_organizationUser_0</obh:subscriber>
         <obh:userCreatedOn>your_dateTime_0</obh:userCreatedOn>
         <obh:userModifiedOn>your_dateTime_0</obh:userModifiedOn>
         <obh:viewer>your_actor_0</obh:viewer>
         <obh:viewerProperties>your_collabProperties_0</obh:viewerProperties>
 </obh:subscription>

JSON Example

(show inherited members)

{
    "beeType":"subscription",
        "attachedMarkers":[
            { your_{http://www.oracle.com/beehive}attachedMarkers_as_marker0 },
            { your_{http://www.oracle.com/beehive}attachedMarkers_as_marker1 },
            { your_{http://www.oracle.com/beehive}attachedMarkers_as_marker2 }
        ],
         "attachedReminders":[
            { your_{http://www.oracle.com/beehive}attachedReminders_as_reminder0 },
            { your_{http://www.oracle.com/beehive}attachedReminders_as_reminder1 },
            { your_{http://www.oracle.com/beehive}attachedReminders_as_reminder2 }
        ],
         "attachedSubscriptions":[
            { your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription0 },
            { your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription1 },
            { your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription2 }
        ],
         "attachedTo":{ your_{http://www.oracle.com/beehive}attachedTo_as_beeId0 },
         "bonds":[
            { your_{http://www.oracle.com/beehive}bonds_as_bond0 },
            { your_{http://www.oracle.com/beehive}bonds_as_bond1 },
            { your_{http://www.oracle.com/beehive}bonds_as_bond2 }
        ],
         "changeStatus":{ your_{http://www.oracle.com/beehive}changeStatus_as_changeStatus0 },
         "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
         "createdOn":"your_{http://www.oracle.com/beehive}createdOn_as_dateTime0",
         "creator":{ your_{http://www.oracle.com/beehive}creator_as_actor0 },
         "deleted":your_{http://www.oracle.com/beehive}deleted_as_boolean0,
         "enabled":your_{http://www.oracle.com/beehive}enabled_as_boolean0,
         "materializedSubscription":{ your_{http://www.oracle.com/beehive}materializedSubscription_as_materializedSubscription0 },
         "modifiedBy":{ your_{http://www.oracle.com/beehive}modifiedBy_as_actor0 },
         "modifiedOn":"your_{http://www.oracle.com/beehive}modifiedOn_as_dateTime0",
         "name":"your_{http://www.oracle.com/beehive}name_as_string0",
         "parent":{ your_{http://www.oracle.com/beehive}parent_as_entity0 },
         "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
         "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
         "subscriber":{ your_{http://www.oracle.com/beehive}subscriber_as_organizationUser0 },
         "userCreatedOn":"your_{http://www.oracle.com/beehive}userCreatedOn_as_dateTime0",
         "userModifiedOn":"your_{http://www.oracle.com/beehive}userModifiedOn_as_dateTime0",
         "viewer":{ your_{http://www.oracle.com/beehive}viewer_as_actor0 },
         "viewerProperties":{ your_{http://www.oracle.com/beehive}viewerProperties_as_collabProperties0 }
 }

XML Schema


<xs:complexType name="subscription">
    <xs:complexContent>
        <xs:extension base="tns:artifact">
            <xs:sequence>
                <xs:element minOccurs="0" name="attachedTo" type="tns:beeId"/>
                <xs:element name="enabled" type="xs:boolean"/>
                <xs:element minOccurs="0"
                    name="materializedSubscription" type="tns:materializedSubscription"/>
                <xs:element minOccurs="0" name="subscriber" type="tns:organizationUser"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

References

The following data represents the references to subscription

Referenced By Resources

Usage Resource Method
Response Subscription Create
Request Subscription Delete Batch
Response Subscription List
Response Subscription Read
Response Subscription Update

Referenced By Representaions

Oracle Logo
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices