Wiki defintion content 

Lists the elements in the Atom entry document of a wiki.

All elements are in the http://www.w3.org/2005/Atom namespace, except those that are prefixed as follows:

td

ca

Table 1. Wiki definition elements

Element How treated on input Description
<id> Ignored Unique identifier of a wiki.
<title type="text"> Required Title of the wiki in text format. The type attribute is optional; type="text" is the default and only format allowed.
<td:label> Optional A short text label used to identify the wiki in API operation resource addresses. The server assigns a label if you do not provide one.
<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="wiki" label="wiki"/> Required Identifies a wiki definition Atom entry.
<link rel="self" type="application/atom+xml" href="self_url"> Ignored Use the web address in the href attribute to get an Atom entry document containing a complete representation of this wiki. The following operations are supported:

  • GET: Use the web address to obtain a full representation of the wiki as an Atom entry document.

<link rel="alternate" type="text/directory" href="alternate_url"> Ignored A direct link to the wiki within the Wikis web application. Operations supported on the value of the href attribute:

  • GET: Use the web address to view the wiki in HTML format.

<link rel="edit" type="application/atom+xml" href="edit_url"> Ignored Use the web address in the href attribute to get an Atom entry document containing a complete representation of this wiki. If you are an owner of the wiki, the following operations are supported:

  • GET: Use the web address to obtain a full representation of the wiki as an Atom entry document.

  • PUT: Use the web address to update this wiki definition.

  • DELETE: Use the web address to delete the wiki, including all pages and versions.

<summary type="text"> Optional A summary text description of this wiki.
<content type="application/atom+xml" src="src_url"> Ignored Provides access the collection of pages that comprise the wiki. Use the web address in the src attribute to obtain an Atom feed of the pages in this wiki. The following options are supported:

  • GET: Use the web address to obtain an Atom feed of the pages in this wiki.

  • POST: If you are an owner, use the web address to create a new page in the wiki.

<td:permissions> Optional Identifies the set of permissions available for the wiki.
<sharedWith> Optional Specifies who can access the wiki. Grant access by including a set of <ca:member> elements, one for each member. If you do not include this element in the Atom document that you pass with the POST request, the wiki is created and the creator has manager access. No other users are given access. See the table below for more information about the content of this element.
<updated> Ignored The date this wiki was updated, as defined in the Atom specification.
<published> Ignored The date this wiki was created, as defined in the Atom specification.
<author> Ignored The person who created the wiki.

Table 2.

Element How treated on input Description
<ca:member ca:id="<userid>" ca:type="<type>" ca:role="<role>"></ca:member> Optional Identifies a user. Specify values for the following attributes:
ca:id

    Specify one of the following values:

    • snx:userid of the person to whom you want to grant access. See Search Profiles for information on determining a person's user ID.

    • anonymous-user: Use this option to give public access to the wiki.

    • all-authenticated-users: User this option to give all authenticated users access to the wiki.

ca:type

    Determines the type of user. Options are:

    • user: Use this option to specify a particular person.

    • virtual: Specify this option when the ca:id attribute is set to all-authenticated-users or anonymous-user.

ca:role

    Sets the level of access that the person has to the wiki. Options are:

    • editor

    • manager

    • reader

When the following wiki Atom entry document is provided in a POST, it creates a public wiki and grants one user editor access to it:

<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="http://www.w3.org/2005/Atom">
   <id>ignore</id>
   <td:label xmlns:td="urn:ibm.com/td">Lake Champlain</td:label>
   <category term="wiki" scheme="tag:ibm.com,2006:td/type" label="wiki">
   </category>
   <author>
      <name>Bill Jones</name>
      <snx:userid xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
      bf9117c0-f8f2-102c-97c4-ceb7f24c5708
    </snx:userid>
      <email>bjones@us.example.com</email>
   </author>
   <td:sharedWith xmlns:td="urn:ibm.com/td">
      <ca:member 
     xmlns:ca="http://www.ibm.com/xmlns/prod/composite-applications/v1.0" 
      ca:id="bf9117c0-f8f2-102c-97d8-ceb7f24c5708" 
      ca:type="user"
      ca:role="editor" >
      </ca:member>
    <ca:member 
     xmlns:ca="http://www.ibm.com/xmlns/prod/composite-applications/v1.0" 
      ca:id="anonymous-user" 
      ca:type="virtual" 
      ca:role="reader" >
    </ca:member>
   </td:sharedWith>
   <title type="text">Long Lake</title>
   <summary type="text">
     modification none
   </summary>
</entry>


Parent topic

Wikis Atom entry types

Related reference
Create a wiki
Update a wiki
Work with the available wikis collection
Getting a feed of public wikis
Retrieve a wiki
Delete wikis


   

 

});

+

Search Tips   |   Advanced Search