Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 1.81 KB

workspaceComment_update.rst

File metadata and controls

72 lines (49 loc) · 1.81 KB
Raw

workspaceComment_update

PUT /orgs/{oid}/workspaces/{wid}/comments/{cid}

Summary

  • Method: PUT
  • Response Code: 200
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Updates the information of a comment.

This can include flagging the comment as abusive.

Note

you cannot change the contents of the original comment message using this request.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • wid (required): the id of the workspace-object
  • oid (required): the id of the org-object
  • cid (required): the id of the comment-object

HTTP Request Body Parameters

A comment-object object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/comments/{cid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:comment xmlns:ns0="http://www.usharesoft.com/uforge">
    <abused>true</abused>
    <message>initial message</message>
</ns0:comment>
  • comment-object
  • workspace-api-resources
  • workspaceComment-create
  • workspaceComment-delete
  • workspaceComment-deleteAll
  • workspaceComment-dislike
  • workspaceComment-get
  • workspaceComment-like
  • workspaceComment-reply
  • workspaceComment-reportAbuse
  • workspaceComment-update
  • workspaceComments-getAll