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

Contents

Overview

modify the values of one or more FaxMessage attributes.

Members

Name Type Description

addedFlags

messageFlag[]

Sets the specified enum set of message flags to this updater

changeStatus

changeStatus

Artifact change status.

deliveredTime

dateTime

Get message delivered time

faxMessageContentUpdater

faxMessageContentUpdater

An updater for fax message content that can be used to modify the fax message body attributes in the message.

flags

messageFlag[]

Message flags for the message. Flags not included in the collection are to be reset. Flags not added previously are to be added implicitly.

name

string

Get the Name of the Entity

overriddenFlags

messageFlag[]

Sets the overridden message flags

priority

priority

Get Priority

propertiesUpdater

collabPropertiesUpdater

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

removedFlags

messageFlag[]

Sets the enum set of removed message flags

sender

faxMessageParticipant

Get sender participant

subject

rawString

The subject of the message.

toReceivers

faxMessageRecipient[]

Get Fax Message Recipient(s)

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:faxMessageUpdater xsi:type="obh:faxMessageUpdater" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:addedFlags>your_messageFlag_0</obh:addedFlags>
        <obh:addedFlags>your_messageFlag_1</obh:addedFlags>
        <obh:addedFlags>your_messageFlag_2</obh:addedFlags>
        <obh:changeStatus>your_changeStatus_0</obh:changeStatus>
        <obh:deliveredTime>your_dateTime_0</obh:deliveredTime>
        <obh:faxMessageContentUpdater>your_faxMessageContentUpdater_0</obh:faxMessageContentUpdater>
        <obh:flags>your_messageFlag_0</obh:flags>
        <obh:flags>your_messageFlag_1</obh:flags>
        <obh:flags>your_messageFlag_2</obh:flags>
        <obh:name>your_string_0</obh:name>
        <obh:overriddenFlags>your_messageFlag_0</obh:overriddenFlags>
        <obh:overriddenFlags>your_messageFlag_1</obh:overriddenFlags>
        <obh:overriddenFlags>your_messageFlag_2</obh:overriddenFlags>
        <obh:priority>your_priority_0</obh:priority>
        <obh:propertiesUpdater>your_collabPropertiesUpdater_0</obh:propertiesUpdater>
        <obh:removedFlags>your_messageFlag_0</obh:removedFlags>
        <obh:removedFlags>your_messageFlag_1</obh:removedFlags>
        <obh:removedFlags>your_messageFlag_2</obh:removedFlags>
        <obh:sender>your_faxMessageParticipant_0</obh:sender>
        <obh:subject>your_rawString_0</obh:subject>
        <obh:toReceivers>your_faxMessageRecipient_0</obh:toReceivers>
        <obh:toReceivers>your_faxMessageRecipient_1</obh:toReceivers>
        <obh:toReceivers>your_faxMessageRecipient_2</obh:toReceivers>
        <obh:userCreatedOn>your_dateTime_0</obh:userCreatedOn>
        <obh:userModifiedOn>your_dateTime_0</obh:userModifiedOn>
        <obh:viewerPropertiesUpdater>your_collabPropertiesUpdater_0</obh:viewerPropertiesUpdater>
</obh:faxMessageUpdater>

JSON Example

(show inherited members)

{
    "beeType":"faxMessageUpdater",
        "addedFlags":[
            { your_{http://www.oracle.com/beehive}addedFlags_as_messageFlag0 },
            { your_{http://www.oracle.com/beehive}addedFlags_as_messageFlag1 },
            { your_{http://www.oracle.com/beehive}addedFlags_as_messageFlag2 }
        ],
        "changeStatus":{ your_{http://www.oracle.com/beehive}changeStatus_as_changeStatus0 },
        "deliveredTime":{ your_{http://www.oracle.com/beehive}deliveredTime_as_dateTime0 },
        "faxMessageContentUpdater":{ your_{http://www.oracle.com/beehive}faxMessageContentUpdater_as_faxMessageContentUpdater0 },
        "flags":[
            { your_{http://www.oracle.com/beehive}flags_as_messageFlag0 },
            { your_{http://www.oracle.com/beehive}flags_as_messageFlag1 },
            { your_{http://www.oracle.com/beehive}flags_as_messageFlag2 }
        ],
        "name":"your_{http://www.oracle.com/beehive}name_as_string0",
        "overriddenFlags":[
            { your_{http://www.oracle.com/beehive}overriddenFlags_as_messageFlag0 },
            { your_{http://www.oracle.com/beehive}overriddenFlags_as_messageFlag1 },
            { your_{http://www.oracle.com/beehive}overriddenFlags_as_messageFlag2 }
        ],
        "priority":{ your_{http://www.oracle.com/beehive}priority_as_priority0 },
        "propertiesUpdater":{ your_{http://www.oracle.com/beehive}propertiesUpdater_as_collabPropertiesUpdater0 },
        "removedFlags":[
            { your_{http://www.oracle.com/beehive}removedFlags_as_messageFlag0 },
            { your_{http://www.oracle.com/beehive}removedFlags_as_messageFlag1 },
            { your_{http://www.oracle.com/beehive}removedFlags_as_messageFlag2 }
        ],
        "sender":{ your_{http://www.oracle.com/beehive}sender_as_faxMessageParticipant0 },
        "subject":{ your_{http://www.oracle.com/beehive}subject_as_rawString0 },
        "toReceivers":[
            { your_{http://www.oracle.com/beehive}toReceivers_as_faxMessageRecipient0 },
            { your_{http://www.oracle.com/beehive}toReceivers_as_faxMessageRecipient1 },
            { your_{http://www.oracle.com/beehive}toReceivers_as_faxMessageRecipient2 }
        ],
        "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="faxMessageUpdater">
    <xs:complexContent>
        <xs:extension base="tns:messageUpdater">
            <xs:sequence>
                <xs:element minOccurs="0" name="deliveredTime" type="tns:dateTime"/>
                <xs:element minOccurs="0"
                    name="faxMessageContentUpdater" type="tns:faxMessageContentUpdater"/>
                <xs:element minOccurs="0" name="priority" type="tns:priority"/>
                <xs:element minOccurs="0" name="sender" type="tns:faxMessageParticipant"/>
                <xs:element minOccurs="0" name="subject" type="tns:rawString"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="toReceivers" type="tns:faxMessageRecipient"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to faxMessageUpdater

Referenced By Resources

Usage Resource Method
Request Fax Message Update

Referenced By Representaions