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

Contents

Overview

This type represents a person 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

bookmark

anyType

(constrained to Person)

Bookmark to the entry in the directory.

buddyListEntry

boolean

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

changeStatus

changeStatus

The change status of the artifact

collabId

beeId

CollabId of the snapshot

company

string

Company of the entry in the directory that is the PersonContact.

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.

department

string

Department of the entry in the directory that is the PersonContact.

familyName

string

Family name of the entry in the directory that is the PersonContact.

familyNames

lString

favorite

anyType

(constrained to Favorite)

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

givenName

string

Given name of the entry in the directory that is the PersonContact.

givenNames

lString

groupContacts

groupContact[]

GroupContacts to which the AddressBookElement directly belongs.

jobTitle

string

Job title of the entry in the directory that is the PersonContact.

jobTitles

lString

locale

string

middleName

string

Middle name of the entry in the directory that is the PersonContact.

middleNames

lString

modifiedBy

actor

The actor that last modified the entity

modifiedOn

dateTime

The date when entity was last modified

name

string

Name of the entity.

names

lString

nickname

string

Nickname of the entry in the directory that is the PersonContact.

nicknames

lString

officeLocation

string

Office location of the entry in the directory that is the PersonContact.

parent

entity

The parent for this entity.

peopleListEntry

boolean

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

prefix

string

Prefix of the entry in the directory that is the PersonContact.

prefixes

lString

primaryAddress

entityAddress

Primary Address of the AddressBookElement.

priority

priority

Priority of the element for the current user.

profession

string

Profession of the entry in the directory that is the PersonContact.

properties

collabProperties

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

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.

suffix

string

Suffix of the entry in the directory that is the PersonContact.

suffixes

lString

timeZone

timeZone

Time zone of the entry in the directory that is the PersonContact.

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:personContact xsi:type="obh:personContact" 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:bookmark>your_anyType_0</obh:bookmark>
        <obh:buddyListEntry>your_boolean_0</obh:buddyListEntry>
        <obh:changeStatus>your_changeStatus_0</obh:changeStatus>
        <obh:collabId>your_beeId_0</obh:collabId>
        <obh:company>your_string_0</obh:company>
        <obh:createdOn>your_dateTime_0</obh:createdOn>
        <obh:creator>your_actor_0</obh:creator>
        <obh:deleted>your_boolean_0</obh:deleted>
        <obh:department>your_string_0</obh:department>
        <obh:familyName>your_string_0</obh:familyName>
        <obh:familyNames>your_lString_0</obh:familyNames>
        <obh:favorite>your_anyType_0</obh:favorite>
        <obh:givenName>your_string_0</obh:givenName>
        <obh:givenNames>your_lString_0</obh:givenNames>
        <obh:groupContacts>your_groupContact_0</obh:groupContacts>
        <obh:groupContacts>your_groupContact_1</obh:groupContacts>
        <obh:groupContacts>your_groupContact_2</obh:groupContacts>
        <obh:jobTitle>your_string_0</obh:jobTitle>
        <obh:jobTitles>your_lString_0</obh:jobTitles>
        <obh:locale>your_string_0</obh:locale>
        <obh:middleName>your_string_0</obh:middleName>
        <obh:middleNames>your_lString_0</obh:middleNames>
        <obh:modifiedBy>your_actor_0</obh:modifiedBy>
        <obh:modifiedOn>your_dateTime_0</obh:modifiedOn>
        <obh:name>your_string_0</obh:name>
        <obh:names>your_lString_0</obh:names>
        <obh:nickname>your_string_0</obh:nickname>
        <obh:nicknames>your_lString_0</obh:nicknames>
        <obh:officeLocation>your_string_0</obh:officeLocation>
        <obh:parent>your_entity_0</obh:parent>
        <obh:peopleListEntry>your_boolean_0</obh:peopleListEntry>
        <obh:prefix>your_string_0</obh:prefix>
        <obh:prefixes>your_lString_0</obh:prefixes>
        <obh:primaryAddress>your_entityAddress_0</obh:primaryAddress>
        <obh:priority>your_priority_0</obh:priority>
        <obh:profession>your_string_0</obh:profession>
        <obh:properties>your_collabProperties_0</obh:properties>
        <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:suffix>your_string_0</obh:suffix>
        <obh:suffixes>your_lString_0</obh:suffixes>
        <obh:timeZone>your_timeZone_0</obh:timeZone>
        <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:personContact>

JSON Example

(show inherited members)

