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

Contents

Overview

Hold a set of modifications to be applied to a Reminder

Members

Name Type Description

changeStatus

changeStatus

Artifact change status.

eid

string

The Eid to be set to the Reminder

enabled

boolean

Set the reminder as enabled/diabled.

name

string

Get the Name of the Entity

primary

boolean

Set the Primary attribute of the ReminderUpdater.

propertiesUpdater

collabPropertiesUpdater

A CollabPropertiesUpdater which can be used to add or remove CollabProperties for this Artifact.

ruleUpdater

reminderRuleUpdater

Get the ReminderRule sub-updater to modify the ReminderRule that will apply to the reminder.

The ReminderRule, which contain ReminderContition and ReminderAction, describes what the reminder should do.

source

beeId<entity>

Set the source of a Reminder. Conceptually, this is WHAT you want to be reminded about. In the case where you want to specify a RelativeTrigger, then it is required for your source to have a start and/or end time.

status

reminderStatus

The ReminderStatus to be set to the Reminder.

Although the Status of a reminder is handled internally, it may be desirable to force a change in order to repeat the Reminder.

trigger

timedTrigger

The BdkTimedTrigger to be set to the Reminder

userCreatedOn

dateTime

The user creation time (if created offline) for the Artifact

userModifiedOn

dateTime

The user modification time (if created offline) for the Artifact

viewerPropertiesUpdater

collabPropertiesUpdater

A CollabPropertiesUpdater which can be used to add or remove viewer private CollabProperties for this Artifact.

Hierarchy

Inherits From

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:reminderUpdater xsi:type="obh:reminderUpdater" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:changeStatus>your_changeStatus_0</obh:changeStatus>
        <obh:eid>your_string_0</obh:eid>
        <obh:enabled>your_boolean_0</obh:enabled>
        <obh:name>your_string_0</obh:name>
        <obh:primary>your_boolean_0</obh:primary>
        <obh:propertiesUpdater>your_collabPropertiesUpdater_0</obh:propertiesUpdater>
        <obh:ruleUpdater>your_reminderRuleUpdater_0</obh:ruleUpdater>
        <obh:source>your_beeId_0</obh:source>
        <obh:status>your_reminderStatus_0</obh:status>
        <obh:trigger>your_timedTrigger_0</obh:trigger>
        <obh:userCreatedOn>your_dateTime_0</obh:userCreatedOn>
        <obh:userModifiedOn>your_dateTime_0</obh:userModifiedOn>
        <obh:viewerPropertiesUpdater>your_collabPropertiesUpdater_0</obh:viewerPropertiesUpdater>
</obh:reminderUpdater>

JSON Example

(show inherited members)

{
    "beeType":"reminderUpdater",
        "changeStatus":{ your_{http://www.oracle.com/beehive}changeStatus_as_changeStatus0 },
        "eid":"your_{http://www.oracle.com/beehive}eid_as_string0",
        "enabled":your_{http://www.oracle.com/beehive}enabled_as_boolean0,
        "name":"your_{http://www.oracle.com/beehive}name_as_string0",
        "primary":your_{http://www.oracle.com/beehive}primary_as_boolean0,
        "propertiesUpdater":{ your_{http://www.oracle.com/beehive}propertiesUpdater_as_collabPropertiesUpdater0 },
        "ruleUpdater":{ your_{http://www.oracle.com/beehive}ruleUpdater_as_reminderRuleUpdater0 },
        "source":{ your_{http://www.oracle.com/beehive}source_as_beeId0 },
        "status":{ your_{http://www.oracle.com/beehive}status_as_reminderStatus0 },
        "trigger":{ your_{http://www.oracle.com/beehive}trigger_as_timedTrigger0 },
        "userCreatedOn":"your_{http://www.oracle.com/beehive}userCreatedOn_as_dateTime0",
        "userModifiedOn":"your_{http://www.oracle.com/beehive}userModifiedOn_as_dateTime0",
        "viewerPropertiesUpdater":{ your_{http://www.oracle.com/beehive}viewerPropertiesUpdater_as_collabPropertiesUpdater0 }
}

XML Schema


<xs:complexType name="reminderUpdater">
    <xs:complexContent>
        <xs:extension base="tns:artifactUpdater">
            <xs:sequence>
                <xs:element minOccurs="0" name="trigger" type="tns:timedTrigger"/>
                <xs:element minOccurs="0" name="eid" type="xs:string"/>
                <xs:element minOccurs="0" name="enabled" type="xs:boolean"/>
                <xs:element minOccurs="0" name="primary" type="xs:boolean"/>
                <xs:element minOccurs="0" name="ruleUpdater" type="tns:reminderRuleUpdater"/>
                <xs:element minOccurs="0" name="source" type="tns:beeId"/>
                <xs:element minOccurs="0" name="status" type="tns:reminderStatus"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to reminderUpdater

Referenced By Resources

Usage Resource Method
Request Reminder Update

Referenced By Representaions