Note: This feature is currently in Alpha and all functionality is not currently support.
Wiki REST
Wiki pages are currently not stand-alone objects, rather they are a component of another object such as an Entity, Competition or Evaluation. Therefore, access to a wiki page is gated by its owner object. For example, if you have CREATE permission on an Entity, then you can create a Wiki page for that entity. Similarly, if you can EDIT an entity, then you can also edit any wiki page associated with the entity. This means all REST call for wiki pages involve the owner object.
Note: WikiPages can be nested to created a hierarchy of sub-pages. However, there can only be one root WikiPage per owner object, and all sub-pages are considered to be owned by the same object.
WikiPage
| field | Description |
|---|---|
| id | The unique immutable identifier assigned to a wiki page when it is first created. This is used |
| etag | Used for concurrency management. Each time a WikiPage changes the etag will change. |
| createdBy | The ID of the user that created the WikiPage |
| createdOn | The date when the WikiPage was first created. |
| modifiedBy | The ID of the user that last modified the wiki page. |
| modifiedOn | The data when the WikiPage was last modified. |
| title | The main tile of the wiki page. |
| markdown | The main body of the wiki page is represented as markdown. |
| attachmentFileHandleIds | The list of FileHandleIds that represent that this WikiPage's attachment files. |
| parentWikiId | Sub-WikiPages are created by setting this to the ID of a parent WikiPage. Note: This is not the same as the owner of the WikiPage. |
CRUD REST
| URL | HTTP type | Description |
|---|---|---|
| /{ownertObjectType}/{ownerObjectId}/wiki | POST | Used to create a new wiki page and assign it to an owner object. |
| /{ownertObjectType}/{ownerObjectId}/wiki | GET | Get the root wiki page for an owner object. |
| /{ownertObjectType}/{ownerObjectId}/wiki/{wikiId} | GET | Get a wiki page by its ID. |
| /{ownertObjectType}/{ownerObjectId}/wiki/{wikiId} | PUT | Used to update a wiki |
| /{ownertObjectType}/{ownerObjectId}/wiki/{wikiId} | DELETE | Used to delete a wiki page. |