Get a comment preview

POST /api/2.0/community/wiki/comment/preview

Request

Returns a comment preview with the content specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string: Can be one of: application/json.
Content-Typeenum of string: Can be one of: application/json.

Body

commentidstring: Comment ID
htmltextstring: Comment text in the HTML format

Examples

POST /api/2.0/community/wiki/comment/preview HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request POST \
  --url https://example.com/api/2.0/community/wiki/comment/preview \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Comment information

CommentIDstring

UserIDstringformat: uuid

UserPoststring

UserFullNamestring

UserProfileLinkstring

UserAvatarPathstring

CommentBodystring

Inactiveboolean

IsReadboolean

IsEditPermissionsboolean

IsResponsePermissionsboolean

TimeStampStrstring

CommentListobject

Attachmentsarray of object

FileNamestring
FilePathstring

401

Unauthorized

Get Help

If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
You can request a feature or report a bug by posting an issue on GitHub.
You can also ask our developers on ONLYOFFICE forum (registration required).