workspaceComment_update.rst

workspaceComment_update

.. function:: 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 :ref:`workspace-object`
• oid (required): the id of the :ref:`org-object`
• cid (required): the id of the :ref:`comment-object`

HTTP Request Body Parameters

A :ref:`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>

.. seealso::

         * :ref:`comment-object`
         * :ref:`workspace-api-resources`
         * :ref:`workspaceComment-create`
         * :ref:`workspaceComment-delete`
         * :ref:`workspaceComment-deleteAll`
         * :ref:`workspaceComment-dislike`
         * :ref:`workspaceComment-get`
         * :ref:`workspaceComment-like`
         * :ref:`workspaceComment-reply`
         * :ref:`workspaceComment-reportAbuse`
         * :ref:`workspaceComment-update`
         * :ref:`workspaceComments-getAll`