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

Contents

Overview

Represents a snapshot of a Occurrence artifact.

An occurrence instance represents some kind of event that occurs on a calendar, such as a meeting, a day event, etc. An occurrence may also be part of a recurring event, in which case all the related occurrences are part of the same occurrence series.

Occurrences are meant to be manipulated only by the organizer (or someone that was granted special privileges). Occurrences are typically created in the organizer's calendar.

When an occurrence is created the system will automatically create the invitation objects in the participants' default calendars (including the organizer if he/she is also an attendee). Invitations act as proxies to allow the participants to access the information in the source occurrence. Invitations are the objects to be rendered in a day/week/month view of the participant's calendar or when querying the free or busy status of the participant.

The purpose of the occurrence object is to the hold the information common to all the invitations. When an occurrence is modified, the system will automatically make the proper adjustments to the invitations.

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

Members

Name Type Required Description

ICalClass

string

ICalPriority

int

ICalRecurrenceId

dateTime

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[]

List of artifact bonds

changeStatus

changeStatus

The change status of the artifact

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

end

dateTime

Get the Occurrence's end time.

Loaded with:
Projection.BASIC, BaseOccurrence.CALENDAR_VIEW, BaseOccurrence.MEETING_VIEW, Projection.FULL

equipment

string[]

explicitlyModifiedOn

dateTime

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

fromInclusionRule

boolean

Dictates if the Occurrence was yielded from a recurrence rule.

hasCompositeParticipants

boolean

hasMultipleInstances

boolean

hasMultipleParticipants

boolean

hasPendingReminders

boolean

internalOrganizer

actor

invitationListModifiedOn

dateTime

Return the last time an associated invitation was added or deleted

Loaded with:
Projection.BASIC

isFromInclusionRule

boolean

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.

occurrenceExceptionToSeries

exceptionToSeries

Get the OccurrenceExceptionLevel attribute of the Occurrence.

Loaded with:
Projection.BASIC, Occurrence.CALENDAR_VIEW, Occurrence.MEETING_VIEW, Projection.FULL

organizer

participant

parent

entity

The parent for this entity.

participants

occurrenceParticipant[]

priority

priority

properties

collabProperties

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

publishedBonds

bond[]

receptionChannel

participantDeliveryChannel

reminders

reminder[]

sensitivity

sensitivity

series

occurrenceSeries

Get the Occurrence's series.

Loaded with:
Projection.BASIC, Occurrence.CALENDAR_VIEW, Occurrence.MEETING_VIEW, Projection.FULL

size

long

snapshotId

string

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

start

dateTime

Get Occurrence's start time.

Loaded with:
Projection.BASIC, BaseOccurrence.CALENDAR_VIEW, BaseOccurrence.MEETING_VIEW, Projection.FULL

status

occurrenceStatus

transparency

transparency

type

occurrenceType

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:occurrence xsi:type="obh:occurrence" 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:ICalRecurrenceId>your_dateTime_0</obh:ICalRecurrenceId>
        <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:changeStatus>your_changeStatus_0</obh:changeStatus>
        <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:end>your_dateTime_0</obh:end>
        <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:fromInclusionRule>your_boolean_0</obh:fromInclusionRule>
        <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:invitationListModifiedOn>your_dateTime_0</obh:invitationListModifiedOn>
        <obh:isFromInclusionRule>your_boolean_0</obh:isFromInclusionRule>
        <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:occurrenceExceptionToSeries>your_exceptionToSeries_0</obh:occurrenceExceptionToSeries>
        <obh:organizer>your_participant_0</obh:organizer>
        <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:reminders>your_reminder_0</obh:reminders>
        <obh:reminders>your_reminder_1</obh:reminders>
        <obh:reminders>your_reminder_2</obh:reminders>
        <obh:sensitivity>your_sensitivity_0</obh:sensitivity>
        <obh:series>your_occurrenceSeries_0</obh:series>
        <obh:size>your_long_0</obh:size>
        <obh:snapshotId>your_string_0</obh:snapshotId>
        <obh:start>your_dateTime_0</obh:start>
        <obh:status>your_occurrenceStatus_0</obh:status>
        <obh:transparency>your_transparency_0</obh:transparency>
        <obh:type>your_occurrenceType_0</obh:type>
        <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:occurrence>

JSON Example

(show inherited members)

{
    "beeType":"occurrence",
        "ICalClass":"your_{http://www.oracle.com/beehive}ICalClass_as_string0",
        "ICalPriority":your_{http://www.oracle.com/beehive}ICalPriority_as_int0,
        "ICalRecurrenceId":{ your_{http://www.oracle.com/beehive}ICalRecurrenceId_as_dateTime0 },
        "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 }
        ],
        "changeStatus":{ your_{http://www.oracle.com/beehive}changeStatus_as_changeStatus0 },
        "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",
        "end":{ your_{http://www.oracle.com/beehive}end_as_dateTime0 },
        "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",
        "fromInclusionRule":your_{http://www.oracle.com/beehive}fromInclusionRule_as_boolean0,
        "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 },
        "invitationListModifiedOn":"your_{http://www.oracle.com/beehive}invitationListModifiedOn_as_dateTime0",
        "isFromInclusionRule":your_{http://www.oracle.com/beehive}isFromInclusionRule_as_boolean0,
        "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",
        "occurrenceExceptionToSeries":{ your_{http://www.oracle.com/beehive}occurrenceExceptionToSeries_as_exceptionToSeries0 },
        "organizer":{ your_{http://www.oracle.com/beehive}organizer_as_participant0 },
        "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 },
        "reminders":[
            { your_{http://www.oracle.com/beehive}reminders_as_reminder0 },
            { your_{http://www.oracle.com/beehive}reminders_as_reminder1 },
            { your_{http://www.oracle.com/beehive}reminders_as_reminder2 }
        ],
        "sensitivity":{ your_{http://www.oracle.com/beehive}sensitivity_as_sensitivity0 },
        "series":{ your_{http://www.oracle.com/beehive}series_as_occurrenceSeries0 },
        "size":your_{http://www.oracle.com/beehive}size_as_long0,
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
        "start":{ your_{http://www.oracle.com/beehive}start_as_dateTime0 },
        "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 },
        "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="occurrence">
    <xs:complexContent>
        <xs:extension base="tns:artifact">
            <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="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="end" type="tns:dateTime"/>
                <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="fromInclusionRule" type="xs:boolean"/>
                <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 minOccurs="0" name="ICalRecurrenceId" type="tns:dateTime"/>
                <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="invitationListModifiedOn" type="xs:dateTime"/>
                <xs:element name="isFromInclusionRule" type="xs:boolean"/>
                <xs:element minOccurs="0" name="journalEntryType" type="tns:journalEntryType"/>
                <xs:element minOccurs="0" name="location" type="tns:location"/>
                <xs:element minOccurs="0"
                    name="occurrenceExceptionToSeries" type="tns:exceptionToSeries"/>
                <xs:element minOccurs="0" name="organizer" type="tns:participant"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="participants" nillable="true" type="tns:occurrenceParticipant"/>
                <xs:element minOccurs="0" name="priority" type="tns:priority"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="publishedBonds" nillable="true" type="tns:bond"/>
                <xs:element minOccurs="0" name="receptionChannel" type="tns:participantDeliveryChannel"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="reminders" type="tns:reminder"/>
                <xs:element minOccurs="0" ref="tns:sensitivity"/>
                <xs:element minOccurs="0" name="series" type="tns:occurrenceSeries"/>
                <xs:element name="size" type="xs:long"/>
                <xs:element minOccurs="0" name="start" type="tns:dateTime"/>
                <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 occurrence

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions