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

Contents

Overview

Describes a connection request made as part of a brokered search for relationships by a user.

Members

Name Type Required Description

acceptedUsers

actor[]

Users that have accepted the request

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

collaborationChannel

connectionRequestCollaborationChannel

Collaboration option (direct/discussion forum)

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.

maxRequestsToBeSent

int

Maximum number of experts that may be contacted

modifiedBy

actor

The actor that last modified the entity

modifiedOn

dateTime

The date when entity was last modified

name

string

Name of the entity.

needResponseBy

dateTime

Date by which responses are needed

parent

entity

The parent for this entity.

priority

priority

Priority of the request

requestMessageBody

string

Message body

requestMessageSubject

string

Message subject

requestState

connectionRequestState

Current state of the request (open/closed/expired)

resolutionStatus

connectionRequestResolutionStatus

Resolution status of the request

responseState

connectionRequestResponseState

Response state (accepted/ignored/declined/pending) as seen by the calling user

searchInfo

relationshipSearchInfo

Details about the relationship search associated with the request

snapshotId

string

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

targets

expertiseTarget[]

Expertise targets behind the request as seen by the calling user

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:relationshipConnectionRequest xsi:type="obh:relationshipConnectionRequest" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:acceptedUsers>your_actor_0</obh:acceptedUsers>
        <obh:acceptedUsers>your_actor_1</obh:acceptedUsers>
        <obh:acceptedUsers>your_actor_2</obh:acceptedUsers>
        <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:collabId>your_beeId_0</obh:collabId>
        <obh:collaborationChannel>your_connectionRequestCollaborationChannel_0</obh:collaborationChannel>
        <obh:createdOn>your_dateTime_0</obh:createdOn>
        <obh:creator>your_actor_0</obh:creator>
        <obh:deleted>your_boolean_0</obh:deleted>
        <obh:maxRequestsToBeSent>your_int_0</obh:maxRequestsToBeSent>
        <obh:modifiedBy>your_actor_0</obh:modifiedBy>
        <obh:modifiedOn>your_dateTime_0</obh:modifiedOn>
        <obh:name>your_string_0</obh:name>
        <obh:needResponseBy>your_dateTime_0</obh:needResponseBy>
        <obh:parent>your_entity_0</obh:parent>
        <obh:priority>your_priority_0</obh:priority>
        <obh:requestMessageBody>your_string_0</obh:requestMessageBody>
        <obh:requestMessageSubject>your_string_0</obh:requestMessageSubject>
        <obh:requestState>your_connectionRequestState_0</obh:requestState>
        <obh:resolutionStatus>your_connectionRequestResolutionStatus_0</obh:resolutionStatus>
        <obh:responseState>your_connectionRequestResponseState_0</obh:responseState>
        <obh:searchInfo>your_relationshipSearchInfo_0</obh:searchInfo>
        <obh:snapshotId>your_string_0</obh:snapshotId>
        <obh:targets>your_expertiseTarget_0</obh:targets>
        <obh:targets>your_expertiseTarget_1</obh:targets>
        <obh:targets>your_expertiseTarget_2</obh:targets>
</obh:relationshipConnectionRequest>

JSON Example

(show inherited members)

{
    "beeType":"relationshipConnectionRequest",
        "acceptedUsers":[
            { your_{http://www.oracle.com/beehive}acceptedUsers_as_actor0 },
            { your_{http://www.oracle.com/beehive}acceptedUsers_as_actor1 },
            { your_{http://www.oracle.com/beehive}acceptedUsers_as_actor2 }
        ],
        "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 },
        "collaborationChannel":{ your_{http://www.oracle.com/beehive}collaborationChannel_as_connectionRequestCollaborationChannel0 },
        "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,
        "maxRequestsToBeSent":your_{http://www.oracle.com/beehive}maxRequestsToBeSent_as_int0,
        "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",
        "needResponseBy":"your_{http://www.oracle.com/beehive}needResponseBy_as_dateTime0",
        "parent":{ your_{http://www.oracle.com/beehive}parent_as_entity0 },
        "priority":{ your_{http://www.oracle.com/beehive}priority_as_priority0 },
        "requestMessageBody":"your_{http://www.oracle.com/beehive}requestMessageBody_as_string0",
        "requestMessageSubject":"your_{http://www.oracle.com/beehive}requestMessageSubject_as_string0",
        "requestState":{ your_{http://www.oracle.com/beehive}requestState_as_connectionRequestState0 },
        "resolutionStatus":{ your_{http://www.oracle.com/beehive}resolutionStatus_as_connectionRequestResolutionStatus0 },
        "responseState":{ your_{http://www.oracle.com/beehive}responseState_as_connectionRequestResponseState0 },
        "searchInfo":{ your_{http://www.oracle.com/beehive}searchInfo_as_relationshipSearchInfo0 },
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
        "targets":[
            { your_{http://www.oracle.com/beehive}targets_as_expertiseTarget0 },
            { your_{http://www.oracle.com/beehive}targets_as_expertiseTarget1 },
            { your_{http://www.oracle.com/beehive}targets_as_expertiseTarget2 }
        ]
}

XML Schema


<xs:complexType name="relationshipConnectionRequest">
    <xs:complexContent>
        <xs:extension base="tns:connectionRequest">
            <xs:sequence>
                <xs:element minOccurs="0" name="searchInfo" type="tns:relationshipSearchInfo"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="targets" nillable="true" type="tns:expertiseTarget"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to relationshipConnectionRequest

Referenced By Resources

Usage Resource Method
Response RelationshipConnection Create

Referenced By Representaions

Not Referenced Directly by Representations