A script enabled browser is required for this page to function properly
Oracle® Beehive RESTful Web Services API Reference
Release 2 (2.0.1.7)
E16658-04
Overview
Represents a
ClientApplicationModule
to be deployed on the device
(
device )
Each
ClientApplicationModule
is uniquely identified by
Therefore each patchset (
clientApplicationPatchset ) cannot
have more than one
ClientApplicationModule
with the same name
and destination folder. Module is an Entity
entity and it
resides within a patchset (
clientApplicationPatchset )
Projection.BASIC: loads all attributes to be loaded by Projection.SECURITY
and the following attributes:
description, name, destination_folder, media_type, size
Projection.FULL includes all the attributes. The embedded attributes, e.g.
Creator, are loaded with Projection.EMPTY.
Members
Show inherited members
Projections
BASIC
EMPTY
FULL
META
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
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.
description
string
Get the description.
destinationFolder
string
Get the destination folder of the ClientApplicationModule
on the device.
mediaType
string
Get the media type of the ClientApplicationModule
.
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.
repairAttemptCount
int
The number of times the ClientApplication module was attempted to repair
after getting infected with a virus.
scanResults
virusScanResult []
The scan results of the ClientApplicationModule.
size
long
Get the size of the ClientApplicationModule
. This will be the size of
the content.
snapshotId
string
Contains the snapshot identifier for this snapshot. Snapshot identifiers
are used to implement optimistic locking on the server.
streamId
base64Binary
Get the stream id of the content in the scope of the module
virusDefinitionId
int
The identifier of the virus definition used while scanning the
ClientApplicationModule.
virusScanDate
dateTime
VirusScannable Getters
virusScanStatus
virusScanStatus
The status of the virus scan on the ClientApplicationModule.
Hierarchy
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:clientApplicationModule xsi:type="obh:clientApplicationModule" 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: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:description>your_string_0 </obh:description>
<obh:destinationFolder>your_string_0 </obh:destinationFolder>
<obh:mediaType>your_string_0 </obh:mediaType>
<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:repairAttemptCount>your_int_0 </obh:repairAttemptCount>
<obh:scanResults>your_virusScanResult_0 </obh:scanResults>
<obh:scanResults>your_virusScanResult_1 </obh:scanResults>
<obh:scanResults>your_virusScanResult_2 </obh:scanResults>
<obh:size>your_long_0 </obh:size>
<obh:snapshotId>your_string_0 </obh:snapshotId>
<obh:streamId>your_base64Binary_0 </obh:streamId>
<obh:virusDefinitionId>your_int_0 </obh:virusDefinitionId>
<obh:virusScanDate>your_dateTime_0 </obh:virusScanDate>
<obh:virusScanStatus>your_virusScanStatus_0 </obh:virusScanStatus>
</obh:clientApplicationModule>
JSON Example
(show inherited members)
{
"beeType":"clientApplicationModule",
"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 }
],
"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,
"description":"your_{http://www.oracle.com/beehive}description_as_string0",
"destinationFolder":"your_{http://www.oracle.com/beehive}destinationFolder_as_string0",
"mediaType":"your_{http://www.oracle.com/beehive}mediaType_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 },
"repairAttemptCount":your_{http://www.oracle.com/beehive}repairAttemptCount_as_int0,
"scanResults":[
{ your_{http://www.oracle.com/beehive}scanResults_as_virusScanResult0 },
{ your_{http://www.oracle.com/beehive}scanResults_as_virusScanResult1 },
{ your_{http://www.oracle.com/beehive}scanResults_as_virusScanResult2 }
],
"size":your_{http://www.oracle.com/beehive}size_as_long0,
"snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
"streamId":"your_{http://www.oracle.com/beehive}streamId_as_base64Binary0",
"virusDefinitionId":your_{http://www.oracle.com/beehive}virusDefinitionId_as_int0,
"virusScanDate":"your_{http://www.oracle.com/beehive}virusScanDate_as_dateTime0",
"virusScanStatus":{ your_{http://www.oracle.com/beehive}virusScanStatus_as_virusScanStatus0 }
}
XML Schema
<xs:complexType final="extension restriction" name="clientApplicationModule">
<xs:complexContent>
<xs:extension base="tns:entity">
<xs:sequence>
<xs:element minOccurs="0" name="description" type="xs:string"/>
<xs:element minOccurs="0" name="destinationFolder" type="xs:string"/>
<xs:element minOccurs="0" name="mediaType" type="xs:string"/>
<xs:element name="repairAttemptCount" type="xs:int"/>
<xs:element maxOccurs="unbounded" minOccurs="0"
name="scanResults" nillable="true" type="tns:virusScanResult"/>
<xs:element name="size" type="xs:long"/>
<xs:element minOccurs="0" name="streamId" type="xs:base64Binary"/>
<xs:element minOccurs="0" name="virusDefinitionId" type="xs:int"/>
<xs:element minOccurs="0" name="virusScanDate" type="xs:dateTime"/>
<xs:element minOccurs="0" name="virusScanStatus" type="tns:virusScanStatus"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
References
The following data represents the references to clientApplicationModule
Referenced By Resources
Referenced By Representaions
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices