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

Contents

Overview

Represent a snapshot of a OccurrenceSeries.

An occurrence series is a set containing all the occurrences associated with the same event. Every occurrence, including a single instance event, is associated with an occurrence series.

The attributes of the occurrence series are used as default values when new occurrences are added or when expanding the recurrence rules at creation.

When the ParticipantStatus of an InvitationSeries yielded by this Occurrence is modified:

Members

Name Type Required Description

ICalClass

string

ICalPriority

int

ICalSequence

int

ICalUid

string

URL

string

allowAllInviteesToPublishBonds

boolean

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

attachments

anyType[]

bonds

bond[]

collabId

beeId

CollabId of the snapshot

companyNames

string[]

compositeParticipants

occurrenceCompositeParticipant[]

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

dialInInfo

string

duration

long

Get the OccurrenceSries Duration.

Loaded with:
Projection.BASIC

endTimeZone

timeZone

Get the OccurrenceSries EndTimeZone.

Loaded with:
Projection.BASIC

equipment

string[]

explicitlyModifiedOn

dateTime

This attribute was introduced and should only be used by the coexistence service.

Loaded with:
Projection.BASIC

hasCompositeParticipants

boolean

hasMultipleInstances

boolean

hasMultipleParticipants

boolean

hasPendingReminders

boolean

internalOrganizer

actor

invitationSeriesListModifiedOn

dateTime

Return the last time an associated invitation series was added or deleted

Loaded with:
Projection.BASIC

journalEntryType

journalEntryType

location

location

modifiedBy

actor

The actor that last modified the entity

modifiedOn

dateTime

The date when entity was last modified

name

string

Name of the entity.

occurrences

occurrence[]

Get the occurrences of the Occurrence series.

Loaded with:
OccurrenceSeries.OCCURRENCES, ArtifactListProjection with OccurrenceListFilter, Projection.FULL

organizer

participant

originalInclusionRule

string

Get the OriginalInclusionRule attribute of the OccurrenceSeries. This attribute is set to the initial value of InclusionRule on the Recurrences element passed at creation. The InclusionRule can be modified transparently by the system (e.g. to limit the number of instances), the originalInclusionRule is used to preserve the initial intent.

parent

entity

The parent for this entity.

participants

occurrenceParticipant[]

priority

priority

properties

collabProperties

publishedBonds

bond[]

receptionChannel

participantDeliveryChannel

recurrences

dateTimeRecurrenceSet

Get the Recurrences attribute of the OccurrenceSeries. The recurrences attribute of a series is used to determine the set of occurrences to create. For every DateTime of the recurrences an occurrence starting and that time is created, and end time is computed by adding the duration of the series. The recurrences attribute is typically only set at creation. Explicitly updating the recurrence on an existing series is permitted; however it is equivalent to deleting all the occurrences of the series and recreating new ones.

recurrencesNoThrow

dateTimeRecurrenceSet

sensitivity

sensitivity

seriesProperties

collabProperties

Return the SeriesProperties attribute

Loaded with:
Projection.META

size

long

snapshotId

string

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

status

occurrenceStatus

transparency

transparency

type

occurrenceType

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:occurrenceSeries xsi:type="obh:occurrenceSeries" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:ICalClass>your_string_0</obh:ICalClass>
        <obh:ICalPriority>your_int_0</obh:ICalPriority>
        <obh:ICalSequence>your_int_0</obh:ICalSequence>
        <obh:ICalUid>your_string_0</obh:ICalUid>
        <obh:URL>your_string_0</obh:URL>
        <obh:allowAllInviteesToPublishBonds>your_boolean_0</obh:allowAllInviteesToPublishBonds>
        <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:attachments>your_anyType_0</obh:attachments>
        <obh:attachments>your_anyType_1</obh:attachments>
        <obh:attachments>your_anyType_2</obh:attachments>
        <obh:bonds>your_bond_0</obh:bonds>
        <obh:bonds>your_bond_1</obh:bonds>
        <obh:bonds>your_bond_2</obh:bonds>
        <obh:collabId>your_beeId_0</obh:collabId>
        <obh:companyNames>your_string_0</obh:companyNames>
        <obh:companyNames>your_string_1</obh:companyNames>
        <obh:companyNames>your_string_2</obh:companyNames>
        <obh:compositeParticipants>your_occurrenceCompositeParticipant_0</obh:compositeParticipants>
        <obh:compositeParticipants>your_occurrenceCompositeParticipant_1</obh:compositeParticipants>
        <obh:compositeParticipants>your_occurrenceCompositeParticipant_2</obh:compositeParticipants>
        <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:dialInInfo>your_string_0</obh:dialInInfo>
        <obh:duration>your_long_0</obh:duration>
        <obh:endTimeZone>your_timeZone_0</obh:endTimeZone>
        <obh:equipment>your_string_0</obh:equipment>
        <obh:equipment>your_string_1</obh:equipment>
        <obh:equipment>your_string_2</obh:equipment>
        <obh:explicitlyModifiedOn>your_dateTime_0</obh:explicitlyModifiedOn>
        <obh:hasCompositeParticipants>your_boolean_0</obh:hasCompositeParticipants>
        <obh:hasMultipleInstances>your_boolean_0</obh:hasMultipleInstances>
        <obh:hasMultipleParticipants>your_boolean_0</obh:hasMultipleParticipants>
        <obh:hasPendingReminders>your_boolean_0</obh:hasPendingReminders>
        <obh:internalOrganizer>your_actor_0</obh:internalOrganizer>
        <obh:invitationSeriesListModifiedOn>your_dateTime_0</obh:invitationSeriesListModifiedOn>
        <obh:journalEntryType>your_journalEntryType_0</obh:journalEntryType>
        <obh:location>your_location_0</obh:location>
        <obh:modifiedBy>your_actor_0</obh:modifiedBy>
        <obh:modifiedOn>your_dateTime_0</obh:modifiedOn>
        <obh:name>your_string_0</obh:name>
        <obh:occurrences>your_occurrence_0</obh:occurrences>
        <obh:occurrences>your_occurrence_1</obh:occurrences>
        <obh:occurrences>your_occurrence_2</obh:occurrences>
        <obh:organizer>your_participant_0</obh:organizer>
        <obh:originalInclusionRule>your_string_0</obh:originalInclusionRule>
        <obh:parent>your_entity_0</obh:parent>
        <obh:participants>your_occurrenceParticipant_0</obh:participants>
        <obh:participants>your_occurrenceParticipant_1</obh:participants>
        <obh:participants>your_occurrenceParticipant_2</obh:participants>
        <obh:priority>your_priority_0</obh:priority>
        <obh:properties>your_collabProperties_0</obh:properties>
        <obh:publishedBonds>your_bond_0</obh:publishedBonds>
        <obh:publishedBonds>your_bond_1</obh:publishedBonds>
        <obh:publishedBonds>your_bond_2</obh:publishedBonds>
        <obh:receptionChannel>your_participantDeliveryChannel_0</obh:receptionChannel>
        <obh:recurrences>your_dateTimeRecurrenceSet_0</obh:recurrences>
        <obh:recurrencesNoThrow>your_dateTimeRecurrenceSet_0</obh:recurrencesNoThrow>
        <obh:sensitivity>your_sensitivity_0</obh:sensitivity>
        <obh:seriesProperties>your_collabProperties_0</obh:seriesProperties>
        <obh:size>your_long_0</obh:size>
        <obh:snapshotId>your_string_0</obh:snapshotId>
        <obh:status>your_occurrenceStatus_0</obh:status>
        <obh:transparency>your_transparency_0</obh:transparency>
        <obh:type>your_occurrenceType_0</obh:type>
</obh:occurrenceSeries>

JSON Example

(show inherited members)

