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

Contents

Overview

Resource Announcement is a special type of topic that represents an important or time-sensitive Topic. It is often placed in a special Forum for Announcements only. By default, only Forum moderators are allowed to post Announcements. Announcements also differ from regular Topics in that Announcements have activation and expiration dates. Announcements that are not yet active are considered pending and are usually hidden from non-moderators. Announcements that are expired are usually either hidden from non-moderators or manually archived. Active, non-expired Announcements are usually visible to all Workspace members.

Members

Name Type Required Description

activatesOn

dateTime

The Date on which the Announcement activates

announcementStatus

announcementStatus

The status of the Announcement, which indicates whether the Announcement is active, pending or expired.

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

availableMarkers

marker[]

Set of available Markers.

bonds

bond[]

List of artifact bonds

changeStatus

changeStatus

The change status of the artifact

collabId

beeId

CollabId of the snapshot

correctAnswer

discussionsMessage

The Answer in the Topic with an AnswerStatus of Correct, if any such exist. If the Topic is not a Question or if it does not contain an Answer marked Correct, this returns null.

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

discussionsChangeStatus

changeStatus

The ChangeStatus of this Topic.

discussionsMessages

listResult

A list of the DiscussionsMessages in this Topic.

elementCount

int

The number of elements in the Folder.

elements

listResult

A list of the DiscussionsMessages in this Topic.

expiresOn

dateTime

The Date on which the Announcement expires

firstPost

discussionsMessage

The first DiscussionsMessage posted in this Topic.

lastPost

discussionsMessage

The last DiscussionsMessage posted in this Topic.

locks

lock[]

A list of Locks on this Topic.

messageCount

int

The number of DiscussionsMessages in this Topic.

modifiedBy

actor

The actor that last modified the entity

modifiedOn

dateTime

The date when entity was last modified

name

string

Name of the entity.

nextTopic

topic

The Topic in the Forum that is next after this when all Topics (excluding Announcements) in the Forum are listed by last post creation date descending (latest first). This is null if the Topic is the only Topic in the Forum or if it is the Topic in the Forum with the earliest last post creation date.

parent

entity

The parent for this entity.

policies

policy[]

Set of Policies.

previousTopic

topic

The Topic in the Forum that is previous after this when all Topics (excluding Announcements) in the Forum are listed by last post creation date descending (latest first). This is null if the Topic is the only Topic in the Forum or if it is the Topic in the Forum with the latest last post creation date.

properties

collabProperties

The properties of the artifact that are shared among all the actors

question

boolean

Whether or not the Topic is a Question.

questionStatus

topicQuestionStatus

The QuestionStatus of this Topic. This is a status derived from the AnswerStatuses of any Answers in this Topic. See TopicQuestionStatus for more details. If the Topic is not a Question, this returns null.

snapshotId

string

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

userCreatedOn

dateTime

The user creation date (if created offline)

userModifiedOn

dateTime

The user last modified date (if modified offline)

viewCount

int

The number of times this Topic has been viewed.

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

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:announcement xsi:type="obh:announcement" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:activatesOn>your_dateTime_0</obh:activatesOn>
        <obh:announcementStatus>your_announcementStatus_0</obh:announcementStatus>
        <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:availableMarkers>your_marker_0</obh:availableMarkers>
        <obh:availableMarkers>your_marker_1</obh:availableMarkers>
        <obh:availableMarkers>your_marker_2</obh:availableMarkers>
        <obh:bonds>your_bond_0</obh:bonds>
        <obh:bonds>your_bond_1</obh:bonds>
        <obh:bonds>your_bond_2</obh:bonds>
        <obh:changeStatus>your_changeStatus_0</obh:changeStatus>
        <obh:collabId>your_beeId_0</obh:collabId>
        <obh:correctAnswer>your_discussionsMessage_0</obh:correctAnswer>
        <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:discussionsChangeStatus>your_changeStatus_0</obh:discussionsChangeStatus>
        <obh:discussionsMessages>your_listResult_0</obh:discussionsMessages>
        <obh:elementCount>your_int_0</obh:elementCount>
        <obh:elements>your_listResult_0</obh:elements>
        <obh:expiresOn>your_dateTime_0</obh:expiresOn>
        <obh:firstPost>your_discussionsMessage_0</obh:firstPost>
        <obh:lastPost>your_discussionsMessage_0</obh:lastPost>
        <obh:locks>your_lock_0</obh:locks>
        <obh:locks>your_lock_1</obh:locks>
        <obh:locks>your_lock_2</obh:locks>
        <obh:messageCount>your_int_0</obh:messageCount>
        <obh:modifiedBy>your_actor_0</obh:modifiedBy>
        <obh:modifiedOn>your_dateTime_0</obh:modifiedOn>
        <obh:name>your_string_0</obh:name>
        <obh:nextTopic>your_topic_0</obh:nextTopic>
        <obh:parent>your_entity_0</obh:parent>
        <obh:policies>your_policy_0</obh:policies>
        <obh:policies>your_policy_1</obh:policies>
        <obh:policies>your_policy_2</obh:policies>
        <obh:previousTopic>your_topic_0</obh:previousTopic>
        <obh:properties>your_collabProperties_0</obh:properties>
        <obh:question>your_boolean_0</obh:question>
        <obh:questionStatus>your_topicQuestionStatus_0</obh:questionStatus>
        <obh:snapshotId>your_string_0</obh:snapshotId>
        <obh:userCreatedOn>your_dateTime_0</obh:userCreatedOn>
        <obh:userModifiedOn>your_dateTime_0</obh:userModifiedOn>
        <obh:viewCount>your_int_0</obh:viewCount>
        <obh:viewer>your_actor_0</obh:viewer>
        <obh:viewerProperties>your_collabProperties_0</obh:viewerProperties>
