IBM Connections: Using Connections API on Wiki Pages: Difference between revisions

From Wiki
Line 66: Line 66:


  curl -XPOST "https://'''{hostname}:{port}'''/wikis/basic/api/wiki/{wiki-label}/feed"
  curl -XPOST "https://'''{hostname}:{port}'''/wikis/basic/api/wiki/{wiki-label}/feed"
  -H "X-Update-Nonce: <NONCE>" -H "Content-Type: application/atom+xml" --data "@'''WikiNewPageChild01.xml'''"  -u {username}:{password} -v -k -L
  -H "X-Update-Nonce: <NONCE>" -H "Content-Type: application/atom+xml; charset=utf-8" --data "@'''WikiNewPageChild01.xml'''"
  -u {username}:{password} -v -k -L


If no error, refresh you Wiki to see the new page created (on left side).
If no error, refresh you Wiki to see the new page created (on left side).

Revision as of 01:36, 24 November 2016

THIS DOCUMENT IS ON DRAFT

Using Atom, you can can create, retrieve, update, or delete wiki pages.

I will show some examples, if you want more details see documentation on Working with wiki pages IBM Connections 5.5 API.

First of all you must create a Wiki on Connections, open this wiki and get the wiki-label.

W34c123febb3c_4a55_81b7_0d5a123c1234

Working with Wiki Pages

Create a Wiki Page

Let's create our data file.

1) Create the file WikiNewPage01.xml, with bellow content:

 <entry xmlns="http://www.w3.org/2005/Atom">
 <title type="text">My First Wiki</title>
 <content type="text/html">
  <![CDATA[<?xml version="1.0" encoding="UTF-8"?><p>
  <strong>Hello World!</strong>
  </p>]]>
 </content>
 <category term="wikipagetag1" />
 <category term="wikipagetag2" />
 <category scheme="tag:ibm.com,2006:td/type" term="page" label="page" />
 </entry>
 

Save.

2) Now run curl comand to create

curl -XPOST "https://{hostname}:{port}/wikis/basic/api/wiki/{wiki-label}/feed"
-H "Content-Type: application/atom+xml; charset=utf-8" --data "@WikiNewPage01.xml"  -u {username}:{password} -v -k -L

If no error, refresh you Wiki to see the new page created (on left side).

Create a Wiki Page as Child

Let's create our data file.

1) Create the file WikiNewPageChild01.xml, with bellow content:

 <entry xmlns="http://www.w3.org/2005/Atom">
 <title type="text">My First Child Wiki</title>
 <content type="text/html">
  <![CDATA[<?xml version="1.0" encoding="UTF-8"?><p>
  <strong>Hello World! Child</strong>
  </p>]]>
 </content>
 <category term="wikipagetag1" />
 <category term="wikipagetag2" />
 <category scheme="tag:ibm.com,2006:td/type" term="page" label="page" />
 <parentUuid xmlns="urn:ibm.com/td">{parentUuid}</parentUuid>
 </entry>
 

Replace the parentUuid and Save.

2) Now run curl command to create, with a new X-Update-Nonce header:

curl -XPOST "https://{hostname}:{port}/wikis/basic/api/wiki/{wiki-label}/feed"
-H "X-Update-Nonce: <NONCE>" -H "Content-Type: application/atom+xml; charset=utf-8" --data "@WikiNewPageChild01.xml"  
-u {username}:{password} -v -k -L

If no error, refresh you Wiki to see the new page created (on left side).

Update a Wiki Page

Retrieving a Wiki Page

Delete a Wiki Page

Tips

Issues with content element

  • {wiki-label} is the wiki to which you want to add the page.
  • Prefixing the html in the content element with the following:
<![CDATA[<?xml version="1.0" encoding="UTF-8"?>

and ending it with:

]]>

fixes an issue to display content.

  • Use
    or

    to restrict content.

Tags

Use

 <category term="wikipagetag1" />

to tag your wiki page.


Ver também