Skip to content

Latest commit

 

History

History
69 lines (47 loc) · 1.69 KB

workspaceComment_create.rst

File metadata and controls

69 lines (47 loc) · 1.69 KB
Raw

workspaceComment_create

POST /orgs/{oid}/workspaces/{wid}/comments

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.3.2

Posts a comment to a workspace.

Please refer to comment-object for a complete list of all the comment attributes.

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

HTTP Request Body Parameters

A comment-object object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/workspaces/{wid}/comments" -X POST \
-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">
    <message>Comment Example</message>
    <type>QUESTION</type>
</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