A script enabled browser is required for this page to function properly
Oracle® Beehive RESTful Web Services API Reference Release 2 (2.0.1.7)
Overview
Entity is a snapshot of a server-side entity instance. It is an immutable
object associated with an entity instance which has some of its attributes
materialized during a load operation. The set of loaded attributes depends on
the projection used in load operation. Entities are created using a creator
object of the corresponding type and entity attributes are updated using the
corresponding updater object.
From an object model point of view, an entity is a tuple with a globally
unique entity ID and an optional name. An entity's name is mutable. Virtually
all manipulable objects are entities. Access to every entity is controlled
through access control rules. Basically, each entity can define one or more
operations that can be performed on it and for each operation specify one or
more privileges that the requesting actor must carry in order to be allowed
to perform the operation. Note that we allow owner to be either a single
actor, or a group. The actor that made the entity come into existence is the
creator of the entity and this value cannot be changed.
Each entity can have zero or more labels associated with it.
Members
Projections
BASIC
EMPTY
FULL
META
Name
Type
Required
Description
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
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.
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.
snapshotId
string
Contains the snapshot identifier for this snapshot. Snapshot identifiers
are used to implement optimistic locking on the server.
Hierarchy
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:entity xsi:type="obh:entity" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<obh:attachedMarkers>your_marker_0 your_marker_1 your_marker_2
<obh:attachedReminders>your_reminder_0 your_reminder_1 your_reminder_2
<obh:attachedSubscriptions>your_subscription_0 your_subscription_1 your_subscription_2
<obh:collabId>your_beeId_0
<obh:createdOn>your_dateTime_0 </obh:createdOn>
<obh:creator>your_actor_0
<obh:deleted>your_boolean_0 </obh:deleted>
<obh:modifiedBy>your_actor_0
<obh:modifiedOn>your_dateTime_0 </obh:modifiedOn>
<obh:name>your_string_0 </obh:name>
<obh:parent>your_entity_0
<obh:snapshotId>your_string_0 </obh:snapshotId>
</obh:entity>
JSON Example
(show inherited members)
{
"beeType":"entity",
"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
"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,
"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
"snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0"
}
XML Schema
<xs:complexType name="entity">
<xs:complexContent>
<xs:extension base="tns:identifiableSnapshot">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0"
name="attachedMarkers" type="tns:marker"/>
<xs:element maxOccurs="unbounded" minOccurs="0"
name="attachedReminders" nillable="true" type="tns:reminder"/>
<xs:element maxOccurs="unbounded" minOccurs="0"
name="attachedSubscriptions" nillable="true" type="tns:subscription"/>
<xs:element minOccurs="0" name="createdOn" type="xs:dateTime"/>
<xs:element minOccurs="0" name="creator" type="tns:actor"/>
<xs:element name="deleted" type="xs:boolean"/>
<xs:element minOccurs="0" name="modifiedBy" type="tns:actor"/>
<xs:element minOccurs="0" name="modifiedOn" type="xs:dateTime"/>
<xs:element minOccurs="0" name="name" type="xs:string"/>
<xs:element minOccurs="0" name="parent" type="tns:entity"/>
<xs:element minOccurs="0" name="snapshotId" type="xs:string"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
References
The following data represents the references to entity
Referenced By Resources
Referenced By Representaions
Legal Notices