</obh:announcement>

JSON Example

(show inherited members)

{
    "beeType":"announcement",
        "activatesOn":"your_{http://www.oracle.com/beehive}activatesOn_as_dateTime0",
        "announcementStatus":{ your_{http://www.oracle.com/beehive}announcementStatus_as_announcementStatus0 },
        "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 }
        ],
        "availableMarkers":[
            { your_{http://www.oracle.com/beehive}availableMarkers_as_marker0 },
            { your_{http://www.oracle.com/beehive}availableMarkers_as_marker1 },
            { your_{http://www.oracle.com/beehive}availableMarkers_as_marker2 }
        ],
        "bonds":[
            { your_{http://www.oracle.com/beehive}bonds_as_bond0 },
            { your_{http://www.oracle.com/beehive}bonds_as_bond1 },
            { your_{http://www.oracle.com/beehive}bonds_as_bond2 }
        ],
        "changeStatus":{ your_{http://www.oracle.com/beehive}changeStatus_as_changeStatus0 },
        "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
        "correctAnswer":{ your_{http://www.oracle.com/beehive}correctAnswer_as_discussionsMessage0 },
        "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",
        "discussionsChangeStatus":{ your_{http://www.oracle.com/beehive}discussionsChangeStatus_as_changeStatus0 },
        "discussionsMessages":{ your_{http://www.oracle.com/beehive}discussionsMessages_as_listResult0 },
        "elementCount":your_{http://www.oracle.com/beehive}elementCount_as_int0,
        "elements":{ your_{http://www.oracle.com/beehive}elements_as_listResult0 },
        "expiresOn":"your_{http://www.oracle.com/beehive}expiresOn_as_dateTime0",
        "firstPost":{ your_{http://www.oracle.com/beehive}firstPost_as_discussionsMessage0 },
        "lastPost":{ your_{http://www.oracle.com/beehive}lastPost_as_discussionsMessage0 },
        "locks":[
            { your_{http://www.oracle.com/beehive}locks_as_lock0 },
            { your_{http://www.oracle.com/beehive}locks_as_lock1 },
            { your_{http://www.oracle.com/beehive}locks_as_lock2 }
        ],
        "messageCount":your_{http://www.oracle.com/beehive}messageCount_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",
        "nextTopic":{ your_{http://www.oracle.com/beehive}nextTopic_as_topic0 },
        "parent":{ your_{http://www.oracle.com/beehive}parent_as_entity0 },
        "policies":[
            { your_{http://www.oracle.com/beehive}policies_as_policy0 },
            { your_{http://www.oracle.com/beehive}policies_as_policy1 },
            { your_{http://www.oracle.com/beehive}policies_as_policy2 }
        ],
        "previousTopic":{ your_{http://www.oracle.com/beehive}previousTopic_as_topic0 },
        "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
        "question":your_{http://www.oracle.com/beehive}question_as_boolean0,
        "questionStatus":{ your_{http://www.oracle.com/beehive}questionStatus_as_topicQuestionStatus0 },
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
        "userCreatedOn":"your_{http://www.oracle.com/beehive}userCreatedOn_as_dateTime0",
        "userModifiedOn":"your_{http://www.oracle.com/beehive}userModifiedOn_as_dateTime0",
        "viewCount":your_{http://www.oracle.com/beehive}viewCount_as_int0,
        "viewer":{ your_{http://www.oracle.com/beehive}viewer_as_actor0 },
        "viewerProperties":{ your_{http://www.oracle.com/beehive}viewerProperties_as_collabProperties0 }
}

XML Schema


<xs:complexType name="announcement">
    <xs:complexContent>
        <xs:extension base="tns:topic">
            <xs:sequence>
                <xs:element minOccurs="0" name="activatesOn" type="xs:dateTime"/>
                <xs:element minOccurs="0" name="announcementStatus" type="tns:announcementStatus"/>
                <xs:element minOccurs="0" name="expiresOn" type="xs:dateTime"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to announcement

Referenced By Resources

Usage Resource Method
Response Announcement Create
Response Announcement List
Response Announcement Read
Response Announcement Read Batch
Request Announcement Read Batch
Response Announcement Update

Referenced By Representaions

Not Referenced Directly by Representations