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

Overview

Members

Show inherited members

Name	Type	Required	Description
addresses	entityAddress[]		Addresses of the AddressesBookElement.
agents	agent[]		Members of this GroupContact. These members are present in the directory only. The members are of type Agent.
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	group		Bookmark to the group 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
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.
elements	addressBookElement[]		Members of this GroupContact. These members are present in the address book. The members are of type AddressBookElement.
externalMembers	externalContact[]		Members of this GroupContact. These are members which are not present in the directory or the AddressBook. The members are of type ExternalContact.
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.
groupName	string		Group name of this GroupContact The group name is distinct from the name as in entity which is used as the display name.
memberDisplayedInPeopleList	boolean		Checks if the members of the GroupContact should be displayed in PeopleList when the GroupContact is a PeopleList. While adding a GroupContact to the PeopleList, the user may choose to see the members of the GroupContact in the PeopleList. This flag is used for this purpose. Note that the service does not mark the elements of the GroupContact as PeoplList entries. If the flag is set to true, the onus is on the CSI caller to display the members of the GroupContact in the PeopleList.
members	accessor[]		Members of this GroupContact. These members are present in the directory only. The members are of type OrganizationUser, Group, Dynamic Group.
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
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.
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

Examples

XML Example

(show inherited members)

JSON Example

(show inherited members)

XML Schema

<xs:complexType name="groupContact">
    <xs:complexContent>
        <xs:extension base="tns:addressBookElement">
            <xs:sequence>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="agents" nillable="true" type="tns:agent"/>
                <xs:element minOccurs="0" name="bookmark" type="tns:group"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="elements" nillable="true" type="tns:addressBookElement"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="externalMembers" nillable="true" type="tns:externalContact"/>
                <xs:element minOccurs="0" name="groupName" type="xs:string"/>
                <xs:element name="memberDisplayedInPeopleList" type="xs:boolean"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="members" nillable="true" type="tns:accessor"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

Referenced By Resources

Referenced By Representaions

• addressBookElement

Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices