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

Beehive Development Kit » All Representations » deviceProfile
Contents

Overview

Represents the capabilities and configurations of one/many device types. The capabilities define the characteristics of the device. Configuration defines the configurable options and the default settings for the devices. Each device type can have only one device profile associated with it. Each device profile can be assigned to one or many device types.

The Projection.BASIC loads the attributes loaded by Projection.EMPTY and Capabilities, Configuration attributes.

The Projection.FULL loads all the attributes. The embedded attributes, e.g. Creator, will be loaded with Projection.EMPTY.

Members

Name Type Required Description

activePreferenceProfile

preferenceProfile
The active PreferenceProfile of the DeviceProfile.

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[]
The available PreferenceProfiles of the Device Profile.

capabilities

collabProperties
Returns the characteristics and limitations of the devices.

collabId

beeId
CollabId of the snapshot

configuration

preferenceProfile
Returns the configurable options and default settings for the devices.

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.

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.

snapshotId

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

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:deviceProfile xsi:type="obh:deviceProfile" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:activePreferenceProfile>your_preferenceProfile_0</obh:activePreferenceProfile>
         <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:capabilities>your_collabProperties_0</obh:capabilities>
         <obh:collabId>your_beeId_0</obh:collabId>
         <obh:configuration>your_preferenceProfile_0</obh:configuration>
         <obh:createdOn>your_dateTime_0</obh:createdOn>
         <obh:creator>your_actor_0</obh:creator>
         <obh:deleted>your_boolean_0</obh:deleted>
         <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:snapshotId>your_string_0</obh:snapshotId>
 </obh:deviceProfile>

JSON Example

(show inherited members)

{
    "beeType":"deviceProfile",
        "activePreferenceProfile":{ your_{http://www.oracle.com/beehive}activePreferenceProfile_as_preferenceProfile0 },
         "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 }
        ],
         "capabilities":{ your_{http://www.oracle.com/beehive}capabilities_as_collabProperties0 },
         "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
         "configuration":{ your_{http://www.oracle.com/beehive}configuration_as_preferenceProfile0 },
         "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,
         "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 },
         "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0"
 }

XML Schema


<xs:complexType name="deviceProfile">
    <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="availablePreferenceProfiles" type="tns:preferenceProfile"/>
                <xs:element minOccurs="0" name="capabilities" type="tns:collabProperties"/>
                <xs:element minOccurs="0" name="configuration" type="tns:preferenceProfile"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

References

The following data represents the references to deviceProfile

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions

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