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

Contents

Overview

RemoteShare is the entry point to perform operations on the remote content system.It holds the property values that are defined in the RemoteRepositorySchema. For the current implementation remote shares only can reside in the workspaces and nowhere else. All the ACLs that are applied at the remote shares will also be applied for the remote folders and documents that are derived from the remote share.

In a given workspace if a remote share is created for a given remote content sytem, no sub-path children can be created as the remote shares. For example a remote share is create for /oracle/dev, then in the same workspace no other remote share can exists at or under /oracle/dev path. However it can exists in different workspaces.

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

attributes

attributeApplication[]

Attribute values for the properties defined at RemoteRepositorySchema.

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 elements(folders, documents) in the Remote Folder.

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.

policies

policy[]

Set of Policies.

properties

collabProperties

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

remoteItemId

anyType

The external id of the Remote Folder.

snapshotId

string

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

temlate

remoteRepository

Template from which the remote share is been instantiated.

template

remoteRepository

Template from which the remote share is been instantiated.

userCreatedOn

dateTime

The user creation date (if created offline)

userModifiedOn

dateTime

The user last modified date (if modified offline)

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:remoteShare xsi:type="obh:remoteShare" 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:attributes>your_attributeApplication_0</obh:attributes>
        <obh:attributes>your_attributeApplication_1</obh:attributes>
        <obh:attributes>your_attributeApplication_2</obh:attributes>
        <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: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: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:remoteItemId>your_anyType_0</obh:remoteItemId>
        <obh:snapshotId>your_string_0</obh:snapshotId>
        <obh:temlate>your_remoteRepository_0</obh:temlate>
        <obh:template>your_remoteRepository_0</obh:template>
        <obh:userCreatedOn>your_dateTime_0</obh:userCreatedOn>
        <obh:userModifiedOn>your_dateTime_0</obh:userModifiedOn>
        <obh:viewer>your_actor_0</obh:viewer>
        <obh:viewerProperties>your_collabProperties_0</obh:viewerProperties>
</obh:remoteShare>

JSON Example

(show inherited members)

{
    "beeType":"remoteShare",
        "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 }
        ],
        "attributes":[
            { your_{http://www.oracle.com/beehive}attributes_as_attributeApplication0 },
            { your_{http://www.oracle.com/beehive}attributes_as_attributeApplication1 },
            { your_{http://www.oracle.com/beehive}attributes_as_attributeApplication2 }
        ],
        "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 },
        "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 },
        "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 },
        "remoteItemId":"your_{http://www.oracle.com/beehive}remoteItemId_as_anyType0",
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
        "temlate":{ your_{http://www.oracle.com/beehive}temlate_as_remoteRepository0 },
        "template":{ your_{http://www.oracle.com/beehive}template_as_remoteRepository0 },
        "userCreatedOn":"your_{http://www.oracle.com/beehive}userCreatedOn_as_dateTime0",
        "userModifiedOn":"your_{http://www.oracle.com/beehive}userModifiedOn_as_dateTime0",
        "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="remoteShare">
    <xs:complexContent>
        <xs:extension base="tns:remoteFolder">
            <xs:sequence>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="attributes" nillable="true" type="tns:attributeApplication"/>
                <xs:element minOccurs="0" name="temlate" type="tns:remoteRepository"/>
                <xs:element minOccurs="0" name="template" type="tns:remoteRepository"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to remoteShare

Referenced By Resources

Usage Resource Method
Response RemoteShare Create
Response RemoteShare Read
Response RemoteShare Update

Referenced By Representaions

Not Referenced Directly by Representations