Home

 

Updating a wiki page

Update a wiki page programmatically.

See Authenticating requests for information about how to authenticate the request.

To update a wiki page...

  1. Retrieve the existing wiki page Atom document. See Retrieving a wiki page for more details.

  2. Edit the wiki page Atom document to include the information you want to change.

  3. Send the updated Atom document using the following request:


    Atom API GET request details

    Method URI Input representation
    PUT Determine the resource URI in either of the following ways:

    • Value of the href attribute of the rel="edit" <link> element for each wiki page Atom entry, which are provided in the wiki pages collection.

    • You can construct the URI using the following syntax: /basic/api/wiki/{wiki-label}/page/{page-label}/entry where {wiki-label} is the value of the <td:label> element in the wiki definition Atom entry document and {page-label} is the value of the <td:label> element in the wiki page Atom document.

    wiki page

You can use one or more of these input parameters with the PUT request. Separate multiple parameters with an ampersand (&).


Input parameters

Parameter Description
createVersion Specify "true" to create a new version of the page or "false" overwrite the current version.
draft Specify "true" to mark the page as a draft, or "false" otherwise.
includeNotification Specify "true" to request the metadata on notification (edit or comment added) to be included for the document entry.
sendNotification Specify "true" if you want to send edit or comment notifications.

 

Input

Provide an updated wiki page Atom entry document.

The content type of the Atom entry document must be application/atom+xml.

 

Output

None. Returned HTTP Headers

Error codes


Working with wiki pages

 

Related reference


Wiki page content


+

Search Tips   |   Advanced Search