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

Contents

Overview

Represents a physical device owned by a user( user). Each Device must have {Manufacturer, Model, [SoftwareVersion], [DevInfDTDVersion]} or/and {OS, Processor and DeviceClass} specified. SoftwareVersion and DevInfDTDVersion are optional. The status field represents various options like Active, Lockdown, etc.

Projection.BASIC loads all the attributes to be loaded by Projection.EMPTY and the following attributes : DeviceId, DevInfDTDVersion, Handle, Manufacturer, Model, OS, Processor, SoftwareVersion, Status, and DeviceType, which is loaded using Projection.BASIC.

Projection.FULL includes all the attributes. The embedded attributes, e.g. Creator, are loaded with Projection.EMPTY.

Members

Name Type Required Description

OS

string

Returns the device operating system.

activePreferenceProfile

preferenceProfile

Returns the active preference profile for this Device. There is an active preference profile if the Device has an associated DeviceType, and the DeviceType's DeviceProfile has configuration (whose type is PreferenceProfile). In such a case, the PreferenceSets of the Device active preference profile will extend from the PreferenceSets of the DeviceProfile configuration.

addresses

entityAddress[]

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

availablePreferenceProfiles

preferenceProfile[]

collabId

beeId

CollabId of the snapshot

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.

devInfDTDVersion

string

Returns the OMA device information DTD version.

deviceClass

string

Returns the device class.

deviceId

string

Returns the local device ID of the Device.

deviceInfo

collabProperties

Returns a collection of device properties.

deviceType

deviceType

Returns the associated deviceType. The Device to DeviceType relationship is computed using the following attributes of Device and DeviceType : Manufacturer, Model, SoftwareVersion, DevInfDTDVersion, OS, Processor and DeviceClass.

installedClientApplications

installedClientApplication[]

Returns the list of installedClientApplications installed on the device.

manufacturer

string

Returns the device manufacturer.

model

string

Returns the device model.

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.

pendingCommands

deviceCommand[]

Returns the list of deviceCommands to be executed on the device.

primaryAddress

entityAddress

processor

string

Returns the device processor.

snapshotId

string

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

softwareVersion

string

Returns the software version

status

deviceStatus

Returns the status of Device. The possible values are defined in

user

user

Returns the user of the device

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:device xsi:type="obh:device" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:OS>your_string_0</obh:OS>
        <obh:activePreferenceProfile>your_preferenceProfile_0</obh:activePreferenceProfile>
        <obh:addresses>your_entityAddress_0</obh:addresses>
        <obh:addresses>your_entityAddress_1</obh:addresses>
        <obh:addresses>your_entityAddress_2</obh:addresses>
        <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:availablePreferenceProfiles>your_preferenceProfile_0</obh:availablePreferenceProfiles>
        <obh:availablePreferenceProfiles>your_preferenceProfile_1</obh:availablePreferenceProfiles>
        <obh:availablePreferenceProfiles>your_preferenceProfile_2</obh:availablePreferenceProfiles>
        <obh:collabId>your_beeId_0</obh:collabId>
        <obh:createdOn>your_dateTime_0</obh:createdOn>
        <obh:creator>your_actor_0</obh:creator>
        <obh:deleted>your_boolean_0</obh:deleted>
        <obh:devInfDTDVersion>your_string_0</obh:devInfDTDVersion>
        <obh:deviceClass>your_string_0</obh:deviceClass>
        <obh:deviceId>your_string_0</obh:deviceId>
        <obh:deviceInfo>your_collabProperties_0</obh:deviceInfo>
        <obh:deviceType>your_deviceType_0</obh:deviceType>
        <obh:installedClientApplications>your_installedClientApplication_0</obh:installedClientApplications>
        <obh:installedClientApplications>your_installedClientApplication_1</obh:installedClientApplications>
        <obh:installedClientApplications>your_installedClientApplication_2</obh:installedClientApplications>
        <obh:manufacturer>your_string_0</obh:manufacturer>
        <obh:model>your_string_0</obh:model>
        <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:pendingCommands>your_deviceCommand_0</obh:pendingCommands>
        <obh:pendingCommands>your_deviceCommand_1</obh:pendingCommands>
        <obh:pendingCommands>your_deviceCommand_2</obh:pendingCommands>
        <obh:primaryAddress>your_entityAddress_0</obh:primaryAddress>
        <obh:processor>your_string_0</obh:processor>
        <obh:snapshotId>your_string_0</obh:snapshotId>
        <obh:softwareVersion>your_string_0</obh:softwareVersion>
        <obh:status>your_deviceStatus_0</obh:status>
        <obh:user>your_user_0</obh:user>
</obh:device>

JSON Example

(show inherited members)

{
    "beeType":"device",
        "OS":"your_{http://www.oracle.com/beehive}OS_as_string0",
        "activePreferenceProfile":{ your_{http://www.oracle.com/beehive}activePreferenceProfile_as_preferenceProfile0 },
        "addresses":[
            { your_{http://www.oracle.com/beehive}addresses_as_entityAddress0 },
            { your_{http://www.oracle.com/beehive}addresses_as_entityAddress1 },
            { your_{http://www.oracle.com/beehive}addresses_as_entityAddress2 }
        ],
        "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 }
        ],
        "availablePreferenceProfiles":[
            { your_{http://www.oracle.com/beehive}availablePreferenceProfiles_as_preferenceProfile0 },
            { your_{http://www.oracle.com/beehive}availablePreferenceProfiles_as_preferenceProfile1 },
            { your_{http://www.oracle.com/beehive}availablePreferenceProfiles_as_preferenceProfile2 }
        ],
        "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
        "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,
        "devInfDTDVersion":"your_{http://www.oracle.com/beehive}devInfDTDVersion_as_string0",
        "deviceClass":"your_{http://www.oracle.com/beehive}deviceClass_as_string0",
        "deviceId":"your_{http://www.oracle.com/beehive}deviceId_as_string0",
        "deviceInfo":{ your_{http://www.oracle.com/beehive}deviceInfo_as_collabProperties0 },
        "deviceType":{ your_{http://www.oracle.com/beehive}deviceType_as_deviceType0 },
        "installedClientApplications":[
            { your_{http://www.oracle.com/beehive}installedClientApplications_as_installedClientApplication0 },
            { your_{http://www.oracle.com/beehive}installedClientApplications_as_installedClientApplication1 },
            { your_{http://www.oracle.com/beehive}installedClientApplications_as_installedClientApplication2 }
        ],
        "manufacturer":"your_{http://www.oracle.com/beehive}manufacturer_as_string0",
        "model":"your_{http://www.oracle.com/beehive}model_as_string0",
        "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 },
        "pendingCommands":[
            { your_{http://www.oracle.com/beehive}pendingCommands_as_deviceCommand0 },
            { your_{http://www.oracle.com/beehive}pendingCommands_as_deviceCommand1 },
            { your_{http://www.oracle.com/beehive}pendingCommands_as_deviceCommand2 }
        ],
        "primaryAddress":{ your_{http://www.oracle.com/beehive}primaryAddress_as_entityAddress0 },
        "processor":"your_{http://www.oracle.com/beehive}processor_as_string0",
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
        "softwareVersion":"your_{http://www.oracle.com/beehive}softwareVersion_as_string0",
        "status":{ your_{http://www.oracle.com/beehive}status_as_deviceStatus0 },
        "user":{ your_{http://www.oracle.com/beehive}user_as_user0 }
}

XML Schema


<xs:complexType final="extension restriction" name="device">
    <xs:complexContent>
        <xs:extension base="tns:entity">
            <xs:sequence>
                <xs:element minOccurs="0" name="activePreferenceProfile" type="tns:preferenceProfile"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="addresses" nillable="true" type="tns:entityAddress"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="availablePreferenceProfiles" type="tns:preferenceProfile"/>
                <xs:element minOccurs="0" name="devInfDTDVersion" type="xs:string"/>
                <xs:element minOccurs="0" name="deviceClass" type="xs:string"/>
                <xs:element minOccurs="0" name="deviceId" type="xs:string"/>
                <xs:element minOccurs="0" name="deviceInfo" type="tns:collabProperties"/>
                <xs:element minOccurs="0" name="deviceType" type="tns:deviceType"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="installedClientApplications" nillable="true" type="tns:installedClientApplication"/>
                <xs:element minOccurs="0" name="manufacturer" type="xs:string"/>
                <xs:element minOccurs="0" name="model" type="xs:string"/>
                <xs:element minOccurs="0" name="OS" type="xs:string"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="pendingCommands" nillable="true" type="tns:deviceCommand"/>
                <xs:element minOccurs="0" name="primaryAddress" type="tns:entityAddress"/>
                <xs:element minOccurs="0" name="processor" type="xs:string"/>
                <xs:element minOccurs="0" name="softwareVersion" type="xs:string"/>
                <xs:element minOccurs="0" name="status" type="tns:deviceStatus"/>
                <xs:element minOccurs="0" name="user" type="tns:user"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to device

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions