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

Contents

Overview

Resource HeterogeneousFolder is a type of Folder that can contain any Artifact. This is in contrast to constrained Folders that can only contain instances of a set of Artifact types. Examples of constrained Folders include Calendar, AddressBook, and Forum. Heterogeneous Folders are the only places where Documents, EmailMessages, Links, External Artifacts, and Wiki Pages are stored.

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

availableMarkers

marker[]

Set of available Markers.

bonds

bond[]

List of artifact bonds

changeStatus

changeStatus

The change status of the artifact

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

Description of the Folder.

elementCount

int

The number of elements in the Folder.

elements

listResult

The items in the HeterogeneousFolder.

lastModifiedByName

string

Name of the Actor who last modified the HeterogeneousFolder.

locks

lock[]

List of locks held on the HeterogeneousFolder.

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.

path

string

The fully-qualified path of the HeterogeneousFolder.

pendingWorkflowStatus

pendingWorkflowStatus

The PendingWorkflowStatus for this HeterogeneousFolder if there is a Workflow pending on it.

policies

policy[]

Set of Policies.

properties

collabProperties

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

size

long

The size of the HeterogeneousFolder.

snapshotId

string

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

subFolders

listResult

Sub Folders of this HeterogeneousFolder.

userCreatedOn

dateTime

The user creation date (if created offline)

userModifiedOn

dateTime

The user last modified date (if modified offline)

viewCount

int

The number of times this heterogeneous folder has had its contents listed

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:heterogeneousFolder xsi:type="obh:heterogeneousFolder" 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:availableMarkers>your_marker_0</obh:availableMarkers>
        <obh:availableMarkers>your_marker_1</obh:availableMarkers>
        <obh:availableMarkers>your_marker_2</obh:availableMarkers>
        <obh:bonds>your_bond_0</obh:bonds>
        <obh:bonds>your_bond_1</obh:bonds>
        <obh:bonds>your_bond_2</obh:bonds>
        <obh:changeStatus>your_changeStatus_0</obh:changeStatus>
        <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:elementCount>your_int_0</obh:elementCount>
        <obh:elements>your_listResult_0</obh:elements>
        <obh:lastModifiedByName>your_string_0</obh:lastModifiedByName>
        <obh:locks>your_lock_0</obh:locks>
        <obh:locks>your_lock_1</obh:locks>
        <obh:locks>your_lock_2</obh:locks>
        <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:path>your_string_0</obh:path>
        <obh:pendingWorkflowStatus>your_pendingWorkflowStatus_0</obh:pendingWorkflowStatus>
        <obh:policies>your_policy_0</obh:policies>
        <obh:policies>your_policy_1</obh:policies>
        <obh:policies>your_policy_2</obh:policies>
        <obh:properties>your_collabProperties_0</obh:properties>
        <obh:size>your_long_0</obh:size>
        <obh:snapshotId>your_string_0</obh:snapshotId>
        <obh:subFolders>your_listResult_0</obh:subFolders>
        <obh:userCreatedOn>your_dateTime_0</obh:userCreatedOn>
        <obh:userModifiedOn>your_dateTime_0</obh:userModifiedOn>
        <obh:viewCount>your_int_0</obh:viewCount>
        <obh:viewer>your_actor_0</obh:viewer>
        <obh:viewerProperties>your_collabProperties_0</obh:viewerProperties>
</obh:heterogeneousFolder>

JSON Example

(show inherited members)

{
    "beeType":"heterogeneousFolder",
        "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 }
        ],
        "availableMarkers":[
            { your_{http://www.oracle.com/beehive}availableMarkers_as_marker0 },
            { your_{http://www.oracle.com/beehive}availableMarkers_as_marker1 },
            { your_{http://www.oracle.com/beehive}availableMarkers_as_marker2 }
        ],
        "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 }
        ],
        "changeStatus":{ your_{http://www.oracle.com/beehive}changeStatus_as_changeStatus0 },
        "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",
        "elementCount":your_{http://www.oracle.com/beehive}elementCount_as_int0,
        "elements":{ your_{http://www.oracle.com/beehive}elements_as_listResult0 },
        "lastModifiedByName":"your_{http://www.oracle.com/beehive}lastModifiedByName_as_string0",
        "locks":[
            { your_{http://www.oracle.com/beehive}locks_as_lock0 },
            { your_{http://www.oracle.com/beehive}locks_as_lock1 },
            { your_{http://www.oracle.com/beehive}locks_as_lock2 }
        ],
        "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 },
        "path":"your_{http://www.oracle.com/beehive}path_as_string0",
        "pendingWorkflowStatus":{ your_{http://www.oracle.com/beehive}pendingWorkflowStatus_as_pendingWorkflowStatus0 },
        "policies":[
            { your_{http://www.oracle.com/beehive}policies_as_policy0 },
            { your_{http://www.oracle.com/beehive}policies_as_policy1 },
            { your_{http://www.oracle.com/beehive}policies_as_policy2 }
        ],
        "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
        "size":your_{http://www.oracle.com/beehive}size_as_long0,
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
        "subFolders":{ your_{http://www.oracle.com/beehive}subFolders_as_listResult0 },
        "userCreatedOn":"your_{http://www.oracle.com/beehive}userCreatedOn_as_dateTime0",
        "userModifiedOn":"your_{http://www.oracle.com/beehive}userModifiedOn_as_dateTime0",
        "viewCount":your_{http://www.oracle.com/beehive}viewCount_as_int0,
        "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="heterogeneousFolder">
    <xs:complexContent>
        <xs:extension base="tns:folder">
            <xs:sequence>
                <xs:element minOccurs="0" name="elements" type="tns:listResult"/>
                <xs:element minOccurs="0" name="lastModifiedByName" type="xs:string"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="locks" nillable="true" type="tns:lock"/>
                <xs:element minOccurs="0" name="path" type="xs:string"/>
                <xs:element minOccurs="0" ref="tns:pendingWorkflowStatus"/>
                <xs:element name="size" type="xs:long"/>
                <xs:element minOccurs="0" name="subFolders" type="tns:listResult"/>
                <xs:element name="viewCount" type="xs:int"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to heterogeneousFolder

Referenced By Resources

Usage Resource Method
Response Heterogeneous Folder Copy
Response Heterogeneous Folder Create
Request Heterogeneous Folder Delete Batch
Response Heterogeneous Folder List Subfolders
Request Heterogeneous Folder Move Batch to Trash
Response Heterogeneous Folder Read
Response Heterogeneous Folder Read Batch
Request Heterogeneous Folder Read Batch
Response Heterogeneous Folder Undelete
Response Heterogeneous Folder Update
Response PersonalWorkspace List Subfolders
Response TeamWorkspace List Subfolders

Referenced By Representaions