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

Contents

Overview

This type represents a resource contact.

Members

Name Type Required Description

addresses

entityAddress[]

Addresses of the AddressesBookElement.

alias

string

Alias of the element. Note that this is distinct from the name or nickname of the element.

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

Attachments to the AddressBookElement.

autoCreated

boolean

Checks if this element has been created automatically. When a user/group/resource is added to a team workspace, a bookmarked contact is automatically created in the default team workspace address book. The type of contact created depends on the entity added to the workspace i.e. PersonContact for OrganizationUser, GroupContact for Group, ResourceContact for Resource. The automatically created contacts are read-only.

bonds

bond[]

List of artifact bonds

bookingInfo

string

bookmark

anyType

(constrained to Resource)

Bookmark to the entry in the directory.

buddyListEntry

boolean

Checks if this element is also included in the owner's buddy list.

capacity

int

Capacity to the entry in the directory.

changeStatus

changeStatus

The change status of the artifact

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

Description of the Resource contact.

favorite

anyType

(constrained to Favorite)

BuddyList if the contact is marked as BuddyList entry or PeopleList if the contact is marked as PeopleList entry

groupContacts

groupContact[]

GroupContacts to which the AddressBookElement directly belongs.

location

string

Location of the Resource.

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.

peopleListEntry

boolean

Checks if this element is also included in the owner's people list.

primaryAddress

entityAddress

Primary Address of the AddressBookElement.

priority

priority

Priority of the element for the current user.

properties

collabProperties

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

resourceName

string

Resource name of this ResourceContact. The resource name is distinct from the name as in entity which is used as the display name.

resourceType

resourceType

sensitivity

sensitivity

Sensitivity assigned to the element

size

long

Size of the AddressBookElement.

snapshotId

string

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

speedDial

int

Speed dial number of the element for the current user. The speed dial may be set to null.

staticLocation

location

see resourceContact

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:resourceContact xsi:type="obh:resourceContact" 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:alias>your_string_0</obh:alias>
        <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:autoCreated>your_boolean_0</obh:autoCreated>
        <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:bookmark>your_anyType_0</obh:bookmark>
        <obh:buddyListEntry>your_boolean_0</obh:buddyListEntry>
        <obh:capacity>your_int_0</obh:capacity>
        <obh:changeStatus>your_changeStatus_0</obh:changeStatus>
        <obh:collabId>your_beeId_0</obh:collabId>
        <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:favorite>your_anyType_0</obh:favorite>
        <obh:groupContacts>your_groupContact_0</obh:groupContacts>
        <obh:groupContacts>your_groupContact_1</obh:groupContacts>
        <obh:groupContacts>your_groupContact_2</obh:groupContacts>
        <obh:location>your_string_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:parent>your_entity_0</obh:parent>
        <obh:peopleListEntry>your_boolean_0</obh:peopleListEntry>
        <obh:primaryAddress>your_entityAddress_0</obh:primaryAddress>
        <obh:priority>your_priority_0</obh:priority>
        <obh:properties>your_collabProperties_0</obh:properties>
        <obh:resourceName>your_string_0</obh:resourceName>
        <obh:resourceType>your_resourceType_0</obh:resourceType>
        <obh:sensitivity>your_sensitivity_0</obh:sensitivity>
        <obh:size>your_long_0</obh:size>
        <obh:snapshotId>your_string_0</obh:snapshotId>
        <obh:speedDial>your_int_0</obh:speedDial>
        <obh:staticLocation>your_location_0</obh:staticLocation>
        <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:resourceContact>

JSON Example

(show inherited members)

{
    "beeType":"resourceContact",
        "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 }
        ],
        "alias":"your_{http://www.oracle.com/beehive}alias_as_string0",
        "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"
        ],
        "autoCreated":your_{http://www.oracle.com/beehive}autoCreated_as_boolean0,
        "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",
        "bookmark":"your_{http://www.oracle.com/beehive}bookmark_as_anyType0",
        "buddyListEntry":your_{http://www.oracle.com/beehive}buddyListEntry_as_boolean0,
        "capacity":your_{http://www.oracle.com/beehive}capacity_as_int0,
        "changeStatus":{ your_{http://www.oracle.com/beehive}changeStatus_as_changeStatus0 },
        "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 },
        "deleted":your_{http://www.oracle.com/beehive}deleted_as_boolean0,
        "description":"your_{http://www.oracle.com/beehive}description_as_string0",
        "favorite":"your_{http://www.oracle.com/beehive}favorite_as_anyType0",
        "groupContacts":[
            { your_{http://www.oracle.com/beehive}groupContacts_as_groupContact0 },
            { your_{http://www.oracle.com/beehive}groupContacts_as_groupContact1 },
            { your_{http://www.oracle.com/beehive}groupContacts_as_groupContact2 }
        ],
        "location":"your_{http://www.oracle.com/beehive}location_as_string0",
        "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 },
        "peopleListEntry":your_{http://www.oracle.com/beehive}peopleListEntry_as_boolean0,
        "primaryAddress":{ your_{http://www.oracle.com/beehive}primaryAddress_as_entityAddress0 },
        "priority":{ your_{http://www.oracle.com/beehive}priority_as_priority0 },
        "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
        "resourceName":"your_{http://www.oracle.com/beehive}resourceName_as_string0",
        "resourceType":{ your_{http://www.oracle.com/beehive}resourceType_as_resourceType0 },
        "sensitivity":{ your_{http://www.oracle.com/beehive}sensitivity_as_sensitivity0 },
        "size":your_{http://www.oracle.com/beehive}size_as_long0,
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
        "speedDial":your_{http://www.oracle.com/beehive}speedDial_as_int0,
        "staticLocation":{ your_{http://www.oracle.com/beehive}staticLocation_as_location0 },
        "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="resourceContact">
    <xs:complexContent>
        <xs:extension base="tns:addressBookElement">
            <xs:sequence>
                <xs:element minOccurs="0" name="bookingInfo" type="xs:string"/>
                <xs:element minOccurs="0" name="bookmark" type="xs:anyType"/>
                <xs:element minOccurs="0" name="capacity" type="xs:int"/>
                <xs:element minOccurs="0" name="description" type="xs:string"/>
                <xs:element minOccurs="0" name="location" type="xs:string"/>
                <xs:element minOccurs="0" name="resourceName" type="xs:string"/>
                <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 resourceContact

Referenced By Resources

Usage Resource Method
Request ResourceContact Move Batch to Trash
Response ResourceContact Read
Response ResourceContact Read Batch
Request ResourceContact Read Batch
Response ResourceContact Update

Referenced By Representaions

Not Referenced Directly by Representations