...
| 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 (null for root). Note: This is not the same as the owner of the WikiPage. |
| field | Description |
|---|
| id | The id of the wiki page. |
| title | The title of the wiki page. |
| parentWikiId | The ID of the parent wiki (null for root) |
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}/wikiwikiHeaderTree | GET | Get the root wiki page for an entire wiki tree as a list of WikiHeaders. The list is ordered first by parentWikiId and then by title. This can be used to build a tree representation of wiki hierarchy for a given 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. |
Attachments
Each wiki page has its own list of file attachments represented as FileHandleIds. For more information on FileHandles see: File API.
| URL | HTTP type | Description |
|---|
| https://file-prod.sagebase.org/file/v1/{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}/attachment | POST (HTTP Multipart) | Add an attachment file to a wiki using HTTP mutlipart POST. Notice, the host for this call is a special file dedicated server. |
| https://repo-prod.sagebase.org/repo/v1/{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}/attachment/{fileHandleId} | GET | Attempt to download the raw file attachment. Note: This call will result in a HTTP temporary redirect (307), to the real file URL if the caller is authorized to read the owner object. |
| https://repo-prod.sagebase.org/repo/v1/{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}/attachmentPreview/{fileHandleId} | GET | Attempt to download the preview file that is automatically generated for all FileHandles. Note: This call will result in a HTTP temporary redirect (307), to the real file URL if the caller is authorized to read the owner object. |
