Versions Compared

Old Version 8

changes.mady.by.user John Hill

Saved on

compared with

New Version Current

changes.mady.by.user Chris Bare

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: added REST call to get wiki associate w/ an object w/o using wikiID

...

URLHTTP typeDescription
/{ownertObjectType}/{ownerObjectId}/wikiPOSTUsed to create a new wiki page and assign it to an owner object.
/{ownertObjectType}/{ownerObjectId}/wikiHeaderTreewikiheadertreeGETGet 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}/wikiGETGet the root wiki page associated with an object.
/{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}GETGet a wiki page by its ID.
/{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}PUTUsed to update a wiki.
/{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}DELETEUsed 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 FileHandle API.

https:/file-prod.sagebase.org/file/v1//{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}/attachment/{fileHandleId
URLHTTP typeDescription
/{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}/attachmentPOST (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.?fileName={attachmentFileName}GETAttempt 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}GETAttempt 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}/attachmenthandlesGETGet the FileHandles for all attachments of the given WikiPage.  The resulting list will also include any PreviewFileHandles.

Planned Future API (not currently implemented)

URLHTTP typeDescription
/{ownertObjectType}/{ownerObjectId}/wikiGETGet the root WikiPage for an owner object.
https://file-prod.sagebase.org/file/v1/{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}/attachmentPOST (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}GETAttempt 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}GETAttempt 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}GETGet the FileHandle of an attachment.  The FileHandle includes basic metadata about the attachment file.
/{ownertObjectType}/{ownerObjectId}/wiki/{wikiId}/attachmentHandle/{fileHandleId}DELETEDelete a given FileHandle from a wiki page.