Knowledge entry collection

The knowledge entry Collection is used to add, update and delete knowledge entries in a space and retrieve knowledge entries.

Listing collection entries

To retrieve a list of knowledge entries, do a GET method request to the Collection URL.

Entries are returned in the order that their most recent version was published. The collection supports paging and returns first, last, next and previous links.

By default only the headlines of entries are returned in the collection and a separate request must be made to retrieve the full content of an entry.

Adding a new entry

A new knowledge entry is submitted using a POST method request to the Collection URL.

Content

Content for the entry is supplied in the <content> element. This can have a type of either text, html or xhtml. If text is used then the simple markup rules are used to generate the HTML version. Note that it is not possible at present to add attachments over the APP interface.

Drafts

If the <app:draft> element is set to indicate that this is a draft then the entry will not be published and instead stored in the Taskbox.

Response code

When a knowledge entry is successfully created using the API a response code of 201 will be given and the location of the new entry sent back in the Location: header provided the entry is not subject to workflow.

Retrieval

You can retrieve the Atom entry for an individual knowledge entry using the URLs returned from the collection. These will be the same as those shown through the web interface with +atom appended.

Updating an existing entry

To update an existing knowledge entry use a PUT method request on the entry's URL. A new version of the entry will be created and a response code of 200 will be returned.