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

Overview

Members

Show inherited 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
bonds	bond[]		List of artifact bonds
changeStatus	changeStatus		The change status of the artifact
checkedOut	boolean		This member is true if the isFamily member is true and the WikiPage is currently checked out for editing.
checkedOutBy	actor		The actor who currently has a WikiPage checked out for editing.
checkedOutOn	dateTime		The time at which a checked-out WikiPage was checked out for editing.
checkoutComments	string		If this item represents a WikiPage that is currently checked out for editing, then the checkoutComments member stores the comments that describe the edits made for the checkout.
collabId	beeId		CollabId of the snapshot
content	content		The Content object associated with this WikiPage snapshot. It can safely be cast to an IdentifiableSimpleContent.
contentSnapshotId	string		ID marking the state of the wiki page at the time that the content was last updated.
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		The description of this WikiPage.
family	boolean		This member is true if this item represents a WikiPage with versions.
locks	lock[]		All locks that are currently held on the WikiPage.
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.
parentFamily	anyType (constrained to Versionable)		If this item represents a specific version of a WikiPage, then this member can be loaded to get the overall WikiPage (the family) of which this item is a part.
parentVersion	version		If this item represents a specific version of a WikiPage, then this member can be loaded to get the metadata for this particular version.
path	string		The path to the location of this WikiPage.
properties	collabProperties		The properties of the artifact that are shared among all the actors
renderedData	anyType		The rendered data portion of this WikiPage as an Object. Only returned from the WikiControl.renderData member.
renderedPage	string		The rendered content of this WikiPage. Only returned from the WikiControl.renderPage member.
representativeVersion	version		If this item represents a WikiPage with versions, then this member can be loaded to get the metadata for the latest version or the working copy, depending on whether the current actor has the WikiPage checked out for editing.
representativeVersionable	anyType (constrained to Versionable)		If this item represents a WikiPage with versions, then this member can be loaded to get the content of the latest version or the working copy, depending on whether the current actor has the WikiPage checked out for editing.
size	long		The user-visible current size of this WikiPage. If the WikiPage has multiple versions, this member refers to the size of the latest version.
snapshotId	string		Contains the snapshot identifier for this snapshot. Snapshot identifiers are used to implement optimistic locking on the server.
totalSize	long		The total size of this WikiPage, including the aggregate size of all of its versions if the isFamily member is equal to true.
userCreatedOn	dateTime		The user creation date (if created offline)
userModifiedOn	dateTime		The user last modified date (if modified offline)
version	boolean		This member is true if this item represents the content of a specific version of a WikiPage.
versionControlled	boolean		This member is true if the WikiPage is under version control and is either a family, version, or working copy.
versionHistory	version[]		List of the metadata for each Version of the WikiPage, which includes the version numbers and comments associated with each version.
versionableHistory	anyType[]		List of all Versions of the WikiPage. These types can be loaded to retrieve the actual WikiPage content associated with each version.
viewCount	int		The number of times this WikiPage has been viewed
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
workingCopy	boolean		This member is true if this item represents the content of a checked-out WikiPage.
workspace	workspace		The Workspace that is the parent container of this WikiPage

Hierarchy

Examples

XML Example

(show inherited members)

JSON Example

(show inherited members)

XML Schema

<xs:complexType name="wikiPage">
    <xs:complexContent>
        <xs:extension base="tns:artifact">
            <xs:sequence>
                <xs:element name="checkedOut" type="xs:boolean"/>
                <xs:element minOccurs="0" name="checkedOutBy" type="tns:actor"/>
                <xs:element minOccurs="0" name="checkedOutOn" type="xs:dateTime"/>
                <xs:element minOccurs="0" name="checkoutComments" type="xs:string"/>
                <xs:element minOccurs="0" name="content" type="tns:content"/>
                <xs:element minOccurs="0" name="contentSnapshotId" type="xs:string"/>
                <xs:element minOccurs="0" name="description" type="xs:string"/>
                <xs:element name="family" type="xs:boolean"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="locks" nillable="true" type="tns:lock"/>
                <xs:element minOccurs="0" name="parentFamily" type="xs:anyType"/>
                <xs:element minOccurs="0" name="parentVersion" type="tns:version"/>
                <xs:element minOccurs="0" name="path" type="xs:string"/>
                <xs:element minOccurs="0" name="renderedData" type="xs:anyType"/>
                <xs:element minOccurs="0" name="renderedPage" type="xs:string"/>
                <xs:element minOccurs="0" name="representativeVersion" type="tns:version"/>
                <xs:element minOccurs="0"
                    name="representativeVersionable" type="xs:anyType"/>
                <xs:element name="size" type="xs:long"/>
                <xs:element name="totalSize" type="xs:long"/>
                <xs:element name="version" type="xs:boolean"/>
                <xs:element name="versionControlled" type="xs:boolean"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="versionHistory" nillable="true" type="tns:version"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="versionableHistory" nillable="true" type="xs:anyType"/>
                <xs:element name="viewCount" type="xs:int"/>
                <xs:element name="workingCopy" type="xs:boolean"/>
                <xs:element minOccurs="0" name="workspace" type="tns:workspace"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

Referenced By Resources

Referenced By Representaions

• workspace

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