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

Contents

Overview

Resource Enterprise represents a top-level Scope for all Entities in Oracle Beehive.

Members

Name Type Required Description

activePreferenceProfile

preferenceProfile

Active preference profile of the scope.

allocatedQuota

long

The allocated Quota of all sub containers for the Community. This means that the total Quota available to be allocated for future sub containers cannot exceed the total Quota of the Community minus this amount. Please note that if any of the sub containers has unlimited Quota (this is only allowed if the Quota of this Community is unlimited and it allows unlimited Quota for sub containers), QuotaConfiguration.UNLIMITED will be returned.

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[]

Available marker Elements for the Scope

availablePreferenceProfiles

preferenceProfile[]

Available preference profiles of the scope.

bonds

bond[]

Bonds associated with the scope.

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 scope.

lastModifiedByName

string

The name of the user who last modified this Community.

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 Path to the community.

policies

policy[]

Policies of the scope.

properties

collabProperties

Properties of the scope.

quotaConfiguration

quotaConfiguration

QuotaConfiguration of the scope.

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:enterprise xsi:type="obh:enterprise" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:activePreferenceProfile>your_preferenceProfile_0</obh:activePreferenceProfile>
        <obh:allocatedQuota>your_long_0</obh:allocatedQuota>
        <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:availablePreferenceProfiles>your_preferenceProfile_0</obh:availablePreferenceProfiles>
        <obh:availablePreferenceProfiles>your_preferenceProfile_1</obh:availablePreferenceProfiles>
        <obh:availablePreferenceProfiles>your_preferenceProfile_2</obh:availablePreferenceProfiles>
        <obh:bonds>your_bond_0</obh:bonds>
        <obh:bonds>your_bond_1</obh:bonds>
        <obh:bonds>your_bond_2</obh:bonds>
        <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:lastModifiedByName>your_string_0</obh:lastModifiedByName>
        <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: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:quotaConfiguration>your_quotaConfiguration_0</obh:quotaConfiguration>
        <obh:snapshotId>your_string_0</obh:snapshotId>
</obh:enterprise>

JSON Example

(show inherited members)

{
    "beeType":"enterprise",
        "activePreferenceProfile":{ your_{http://www.oracle.com/beehive}activePreferenceProfile_as_preferenceProfile0 },
        "allocatedQuota":your_{http://www.oracle.com/beehive}allocatedQuota_as_long0,
        "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 }
        ],
        "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 }
        ],
        "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 }
        ],
        "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",
        "lastModifiedByName":"your_{http://www.oracle.com/beehive}lastModifiedByName_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 },
        "path":"your_{http://www.oracle.com/beehive}path_as_string0",
        "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 },
        "quotaConfiguration":{ your_{http://www.oracle.com/beehive}quotaConfiguration_as_quotaConfiguration0 },
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0"
}

XML Schema


<xs:complexType name="enterprise">
    <xs:complexContent>
        <xs:extension base="tns:community">
            <xs:sequence/>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to enterprise

Referenced By Resources

Usage Resource Method
Response Enterprise List
Response Enterprise Read
Response Enterprise Read Batch
Request Enterprise Read Batch
Response Enterprise Update

Referenced By Representaions

Not Referenced Directly by Representations