{
    "beeType":"personContact",
        "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 }
        ],
        "bookmark":"your_{http://www.oracle.com/beehive}bookmark_as_anyType0",
        "buddyListEntry":your_{http://www.oracle.com/beehive}buddyListEntry_as_boolean0,
        "changeStatus":{ your_{http://www.oracle.com/beehive}changeStatus_as_changeStatus0 },
        "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
        "company":"your_{http://www.oracle.com/beehive}company_as_string0",
        "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,
        "department":"your_{http://www.oracle.com/beehive}department_as_string0",
        "familyName":"your_{http://www.oracle.com/beehive}familyName_as_string0",
        "familyNames":{ your_{http://www.oracle.com/beehive}familyNames_as_lString0 },
        "favorite":"your_{http://www.oracle.com/beehive}favorite_as_anyType0",
        "givenName":"your_{http://www.oracle.com/beehive}givenName_as_string0",
        "givenNames":{ your_{http://www.oracle.com/beehive}givenNames_as_lString0 },
        "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 }
        ],
        "jobTitle":"your_{http://www.oracle.com/beehive}jobTitle_as_string0",
        "jobTitles":{ your_{http://www.oracle.com/beehive}jobTitles_as_lString0 },
        "locale":"your_{http://www.oracle.com/beehive}locale_as_string0",
        "middleName":"your_{http://www.oracle.com/beehive}middleName_as_string0",
        "middleNames":{ your_{http://www.oracle.com/beehive}middleNames_as_lString0 },
        "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",
        "names":{ your_{http://www.oracle.com/beehive}names_as_lString0 },
        "nickname":"your_{http://www.oracle.com/beehive}nickname_as_string0",
        "nicknames":{ your_{http://www.oracle.com/beehive}nicknames_as_lString0 },
        "officeLocation":"your_{http://www.oracle.com/beehive}officeLocation_as_string0",
        "parent":{ your_{http://www.oracle.com/beehive}parent_as_entity0 },
        "peopleListEntry":your_{http://www.oracle.com/beehive}peopleListEntry_as_boolean0,
        "prefix":"your_{http://www.oracle.com/beehive}prefix_as_string0",
        "prefixes":{ your_{http://www.oracle.com/beehive}prefixes_as_lString0 },
        "primaryAddress":{ your_{http://www.oracle.com/beehive}primaryAddress_as_entityAddress0 },
        "priority":{ your_{http://www.oracle.com/beehive}priority_as_priority0 },
        "profession":"your_{http://www.oracle.com/beehive}profession_as_string0",
        "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
        "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,
        "suffix":"your_{http://www.oracle.com/beehive}suffix_as_string0",
        "suffixes":{ your_{http://www.oracle.com/beehive}suffixes_as_lString0 },
        "timeZone":{ your_{http://www.oracle.com/beehive}timeZone_as_timeZone0 },
        "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="personContact">
    <xs:complexContent>
        <xs:extension base="tns:addressBookElement">
            <xs:sequence>
                <xs:element minOccurs="0" name="bookmark" type="xs:anyType"/>
                <xs:element minOccurs="0" name="company" type="xs:string"/>
                <xs:element minOccurs="0" name="department" type="xs:string"/>
                <xs:element minOccurs="0" name="familyName" type="xs:string"/>
                <xs:element minOccurs="0" name="familyNames" type="tns:lString"/>
                <xs:element minOccurs="0" name="givenName" type="xs:string"/>
                <xs:element minOccurs="0" name="givenNames" type="tns:lString"/>
                <xs:element minOccurs="0" name="jobTitle" type="xs:string"/>
                <xs:element minOccurs="0" name="jobTitles" type="tns:lString"/>
                <xs:element minOccurs="0" name="locale" type="xs:string"/>
                <xs:element minOccurs="0" name="middleName" type="xs:string"/>
                <xs:element minOccurs="0" name="middleNames" type="tns:lString"/>
                <xs:element minOccurs="0" name="names" type="tns:lString"/>
                <xs:element minOccurs="0" name="nickname" type="xs:string"/>
                <xs:element minOccurs="0" name="nicknames" type="tns:lString"/>
                <xs:element minOccurs="0" name="officeLocation" type="xs:string"/>
                <xs:element minOccurs="0" name="prefix" type="xs:string"/>
                <xs:element minOccurs="0" name="prefixes" type="tns:lString"/>
                <xs:element minOccurs="0" name="profession" type="xs:string"/>
                <xs:element minOccurs="0" name="suffix" type="xs:string"/>
                <xs:element minOccurs="0" name="suffixes" type="tns:lString"/>
                <xs:element minOccurs="0" name="timeZone" type="tns:timeZone"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to personContact

Referenced By Resources

Usage Resource Method
Response PersonContact Copy
Response PersonContact Copy Batch
Request PersonContact Copy Batch
Response PersonContact Create
Request PersonContact Delete Batch
Response PersonContact List
Request PersonContact Move Batch
Request PersonContact Move Batch to Trash
Response PersonContact Read
Response PersonContact Read Batch
Request PersonContact Read Batch
Request PersonContact Undelete Batch
Response PersonContact Update
Response ResourceContact Create

Referenced By Representaions

Not Referenced Directly by Representations