Oracle® Beehive SOAP Web Services API Reference
Release 2 (22.214.171.124)
The Calendar category enables you to control Oracle Beehive's Time Management Services. These services support all aspects of time and task management, as well as user, team, and resource scheduling for Oracle Beehive.
A bookable resource is an entity that users can search for, reserve, and use for a specified period of time, such as a conference room or a projector.
A calendar is a container of time management artifacts. It exists as an entity of a team or personal workspace. Refer to the section "Workspace Templates" in the module "Oracle Beehive XML File Reference" in Oracle Beehive Administrator's Reference Guide to see the structure of a calendar in the context of a workspace.
An invitation is an object that is created for every calendar event. It is located in the participant's default calendar. These invitation objects are owned by the participant. The participant can update the status or act on the invitation.
Invitations and occurrences are both represented by the Meeting resource in the BDK. The invitee's meetings do not include a reference to the organizer's meeting.
Meetings reside in calendar objects. When the organizer creates a meeting that includes other participants, a copy of the meeting is created in each participant's default calendar. If the participant is a team workspace, then by default meetings are delivered to the default calendar of the enrollees (who are typically the workspace members). External participants are informed of the meeting with an e-mail notification that includes an iCalendar attachment that can be imported in their calendar application.
A reminder is an entity that is used to trigger a reminder action at some timed event. It associates a timed or relative trigger on the entity, which can set off an event. A timed trigger can be defined relative to the time of an operation, such as create, update, check-in, or checkout or to a scheduled event (usually a future event), such as the start time of an calendar occurrence, due date of a task, or end time of a conference. A timed trigger can also be defined by absolute time, independent of any operation. The relative triggers that the BDK supports are the start of a meeting, start of a atask, and the due time of a task.
An alert is a time-sensitive message to one or more users that typically requires the immediate attention of its recipients, sometimes in the form of actionable responses.
Refer to "Creating Oracle Beehive Bookable Resource Accounts" for more information.
The Calendar resource supports common calendar operations:
Use the Calendar resource in conjunction with the Meeting and MeetingSeries resources.
The Meeting resource represents both invitations and occurrences. If the member InvitationOnly is true, then the Meeting is an invitation.
Every user that is a participant of a scheduled meeting has a meeting artifact. The meeting organizer is responsible for creating the main meeting artifact. The invitees' copies of the meeting are automatically created by the system.
The organizer of the meeting may update all the common attributes in the main meeting artifact. For example, the organizer may change the title, reschedule the meeting, and add participants. These modifications are automatically propagated to each participant's copy of the meeting. The other participants cannot modify these attributes in their copy of the meeting. Only the attribute with the prefix Invitee may be updated by an invitee. The attribute InvitationOnly may be used to determine if the meeting artifact is the main copy of the meeting.
The Task resource represents both TODOs and assignments. If the member AssignmentOnly is true, then the Task is an invitation.
The task artifact represents a personal task, or a task being assigned to a participant.
The BDK does not allow you to assign a task to another participant; however, the BDK exposes task assignments created from calendar clients. If the attribute AssignmentOnly is true, then only the attribute with the prefix Assignee may be updated. If AssgnmentOnly is false, then this artifact represents the main artifact of the TODO and modifications to the common attributes are propagated to each of the assignees' copy of the task.
To be documented later
Both Meeting and Task contain a member named InviteePrimaryClientReminderTrigger of type TimedTrigger. The TimedTrigger is used to indicate at what time an reminder should be triggered.
The member InviteePrimaryClientReminderTrigger of the Meeting and Task resources indicates the trigger time of the reminder exposed in the calendar client such as Oracle Behive Extensions for Outlook and Mozilla Lightning.
Entities might have other secondary reminders such as default reminders that trigger a notification 10 minutes before every meeting. There reminder are accessible through the Reminder resource.
This section describes various notes and features of the Calendar category:
exceptionmember is false). When a particular meeting of a series is explicitly modified it becomes an exception to the series (the value of its
exceptionmember is set to true). Modifications to the MeetingSeries are be propagated to all associated meetings, including the exceptions, but will not change their exception status.
/listoperations, recurring meetings are always expended and the rule is not returned
exceptionmember to true.