...
URL | HTTP type | Description |
---|---|---|
/{ownertObjectType}/{ownerObjectId}/wiki | POST | Used to create a new wiki page and assign it to an owner object. |
/{ownertObjectType}/{ownerObjectId}/wikiHeaderTreewikiheadertree | GET | Get 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. |
...
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 | ||||
---|---|---|---|---|---|---|
/ | 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. | /{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}/attachment/{fileHandleId}?fileName={attachmentFileName} | GET | Attempt to download the raw file attachment using the name of the attachment file instead of the FileHandleId. 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. |
/{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}/attachmentattachmentpreview?fileName={attachmentFileName} | GET | Attempt to download the raw preview file attachment using the name of the attachment file instead of the FileHandleId. 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. | ||||
/{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}/attachmentPreview/attachmenthandles | GET | Get the FileHandles for all attachments of the given WikiPage. The resulting list will also include any PreviewFileHandles. |
Planned Future API (not currently implemented)
URL | HTTP type | Description |
---|---|---|
/{ownertObjectType}/{ownerObjectId}/wiki | GET | Get the root WikiPage for an owner object. |
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. |
/{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}/attachment/{fileHandleId} | GET | Attempt to download the preview file that is automatically generated for all FileHandles. 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. |
/{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}/attachmentPreview?fileName=/{attachmentFileNamefileHandleId} | GET | Attempt to download the preview file attachment using the name of the attachment file instead of the FileHandleId. 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. |
/{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}/attachmentHandle/{fileHandleId} | GET | Get the FileHandle of an attachment. The FileHandle includes basic metadata about the attachment file. |
/{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}/attachmentHandle/{fileHandleId} | DELETE | Delete a given FileHandle from a wiki page. |