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

Contents

Overview

Specifies which attributes of a WikiPage to update.

Members

Name Type Description

changeStatus

changeStatus

Artifact change status.

description

string

The description of this WikiPage.

extractReferences

boolean

incrementViewCount

boolean

Boolean member indicating whether or not to increment the view count associated with this WikiPage.

name

string

Get the Name of the Entity

propertiesUpdater

collabPropertiesUpdater

A CollabPropertiesUpdater which can be used to add or remove CollabProperties for this Artifact.

updateMode

updateMode

The UpdateMode associated with this WikiPageUpdator, which controls how the server show behave in the case of update conflicts.

updatedBody

contentUpdater

The ContentUpdator containing the updated body content of the WikiPage.

userCreatedOn

dateTime

The user creation time (if created offline) for the Artifact

userModifiedOn

dateTime

The user modification time (if created offline) for the Artifact

versionDescription

string

The Version description for the newly created Version of the WikiPage. Only valid during the update of the WikiPage content.

versionUpdateMode

versionUpdateMode

The mode that specifies whether the updater's changes should be applied to the family (and not subject to version control) or to the working copy of the entity. This property is only in effect for two-step updates when versioning is present.

viewerPropertiesUpdater

collabPropertiesUpdater

A CollabPropertiesUpdater which can be used to add or remove viewer private CollabProperties for this Artifact.

wikiPageId

beeId

The unique CollabId assigned to the WikiPage that is being updated.

wikiPageRenderMode

wikiPageRenderMode

The WikiPageRenderMode associated with this WikiPage. Specifies the rules of how the wiki page can be rendered into HTML. These rules are used to resolve links contained in the WikiPage to Artifact paths and to create Bonds to the link Artifacts. These rules are also used, if requested, to generate an HTML representation of the WikiPage which can then be cached on the server side.

Hierarchy

Inherits From

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:wikiPageUpdater xsi:type="obh:wikiPageUpdater" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:changeStatus>your_changeStatus_0</obh:changeStatus>
        <obh:description>your_string_0</obh:description>
        <obh:extractReferences>your_boolean_0</obh:extractReferences>
        <obh:incrementViewCount>your_boolean_0</obh:incrementViewCount>
        <obh:name>your_string_0</obh:name>
        <obh:propertiesUpdater>your_collabPropertiesUpdater_0</obh:propertiesUpdater>
        <obh:updateMode>your_updateMode_0</obh:updateMode>
        <obh:updatedBody>your_contentUpdater_0</obh:updatedBody>
        <obh:userCreatedOn>your_dateTime_0</obh:userCreatedOn>
        <obh:userModifiedOn>your_dateTime_0</obh:userModifiedOn>
        <obh:versionDescription>your_string_0</obh:versionDescription>
        <obh:versionUpdateMode>your_versionUpdateMode_0</obh:versionUpdateMode>
        <obh:viewerPropertiesUpdater>your_collabPropertiesUpdater_0</obh:viewerPropertiesUpdater>
        <obh:wikiPageId>your_beeId_0</obh:wikiPageId>
        <obh:wikiPageRenderMode>your_wikiPageRenderMode_0</obh:wikiPageRenderMode>
</obh:wikiPageUpdater>

JSON Example

(show inherited members)

{
    "beeType":"wikiPageUpdater",
        "changeStatus":{ your_{http://www.oracle.com/beehive}changeStatus_as_changeStatus0 },
        "description":"your_{http://www.oracle.com/beehive}description_as_string0",
        "extractReferences":your_{http://www.oracle.com/beehive}extractReferences_as_boolean0,
        "incrementViewCount":your_{http://www.oracle.com/beehive}incrementViewCount_as_boolean0,
        "name":"your_{http://www.oracle.com/beehive}name_as_string0",
        "propertiesUpdater":{ your_{http://www.oracle.com/beehive}propertiesUpdater_as_collabPropertiesUpdater0 },
        "updateMode":{ your_{http://www.oracle.com/beehive}updateMode_as_updateMode0 },
        "updatedBody":{ your_{http://www.oracle.com/beehive}updatedBody_as_contentUpdater0 },
        "userCreatedOn":"your_{http://www.oracle.com/beehive}userCreatedOn_as_dateTime0",
        "userModifiedOn":"your_{http://www.oracle.com/beehive}userModifiedOn_as_dateTime0",
        "versionDescription":"your_{http://www.oracle.com/beehive}versionDescription_as_string0",
        "versionUpdateMode":{ your_{http://www.oracle.com/beehive}versionUpdateMode_as_versionUpdateMode0 },
        "viewerPropertiesUpdater":{ your_{http://www.oracle.com/beehive}viewerPropertiesUpdater_as_collabPropertiesUpdater0 },
        "wikiPageId":{ your_{http://www.oracle.com/beehive}wikiPageId_as_beeId0 },
        "wikiPageRenderMode":{ your_{http://www.oracle.com/beehive}wikiPageRenderMode_as_wikiPageRenderMode0 }
}

XML Schema


<xs:complexType name="wikiPageUpdater">
    <xs:complexContent>
        <xs:extension base="tns:artifactUpdater">
            <xs:sequence>
                <xs:element minOccurs="0" name="description" type="xs:string"/>
                <xs:element minOccurs="0" name="extractReferences" type="xs:boolean"/>
                <xs:element minOccurs="0" name="incrementViewCount" type="xs:boolean"/>
                <xs:element minOccurs="0" name="updateMode" type="tns:updateMode"/>
                <xs:element minOccurs="0" name="updatedBody" type="tns:contentUpdater"/>
                <xs:element minOccurs="0" name="versionDescription" type="xs:string"/>
                <xs:element minOccurs="0" name="versionUpdateMode" type="tns:versionUpdateMode"/>
                <xs:element minOccurs="0" name="wikiPageId" type="tns:beeId"/>
                <xs:element minOccurs="0" name="wikiPageRenderMode" type="tns:wikiPageRenderMode"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to wikiPageUpdater

Referenced By Resources

Usage Resource Method
Request Wiki Page Update

Referenced By Representaions