Overview

Snapshot of a physical resource in the system.

A user can include a BookableResource in a calendar event.
By doing so, the resource will be marked as reserved for the timeslot.
A meeting within the resource calendar is typically initiated by a user.

The fields that can be returned with the various projections are:

For EMPTY projection

  • Handle
For BASIC projection, all attributes from EMPTY plus
  • Name (from Entity projection)
  • Identifier
  • Description
  • Type
  • Capacity
  • BookingInfo
  • StaticLocation
For FULL projection, all attributes are returned

The above list represents a subset of all attributes available in a BookableResource. Other attributes will be included in the snapshot according to the definition of the projection for the parent classes.

Members

Show inherited members

Projections
Name Type Required Description

activePreferenceProfile

preferenceProfile

Active preference profile of the accessor.

addresses

entityAddress[]

Addresses of the accessor.

approvers

organizationUser[]

The Approvers of the BookableResource

assignedRoles

assignedRole[]

Roles assigned to this base accessor.

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

availablePreferenceProfiles

preferenceProfile[]

All the available preference profiles for this accessor.

bonds

bond[]

Bonds for this base accessor.

bookingBehavior

bookingBehavior

Get the Resource default calendar booking behavior(FCFS/OPEN).

bookingInfo

string

The BookingInfo of the InternalResource

capacity

int

The capacity of the InternalResource

classification

string

The Classification of the InternalResource

classificationChanged

string

The ClassificationChanged of the InternalResource

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

The Description of the InternalResource

effectiveGroups

group[]

Groups that this base accessor is a member of, directly or indirectly (via sub-grouping).

groups

group[]

Groups that this base accessor is a direct member of.

identifier

string

Get the Resource Identifier, a user supplied identifier for the resource.

This is often used to hold a room identifier or a laptop serial number for example.

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.

primaryAddress

entityAddress

Primary address of the accessor.

principals

principal[]

Principals of this actor.

properties

collabProperties

Properties for this accessor.

resourceType

resourceType

The ResourceType of the InternalResource

resourceWorkspace

workspace

Get the Bookable Resource workspace Please note the generic workspace returned. One must check the instanceof and typecast it to the appropriate non abstract class.

snapshotId

string

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

staticLocation

location

The StaticLocation of the InternalResource

status

provisioningStatus

Provisioning status of this actor.

Hierarchy

Inherits From

Examples

Below are examples in 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:bookableResource xsi:type="obh:bookableResource" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <activePreferenceProfile>your_preferenceProfile_0</activePreferenceProfile>
        <addresses>your_entityAddress_0</addresses>
        <addresses>your_entityAddress_1</addresses>
        <addresses>your_entityAddress_2</addresses>
        <approvers>your_organizationUser_0</approvers>
        <approvers>your_organizationUser_1</approvers>
        <approvers>your_organizationUser_2</approvers>
        <assignedRoles>your_assignedRole_0</assignedRoles>
        <assignedRoles>your_assignedRole_1</assignedRoles>
        <assignedRoles>your_assignedRole_2</assignedRoles>
        <attachedMarkers>your_marker_0</attachedMarkers>
        <attachedMarkers>your_marker_1</attachedMarkers>
        <attachedMarkers>your_marker_2</attachedMarkers>
        <attachedReminders>your_reminder_0</attachedReminders>
        <attachedReminders>your_reminder_1</attachedReminders>
        <attachedReminders>your_reminder_2</attachedReminders>
        <attachedSubscriptions>your_subscription_0</attachedSubscriptions>
        <attachedSubscriptions>your_subscription_1</attachedSubscriptions>
        <attachedSubscriptions>your_subscription_2</attachedSubscriptions>
        <availablePreferenceProfiles>your_preferenceProfile_0</availablePreferenceProfiles>
        <availablePreferenceProfiles>your_preferenceProfile_1</availablePreferenceProfiles>
        <availablePreferenceProfiles>your_preferenceProfile_2</availablePreferenceProfiles>
        <bonds>your_bond_0</bonds>
        <bonds>your_bond_1</bonds>
        <bonds>your_bond_2</bonds>
        <bookingBehavior>your_bookingBehavior_0</bookingBehavior>
        <bookingInfo>your_string_0</bookingInfo>
        <capacity>your_int_0</capacity>
        <classification>your_string_0</classification>
        <classificationChanged>your_string_0</classificationChanged>
        <collabId>your_beeId_0</collabId>
        <createdOn>your_dateTime_0</createdOn>
        <creator>your_actor_0</creator>
        <deleted>your_boolean_0</deleted>
        <description>your_string_0</description>
        <effectiveGroups>your_group_0</effectiveGroups>
        <effectiveGroups>your_group_1</effectiveGroups>
        <effectiveGroups>your_group_2</effectiveGroups>
        <groups>your_group_0</groups>
        <groups>your_group_1</groups>
        <groups>your_group_2</groups>
        <identifier>your_string_0</identifier>
        <modifiedBy>your_actor_0</modifiedBy>
        <modifiedOn>your_dateTime_0</modifiedOn>
        <name>your_string_0</name>
        <parent>your_entity_0</parent>
        <primaryAddress>your_entityAddress_0</primaryAddress>
        <principals>your_principal_0</principals>
        <principals>your_principal_1</principals>
        <principals>your_principal_2</principals>
        <properties>your_collabProperties_0</properties>
        <resourceType>your_resourceType_0</resourceType>
        <resourceWorkspace>your_workspace_0</resourceWorkspace>
        <snapshotId>your_string_0</snapshotId>
        <staticLocation>your_location_0</staticLocation>
        <status>your_provisioningStatus_0</status>
</obh:bookableResource>

Referenced By Representaions

Not Referenced Directly by Representations