{
    "beeType":"occurrenceSeries",
        "ICalClass":"your_{http://www.oracle.com/beehive}ICalClass_as_string0",
        "ICalPriority":your_{http://www.oracle.com/beehive}ICalPriority_as_int0,
        "ICalSequence":your_{http://www.oracle.com/beehive}ICalSequence_as_int0,
        "ICalUid":"your_{http://www.oracle.com/beehive}ICalUid_as_string0",
        "URL":"your_{http://www.oracle.com/beehive}URL_as_string0",
        "allowAllInviteesToPublishBonds":your_{http://www.oracle.com/beehive}allowAllInviteesToPublishBonds_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 }
        ],
        "attachments":[
            "your_{http://www.oracle.com/beehive}attachments_as_anyType0",
            "your_{http://www.oracle.com/beehive}attachments_as_anyType1",
            "your_{http://www.oracle.com/beehive}attachments_as_anyType2"
        ],
        "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 }
        ],
        "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
        "companyNames":[
            "your_{http://www.oracle.com/beehive}companyNames_as_string0",
            "your_{http://www.oracle.com/beehive}companyNames_as_string1",
            "your_{http://www.oracle.com/beehive}companyNames_as_string2"
        ],
        "compositeParticipants":[
            { your_{http://www.oracle.com/beehive}compositeParticipants_as_occurrenceCompositeParticipant0 },
            { your_{http://www.oracle.com/beehive}compositeParticipants_as_occurrenceCompositeParticipant1 },
            { your_{http://www.oracle.com/beehive}compositeParticipants_as_occurrenceCompositeParticipant2 }
        ],
        "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",
        "dialInInfo":"your_{http://www.oracle.com/beehive}dialInInfo_as_string0",
        "duration":your_{http://www.oracle.com/beehive}duration_as_long0,
        "endTimeZone":{ your_{http://www.oracle.com/beehive}endTimeZone_as_timeZone0 },
        "equipment":[
            "your_{http://www.oracle.com/beehive}equipment_as_string0",
            "your_{http://www.oracle.com/beehive}equipment_as_string1",
            "your_{http://www.oracle.com/beehive}equipment_as_string2"
        ],
        "explicitlyModifiedOn":"your_{http://www.oracle.com/beehive}explicitlyModifiedOn_as_dateTime0",
        "hasCompositeParticipants":your_{http://www.oracle.com/beehive}hasCompositeParticipants_as_boolean0,
        "hasMultipleInstances":your_{http://www.oracle.com/beehive}hasMultipleInstances_as_boolean0,
        "hasMultipleParticipants":your_{http://www.oracle.com/beehive}hasMultipleParticipants_as_boolean0,
        "hasPendingReminders":your_{http://www.oracle.com/beehive}hasPendingReminders_as_boolean0,
        "internalOrganizer":{ your_{http://www.oracle.com/beehive}internalOrganizer_as_actor0 },
        "invitationSeriesListModifiedOn":"your_{http://www.oracle.com/beehive}invitationSeriesListModifiedOn_as_dateTime0",
        "journalEntryType":{ your_{http://www.oracle.com/beehive}journalEntryType_as_journalEntryType0 },
        "location":{ your_{http://www.oracle.com/beehive}location_as_location0 },
        "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",
        "occurrences":[
            { your_{http://www.oracle.com/beehive}occurrences_as_occurrence0 },
            { your_{http://www.oracle.com/beehive}occurrences_as_occurrence1 },
            { your_{http://www.oracle.com/beehive}occurrences_as_occurrence2 }
        ],
        "organizer":{ your_{http://www.oracle.com/beehive}organizer_as_participant0 },
        "originalInclusionRule":"your_{http://www.oracle.com/beehive}originalInclusionRule_as_string0",
        "parent":{ your_{http://www.oracle.com/beehive}parent_as_entity0 },
        "participants":[
            { your_{http://www.oracle.com/beehive}participants_as_occurrenceParticipant0 },
            { your_{http://www.oracle.com/beehive}participants_as_occurrenceParticipant1 },
            { your_{http://www.oracle.com/beehive}participants_as_occurrenceParticipant2 }
        ],
        "priority":{ your_{http://www.oracle.com/beehive}priority_as_priority0 },
        "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
        "publishedBonds":[
            { your_{http://www.oracle.com/beehive}publishedBonds_as_bond0 },
            { your_{http://www.oracle.com/beehive}publishedBonds_as_bond1 },
            { your_{http://www.oracle.com/beehive}publishedBonds_as_bond2 }
        ],
        "receptionChannel":{ your_{http://www.oracle.com/beehive}receptionChannel_as_participantDeliveryChannel0 },
        "recurrences":{ your_{http://www.oracle.com/beehive}recurrences_as_dateTimeRecurrenceSet0 },
        "recurrencesNoThrow":{ your_{http://www.oracle.com/beehive}recurrencesNoThrow_as_dateTimeRecurrenceSet0 },
        "sensitivity":{ your_{http://www.oracle.com/beehive}sensitivity_as_sensitivity0 },
        "seriesProperties":{ your_{http://www.oracle.com/beehive}seriesProperties_as_collabProperties0 },
        "size":your_{http://www.oracle.com/beehive}size_as_long0,
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
        "status":{ your_{http://www.oracle.com/beehive}status_as_occurrenceStatus0 },
        "transparency":{ your_{http://www.oracle.com/beehive}transparency_as_transparency0 },
        "type":{ your_{http://www.oracle.com/beehive}type_as_occurrenceType0 }
}

XML Schema


<xs:complexType name="occurrenceSeries">
    <xs:complexContent>
        <xs:extension base="tns:entity">
            <xs:sequence>
                <xs:element name="allowAllInviteesToPublishBonds" type="xs:boolean"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="attachments" nillable="true" type="xs:anyType"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="bonds" nillable="true" type="tns:bond"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="companyNames" nillable="true" type="xs:string"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="compositeParticipants" nillable="true" type="tns:occurrenceCompositeParticipant"/>
                <xs:element minOccurs="0" name="description" type="xs:string"/>
                <xs:element minOccurs="0" name="dialInInfo" type="xs:string"/>
                <xs:element minOccurs="0" name="duration" type="xs:long"/>
                <xs:element minOccurs="0" name="endTimeZone" type="tns:timeZone"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="equipment" nillable="true" type="xs:string"/>
                <xs:element minOccurs="0" name="explicitlyModifiedOn" type="xs:dateTime"/>
                <xs:element name="hasCompositeParticipants" type="xs:boolean"/>
                <xs:element name="hasMultipleInstances" type="xs:boolean"/>
                <xs:element name="hasMultipleParticipants" type="xs:boolean"/>
                <xs:element name="hasPendingReminders" type="xs:boolean"/>
                <xs:element minOccurs="0" name="ICalClass" type="xs:string"/>
                <xs:element name="ICalPriority" type="xs:int"/>
                <xs:element name="ICalSequence" type="xs:int"/>
                <xs:element minOccurs="0" name="ICalUid" type="xs:string"/>
                <xs:element minOccurs="0" name="internalOrganizer" type="tns:actor"/>
                <xs:element minOccurs="0"
                    name="invitationSeriesListModifiedOn" type="xs:dateTime"/>
                <xs:element minOccurs="0" name="journalEntryType" type="tns:journalEntryType"/>
                <xs:element minOccurs="0" name="location" type="tns:location"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="occurrences" nillable="true" type="tns:occurrence"/>
                <xs:element minOccurs="0" name="organizer" type="tns:participant"/>
                <xs:element minOccurs="0" name="originalInclusionRule" type="xs:string"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="participants" nillable="true" type="tns:occurrenceParticipant"/>
                <xs:element minOccurs="0" name="priority" type="tns:priority"/>
                <xs:element minOccurs="0" name="properties" type="tns:collabProperties"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="publishedBonds" nillable="true" type="tns:bond"/>
                <xs:element minOccurs="0" name="receptionChannel" type="tns:participantDeliveryChannel"/>
                <xs:element minOccurs="0" name="recurrences" type="tns:dateTimeRecurrenceSet"/>
                <xs:element minOccurs="0" name="recurrencesNoThrow" type="tns:dateTimeRecurrenceSet"/>
                <xs:element minOccurs="0" ref="tns:sensitivity"/>
                <xs:element minOccurs="0" name="seriesProperties" type="tns:collabProperties"/>
                <xs:element name="size" type="xs:long"/>
                <xs:element minOccurs="0" name="status" type="tns:occurrenceStatus"/>
                <xs:element minOccurs="0" name="transparency" type="tns:transparency"/>
                <xs:element minOccurs="0" name="type" type="tns:occurrenceType"/>
                <xs:element minOccurs="0" name="URL" type="xs:string"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to occurrenceSeries

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions