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

Contents

Overview

Snapshot of a resource outside the system.

An external resource is an agent outside the control of the system.
It does not interact with the system but can only exchange messages.
It can be used as a participant in meetings.
It serves as an address holder for contacting the external person representing the resource.
A external resource may have a stationary or non-stationary location, which in turn provides the time zone.
The external resources, for example the conference rooms in the Moscone Center, may participate in the OpenWorld events.
For such an external resource, Moscone Center will be a contact address.

An ExternalResource is an Agent, and is also a 'Resource'.

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

For EMPTY projection

For SECURITY projection, all attribute from EMPTY plus For BASIC projection, all attributes from EMPTY plus For FULL projection, all attributes from BASIC and SECURITY plus The above list represents a subset of all attributes available in an ExternalResource. Other attributes will be included in the snapshot according to the definition of the projection for the parent classes.

Members

Name Type Required Description

addresses

entityAddress[]

Addresses of this agent.

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

bonds

bond[]

Bonds.

bookingInfo

string

The BookingInfo of the ExternalResource

capacity

int

The Capacity of the ExternalResource

collabId

beeId

CollabId of the snapshot

createdOn

dateTime

Entity's creation date

creator

actor

The actor that created this entity

defaultAddressForScheme

entityAddress

The DefaultAddressForScheme of the ExternalResource

defaultAddressForType

entityAddress

The DefaultAddressForType of the ExternalResource

deleted

boolean

Deletion flag. If this property is set to true the entity is deleted.

description

string

The Description of the ExternalResource

effectiveGroups

group[]

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

groups

group[]

Groups that this entity is a direct member of.

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.

properties

collabProperties

The CollabProperties of the ExternalResource

resourceType

resourceType

The ResourceType of the ExternalResource

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 ExternalResource

status

provisioningStatus

Lifecycle status.

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:externalResource xsi:type="obh:externalResource" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:addresses>your_entityAddress_0</obh:addresses>
        <obh:addresses>your_entityAddress_1</obh:addresses>
        <obh:addresses>your_entityAddress_2</obh:addresses>
        <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:bonds>your_bond_0</obh:bonds>
        <obh:bonds>your_bond_1</obh:bonds>
        <obh:bonds>your_bond_2</obh:bonds>
        <obh:bookingInfo>your_string_0</obh:bookingInfo>
        <obh:capacity>your_int_0</obh:capacity>
        <obh:collabId>your_beeId_0</obh:collabId>
        <obh:createdOn>your_dateTime_0</obh:createdOn>
        <obh:creator>your_actor_0</obh:creator>
        <obh:defaultAddressForScheme>your_entityAddress_0</obh:defaultAddressForScheme>
        <obh:defaultAddressForType>your_entityAddress_0</obh:defaultAddressForType>
        <obh:deleted>your_boolean_0</obh:deleted>
        <obh:description>your_string_0</obh:description>
        <obh:effectiveGroups>your_group_0</obh:effectiveGroups>
        <obh:effectiveGroups>your_group_1</obh:effectiveGroups>
        <obh:effectiveGroups>your_group_2</obh:effectiveGroups>
        <obh:groups>your_group_0</obh:groups>
        <obh:groups>your_group_1</obh:groups>
        <obh:groups>your_group_2</obh:groups>
        <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:primaryAddress>your_entityAddress_0</obh:primaryAddress>
        <obh:properties>your_collabProperties_0</obh:properties>
        <obh:resourceType>your_resourceType_0</obh:resourceType>
        <obh:snapshotId>your_string_0</obh:snapshotId>
        <obh:staticLocation>your_location_0</obh:staticLocation>
        <obh:status>your_provisioningStatus_0</obh:status>
</obh:externalResource>

JSON Example

(show inherited members)

{
    "beeType":"externalResource",
        "addresses":[
            { your_{http://www.oracle.com/beehive}addresses_as_entityAddress0 },
            { your_{http://www.oracle.com/beehive}addresses_as_entityAddress1 },
            { your_{http://www.oracle.com/beehive}addresses_as_entityAddress2 }
        ],
        "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 }
        ],
        "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 }
        ],
        "bookingInfo":"your_{http://www.oracle.com/beehive}bookingInfo_as_string0",
        "capacity":your_{http://www.oracle.com/beehive}capacity_as_int0,
        "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 },
        "defaultAddressForScheme":{ your_{http://www.oracle.com/beehive}defaultAddressForScheme_as_entityAddress0 },
        "defaultAddressForType":{ your_{http://www.oracle.com/beehive}defaultAddressForType_as_entityAddress0 },
        "deleted":your_{http://www.oracle.com/beehive}deleted_as_boolean0,
        "description":"your_{http://www.oracle.com/beehive}description_as_string0",
        "effectiveGroups":[
            { your_{http://www.oracle.com/beehive}effectiveGroups_as_group0 },
            { your_{http://www.oracle.com/beehive}effectiveGroups_as_group1 },
            { your_{http://www.oracle.com/beehive}effectiveGroups_as_group2 }
        ],
        "groups":[
            { your_{http://www.oracle.com/beehive}groups_as_group0 },
            { your_{http://www.oracle.com/beehive}groups_as_group1 },
            { your_{http://www.oracle.com/beehive}groups_as_group2 }
        ],
        "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 },
        "primaryAddress":{ your_{http://www.oracle.com/beehive}primaryAddress_as_entityAddress0 },
        "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
        "resourceType":{ your_{http://www.oracle.com/beehive}resourceType_as_resourceType0 },
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
        "staticLocation":{ your_{http://www.oracle.com/beehive}staticLocation_as_location0 },
        "status":{ your_{http://www.oracle.com/beehive}status_as_provisioningStatus0 }
}

XML Schema


<xs:complexType name="externalResource">
    <xs:complexContent>
        <xs:extension base="tns:agent">
            <xs:sequence>
                <xs:element minOccurs="0" name="bookingInfo" type="xs:string"/>
                <xs:element minOccurs="0" name="capacity" type="xs:int"/>
                <xs:element minOccurs="0" name="defaultAddressForScheme" type="tns:entityAddress"/>
                <xs:element minOccurs="0" name="defaultAddressForType" type="tns:entityAddress"/>
                <xs:element minOccurs="0" name="description" type="xs:string"/>
                <xs:element minOccurs="0" name="properties" type="tns:collabProperties"/>
                <xs:element minOccurs="0" name="resourceType" type="tns:resourceType"/>
                <xs:element minOccurs="0" name="staticLocation" type="tns:location"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to externalResource

Referenced By Resources

Usage Resource Method
Response BookableResource Update

Referenced By Representaions

Not Referenced Directly by Representations