A script enabled browser is required for this page to function properly
Oracle® Beehive RESTful Web Services API Reference
Release 2 (2.0.1.7)
E16658-04
Overview
A subscription schema defines the attributes that can be part of the user
subscriptions. There is at most one subscription schema for each source
entity class, which can be a workspace, calendar, task list, forum, message,
folder, etc. A subscription for entities of an entity class can be composed
according to the entity or container level subscription rule definitions,
depending on whether the subscription is attached to the container of the
entity or to the entity itself. The container subscription rule definitions
are used to compose a blanket subscription on all entities of an entity class
in the container.
Members
Show inherited members
Projections
BASIC
EMPTY
FULL
META
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
attributes
attributeDefinition []
collabId
beeId
CollabId of the snapshot
containerSubscriptionRuleDefinitions
subscriptionRuleDefinition []
Gets the container-level SubscriptionRuleDefinition
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.
description
string
entitySubscriptionRuleDefinitions
subscriptionRuleDefinition []
Gets the entity-level SubscriptionRuleDefinition
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.
snapshotId
string
Contains the snapshot identifier for this snapshot. Snapshot identifiers
are used to implement optimistic locking on the server.
sourceEntityClass
string
Gets the EntityClass of the source entity
Hierarchy
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)
JSON Example
(show inherited members)
{
"beeType":"subscriptionSchema",
"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 }
],
"attributes":[
{ your_{http://www.oracle.com/beehive}attributes_as_attributeDefinition0 },
{ your_{http://www.oracle.com/beehive}attributes_as_attributeDefinition1 },
{ your_{http://www.oracle.com/beehive}attributes_as_attributeDefinition2 }
],
"collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
"containerSubscriptionRuleDefinitions":[
{ your_{http://www.oracle.com/beehive}containerSubscriptionRuleDefinitions_as_subscriptionRuleDefinition0 },
{ your_{http://www.oracle.com/beehive}containerSubscriptionRuleDefinitions_as_subscriptionRuleDefinition1 },
{ your_{http://www.oracle.com/beehive}containerSubscriptionRuleDefinitions_as_subscriptionRuleDefinition2 }
],
"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,
"description":"your_{http://www.oracle.com/beehive}description_as_string0",
"entitySubscriptionRuleDefinitions":[
{ your_{http://www.oracle.com/beehive}entitySubscriptionRuleDefinitions_as_subscriptionRuleDefinition0 },
{ your_{http://www.oracle.com/beehive}entitySubscriptionRuleDefinitions_as_subscriptionRuleDefinition1 },
{ your_{http://www.oracle.com/beehive}entitySubscriptionRuleDefinitions_as_subscriptionRuleDefinition2 }
],
"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 },
"snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
"sourceEntityClass":"your_{http://www.oracle.com/beehive}sourceEntityClass_as_string0"
}
XML Schema
<xs:complexType name="subscriptionSchema">
<xs:complexContent>
<xs:extension base="tns:entitySchema">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0"
name="containerSubscriptionRuleDefinitions"
nillable="true" type="tns:subscriptionRuleDefinition"/>
<xs:element maxOccurs="unbounded" minOccurs="0"
name="entitySubscriptionRuleDefinitions"
nillable="true" type="tns:subscriptionRuleDefinition"/>
<xs:element minOccurs="0" name="sourceEntityClass" type="xs:string"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
References
The following data represents the references to subscriptionSchema
Referenced By Resources
Referenced By Representaions
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices