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

Beehive Development Kit » All Representations » bond
Contents

Overview

Relates two or more entities to each other. You may annotate any Bond with arbitrary data through the Properties attribute. The Root attribute defines a hierarchy where the entity attached as the root is assumed to be a relative root above the bond.

Members

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

bondType

bondType
Type of the bond.

bondedEntities

listResult
The entities bonded to this bond.

changeStatus

changeStatus
The change status of the Bond.

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 bond.

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.

properties

collabProperties
Custom properties of the bond.

root

anyType

(constrained to Bondable)
The root of the bond.

snapshotId

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

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:bond xsi:type="obh:bond" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <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:bondType>your_bondType_0</obh:bondType>
         <obh:bondedEntities>your_listResult_0</obh:bondedEntities>
         <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: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:properties>your_collabProperties_0</obh:properties>
         <obh:root>your_anyType_0</obh:root>
         <obh:snapshotId>your_string_0</obh:snapshotId>
 </obh:bond>

JSON Example

(show inherited members)

{
    "beeType":"bond",
        "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 }
        ],
         "bondType":{ your_{http://www.oracle.com/beehive}bondType_as_bondType0 },
         "bondedEntities":{ your_{http://www.oracle.com/beehive}bondedEntities_as_listResult0 },
         "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",
         "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 },
         "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
         "root":"your_{http://www.oracle.com/beehive}root_as_anyType0",
         "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0"
 }

XML Schema


<xs:complexType name="bond">
    <xs:complexContent>
        <xs:extension base="tns:entity">
            <xs:sequence>
                <xs:element minOccurs="0" name="bondType" type="tns:bondType"/>
                <xs:element minOccurs="0" name="bondedEntities" type="tns:listResult"/>
                <xs:element minOccurs="0" name="changeStatus" type="tns:changeStatus"/>
                <xs:element minOccurs="0" name="description" type="xs:string"/>
                <xs:element minOccurs="0" name="properties" type="tns:collabProperties"/>
                <xs:element minOccurs="0" name="root" type="xs:anyType"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

References

The following data represents the references to bond

Referenced By Resources

Usage Resource Method
Response Bond Create
Response Bond Read
Response Bond Read Batch
Request Bond Read Batch
Response Bond Update

Referenced By Representaions

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