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

Beehive Development Kit » All Representations » faxMessage
Contents

Overview

A fax message. Fax messages contain a priority and fax message headers.

Members

Name Type Required Description

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

body

content
Body of the message. The body typically contains a free-form payload but may potentially include an hierarchy of parts.

bonds

bond[]
List of artifact bonds

calleePhoneNumbers

entityAddress[]
The phone number(s) of the message recipient(s).

callerPhoneNumber

entityAddress
The phone number of the sender of the message

changeStatus

changeStatus
The change status of the artifact

collabId

beeId
CollabId of the snapshot

content

faxMessageContent
The fax message content.

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.

deliveredTime

dateTime
Time when the message is delivered to the INBOX of this intended recipient

modifiedBy

actor
The actor that last modified the entity

modifiedOn

dateTime
The date when entity was last modified

name

string
Name of the entity.

parent

entity
The parent for this entity.

priority

priority
The message priority.

properties

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

receivers

anyType[]
Intended collection of recipients of this message.

references

artifact[]
This member is deprecated and no longer in use.

sender

actor
Sender of the message.

size

long
The size of the message in bytes.

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)

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:faxMessage xsi:type="obh:faxMessage" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <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:body>your_content_0</obh:body>
         <obh:bonds>your_bond_0</obh:bonds>
        <obh:bonds>your_bond_1</obh:bonds>
        <obh:bonds>your_bond_2</obh:bonds>
         <obh:calleePhoneNumbers>your_entityAddress_0</obh:calleePhoneNumbers>
        <obh:calleePhoneNumbers>your_entityAddress_1</obh:calleePhoneNumbers>
        <obh:calleePhoneNumbers>your_entityAddress_2</obh:calleePhoneNumbers>
         <obh:callerPhoneNumber>your_entityAddress_0</obh:callerPhoneNumber>
         <obh:changeStatus>your_changeStatus_0</obh:changeStatus>
         <obh:collabId>your_beeId_0</obh:collabId>
         <obh:content>your_faxMessageContent_0</obh:content>
         <obh:createdOn>your_dateTime_0</obh:createdOn>
         <obh:creator>your_actor_0</obh:creator>
         <obh:deleted>your_boolean_0</obh:deleted>
         <obh:deliveredTime>your_dateTime_0</obh:deliveredTime>
         <obh:modifiedBy>your_actor_0</obh:modifiedBy>
         <obh:modifiedOn>your_dateTime_0</obh:modifiedOn>
         <obh:name>your_string_0</obh:name>
         <obh:parent>your_entity_0</obh:parent>
         <obh:priority>your_priority_0</obh:priority>
         <obh:properties>your_collabProperties_0</obh:properties>
         <obh:receivers>your_anyType_0</obh:receivers>
        <obh:receivers>your_anyType_1</obh:receivers>
        <obh:receivers>your_anyType_2</obh:receivers>
         <obh:references>your_artifact_0</obh:references>
        <obh:references>your_artifact_1</obh:references>
        <obh:references>your_artifact_2</obh:references>
         <obh:sender>your_actor_0</obh:sender>
         <obh:size>your_long_0</obh:size>
         <obh:snapshotId>your_string_0</obh:snapshotId>
         <obh:userCreatedOn>your_dateTime_0</obh:userCreatedOn>
         <obh:userModifiedOn>your_dateTime_0</obh:userModifiedOn>
         <obh:viewer>your_actor_0</obh:viewer>
         <obh:viewerProperties>your_collabProperties_0</obh:viewerProperties>
 </obh:faxMessage>

JSON Example

(show inherited members)

{
    "beeType":"faxMessage",
        "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 }
        ],
         "body":{ your_{http://www.oracle.com/beehive}body_as_content0 },
         "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 }
        ],
         "calleePhoneNumbers":[
            { your_{http://www.oracle.com/beehive}calleePhoneNumbers_as_entityAddress0 },
            { your_{http://www.oracle.com/beehive}calleePhoneNumbers_as_entityAddress1 },
            { your_{http://www.oracle.com/beehive}calleePhoneNumbers_as_entityAddress2 }
        ],
         "callerPhoneNumber":{ your_{http://www.oracle.com/beehive}callerPhoneNumber_as_entityAddress0 },
         "changeStatus":{ your_{http://www.oracle.com/beehive}changeStatus_as_changeStatus0 },
         "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
         "content":{ your_{http://www.oracle.com/beehive}content_as_faxMessageContent0 },
         "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,
         "deliveredTime":{ your_{http://www.oracle.com/beehive}deliveredTime_as_dateTime0 },
         "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",
         "parent":{ your_{http://www.oracle.com/beehive}parent_as_entity0 },
         "priority":{ your_{http://www.oracle.com/beehive}priority_as_priority0 },
         "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
         "receivers":[
            "your_{http://www.oracle.com/beehive}receivers_as_anyType0",
            "your_{http://www.oracle.com/beehive}receivers_as_anyType1",
            "your_{http://www.oracle.com/beehive}receivers_as_anyType2"
        ],
         "references":[
            { your_{http://www.oracle.com/beehive}references_as_artifact0 },
            { your_{http://www.oracle.com/beehive}references_as_artifact1 },
            { your_{http://www.oracle.com/beehive}references_as_artifact2 }
        ],
         "sender":{ your_{http://www.oracle.com/beehive}sender_as_actor0 },
         "size":your_{http://www.oracle.com/beehive}size_as_long0,
         "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",
         "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="faxMessage">
    <xs:complexContent>
        <xs:extension base="tns:message">
            <xs:sequence>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="calleePhoneNumbers" nillable="true" type="tns:entityAddress"/>
                <xs:element minOccurs="0" name="callerPhoneNumber" type="tns:entityAddress"/>
                <xs:element minOccurs="0" name="content" type="tns:faxMessageContent"/>
                <xs:element minOccurs="0" name="priority" type="tns:priority"/>
                <xs:element name="size" type="xs:long"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

References

The following data represents the references to faxMessage

Referenced By Resources

Usage Resource Method
Response Fax Message Create
Response Fax Message List
Request Fax Message Move Batch
Request Fax Message Move Batch to Trash
Response Fax Message Read
Response Fax Message Read Batch
Request Fax Message Read Batch
Request Fax Message Undelete Batch
Response Fax Message Update

Referenced By Representaions

Oracle Logo
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices