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

Beehive Development Kit » All Representations » subscriptionTemplate
Contents

Overview

A subscription template defines a variant of the subscription schema by supplying the default settings or prescribing how to collect the settings for the required attributes.

Members

Name Type Required Description

allowMultiple

boolean
Returns allowMultiple of the SubscriptionTemplate TRUE: multiple subscriptions are allowed to be created based on the SubscriptionTemplate per subscriber FALSE: multiple subscriptions are not allowed to be created based on the SubscriptionTemplate per subscriber

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

attributeTemplates

attributeTemplate[]
Returns the list of attribute templates associated with this BasicTemplate.

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.

description

string
Returns the Description of the Template

entitySchema

entitySchema
Returns the EntitySchema for the BasicTemplate

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.

subscriptionRules

subscriptionRule[]
Gets the pre-defined Subscription Rules

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:subscriptionTemplate xsi:type="obh:subscriptionTemplate" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:allowMultiple>your_boolean_0</obh:allowMultiple>
         <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:attributeTemplates>your_attributeTemplate_0</obh:attributeTemplates>
        <obh:attributeTemplates>your_attributeTemplate_1</obh:attributeTemplates>
        <obh:attributeTemplates>your_attributeTemplate_2</obh:attributeTemplates>
         <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:description>your_string_0</obh:description>
         <obh:entitySchema>your_entitySchema_0</obh:entitySchema>
         <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:subscriptionRules>your_subscriptionRule_0</obh:subscriptionRules>
        <obh:subscriptionRules>your_subscriptionRule_1</obh:subscriptionRules>
        <obh:subscriptionRules>your_subscriptionRule_2</obh:subscriptionRules>
         <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:subscriptionTemplate>

JSON Example

(show inherited members)

{
    "beeType":"subscriptionTemplate",
        "allowMultiple":your_{http://www.oracle.com/beehive}allowMultiple_as_boolean0,
         "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 }
        ],
         "attributeTemplates":[
            { your_{http://www.oracle.com/beehive}attributeTemplates_as_attributeTemplate0 },
            { your_{http://www.oracle.com/beehive}attributeTemplates_as_attributeTemplate1 },
            { your_{http://www.oracle.com/beehive}attributeTemplates_as_attributeTemplate2 }
        ],
         "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,
         "description":"your_{http://www.oracle.com/beehive}description_as_string0",
         "entitySchema":{ your_{http://www.oracle.com/beehive}entitySchema_as_entitySchema0 },
         "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",
         "subscriptionRules":[
            { your_{http://www.oracle.com/beehive}subscriptionRules_as_subscriptionRule0 },
            { your_{http://www.oracle.com/beehive}subscriptionRules_as_subscriptionRule1 },
            { your_{http://www.oracle.com/beehive}subscriptionRules_as_subscriptionRule2 }
        ],
         "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="subscriptionTemplate">
    <xs:complexContent>
        <xs:extension base="tns:basicTemplate">
            <xs:sequence>
                <xs:element minOccurs="0" name="allowMultiple" type="xs:boolean"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="subscriptionRules" nillable="true" type="tns:subscriptionRule"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

References

The following data represents the references to subscriptionTemplate

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions

Not Referenced Directly by Representations

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