Oracle® Beehive RESTful Web Services API Reference Release 2 (2.0.1.7) E16658-04 |
Resource WikiPage is a document that is always version-controlled and always discussed. A WikiPage has a "raw" form and a "rendered" form. The raw form of the WikiPage is the actual content stored in the WikiPage with no processing applied to it. It often contains content that is marked-up using wiki syntax, such as Creole. The rendered form of the WikiPage is the HTML representation of the "raw" form. Much like a document, it has a size associated with it, is contained within a folder, and can be locked.
Name | Type | Required | Description |
---|---|---|---|
checkedOut |
This member is true if the isFamily member is true and the WikiPage is currently checked out for editing. | ||
checkedOutBy |
The actor who currently has a WikiPage checked out for editing. | ||
checkedOutOn |
The time at which a checked-out WikiPage was checked out for editing. | ||
checkoutComments |
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. | ||
content |
The Content object associated with this WikiPage snapshot. It can safely be cast to an IdentifiableSimpleContent. | ||
contentSnapshotId |
ID marking the state of the wiki page at the time that the content was last updated. | ||
description |
The description of this WikiPage. | ||
family |
This member is true if this item represents a WikiPage with versions. | ||
locks |
lock[] |
All locks that are currently held on the WikiPage. | |
parentFamily |
(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 |
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 |
The path to the location of this WikiPage. | ||
renderedData |
The rendered data portion of this WikiPage as an Object. Only returned from the WikiControl.renderData member. | ||
renderedPage |
The rendered content of this WikiPage. Only returned from the WikiControl.renderPage member. | ||
representativeVersion |
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 |
(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 |
The user-visible current size of this WikiPage. If the WikiPage has multiple versions, this member refers to the size of the latest version. | ||
totalSize |
The total size of this WikiPage, including the aggregate size of all of its versions if the isFamily member is equal to true. | ||
version |
This member is true if this item represents the content of a specific version of a WikiPage. | ||
versionControlled |
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 |
The number of times this WikiPage has been viewed | ||
workingCopy |
This member is true if this item represents the content of a checked-out WikiPage. | ||
workspace |
The Workspace that is the parent container of this WikiPage |
Inherits From
Applied Markers
<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>
Usage | Resource | Method |
---|---|---|
Response | Wiki Page | Copy |
Response | Wiki Page | Create |
Response | Wiki Page | List |
Response | Wiki Page | List Orphan WikiPages |
Response | Wiki Page | Read |
Response | Wiki Page | Read Batch |
Request | Wiki Page | Read Batch |
Response | Wiki Page | Render Data |
Response | Wiki Page | Render Data With Default Context |
Response | Wiki Page | Render Page |
Response | Wiki Page | Render Page With Default Context |
Response | Wiki Page | Update |
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices