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 expertise by a user. A brokered search can be initiated by passing one or more ExpertiseTopics or a search expression.

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.

expertiseTopicTitles

string[]

Titles of the ExpertiseTopics associated with the request

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

responseDiscussionForum

forum

Discussion forum for the request when the collaboration option is a Discussion Forum.

responseDiscussionTopic

topic

Discussion topic for the request when the collaboration option is a Discussion Forum.

responseState

connectionRequestResponseState

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

searchExpression

string

Search expression used to build the request when it is NOT a topic based request

snapshotId

string

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

terms

expertiseTerm[]

Terms matching the search expression used to create the request belonging to the calling user

topicBased

boolean

Flag to indicate if the request is driven by one or more topics or a search expression

topics

expertiseDynamicTopic[]

ExpertiseTopics used to build the request when it is a topic based request. ExpertiseTopics returned will contain terms belonging to 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:expertiseConnectionRequest xsi:type="obh:expertiseConnectionRequest" 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:expertiseTopicTitles>your_string_0</obh:expertiseTopicTitles>
        <obh:expertiseTopicTitles>your_string_1</obh:expertiseTopicTitles>
        <obh:expertiseTopicTitles>your_string_2</obh:expertiseTopicTitles>
        <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:responseDiscussionForum>your_forum_0</obh:responseDiscussionForum>
        <obh:responseDiscussionTopic>your_topic_0</obh:responseDiscussionTopic>
        <obh:responseState>your_connectionRequestResponseState_0</obh:responseState>
        <obh:searchExpression>your_string_0</obh:searchExpression>
        <obh:snapshotId>your_string_0</obh:snapshotId>
        <obh:terms>your_expertiseTerm_0</obh:terms>
        <obh:terms>your_expertiseTerm_1</obh:terms>
        <obh:terms>your_expertiseTerm_2</obh:terms>
        <obh:topicBased>your_boolean_0</obh:topicBased>
        <obh:topics>your_expertiseDynamicTopic_0</obh:topics>
        <obh:topics>your_expertiseDynamicTopic_1</obh:topics>
        <obh:topics>your_expertiseDynamicTopic_2</obh:topics>
</obh:expertiseConnectionRequest>

JSON Example

(show inherited members)

{
    "beeType":"expertiseConnectionRequest",
        "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,
        "expertiseTopicTitles":[
            "your_{http://www.oracle.com/beehive}expertiseTopicTitles_as_string0",
            "your_{http://www.oracle.com/beehive}expertiseTopicTitles_as_string1",
            "your_{http://www.oracle.com/beehive}expertiseTopicTitles_as_string2"
        ],
        "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 },
        "responseDiscussionForum":{ your_{http://www.oracle.com/beehive}responseDiscussionForum_as_forum0 },
        "responseDiscussionTopic":{ your_{http://www.oracle.com/beehive}responseDiscussionTopic_as_topic0 },
        "responseState":{ your_{http://www.oracle.com/beehive}responseState_as_connectionRequestResponseState0 },
        "searchExpression":"your_{http://www.oracle.com/beehive}searchExpression_as_string0",
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
        "terms":[
            { your_{http://www.oracle.com/beehive}terms_as_expertiseTerm0 },
            { your_{http://www.oracle.com/beehive}terms_as_expertiseTerm1 },
            { your_{http://www.oracle.com/beehive}terms_as_expertiseTerm2 }
        ],
        "topicBased":your_{http://www.oracle.com/beehive}topicBased_as_boolean0,
        "topics":[
            { your_{http://www.oracle.com/beehive}topics_as_expertiseDynamicTopic0 },
            { your_{http://www.oracle.com/beehive}topics_as_expertiseDynamicTopic1 },
            { your_{http://www.oracle.com/beehive}topics_as_expertiseDynamicTopic2 }
        ]
}

XML Schema


<xs:complexType name="expertiseConnectionRequest">
    <xs:complexContent>
        <xs:extension base="tns:connectionRequest">
            <xs:sequence>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="expertiseTopicTitles" nillable="true" type="xs:string"/>
                <xs:element minOccurs="0" name="responseDiscussionForum" type="tns:forum"/>
                <xs:element minOccurs="0" name="responseDiscussionTopic" type="tns:topic"/>
                <xs:element minOccurs="0" name="searchExpression" type="xs:string"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="terms" nillable="true" type="tns:expertiseTerm"/>
                <xs:element name="topicBased" type="xs:boolean"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="topics" nillable="true" type="tns:expertiseDynamicTopic"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to expertiseConnectionRequest

Referenced By Resources

Usage Resource Method
Response ExpertiseConnection Create

Referenced By Representaions

Not Referenced Directly by Representations