POST /api/boards/items/comments/{CommentID}/actions

Performs a workflow action on the specified comment.

Authorization Roles/Permissions: Must be an authorized user for the resource. For more information about how authorization and visibility work for Board operations, see Boards in the developer portal.

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

https://{hostname}/api/boards/items/comments/{CommentID}/actions

Back to top

Sample Request

The example below shows approval of a pending comment on a discussion.

Request URL

https://{hostname}/api/boards/items/comments/3e6cd742-e779-4d73-848d-ed07eec8240e.acmepaymentscorp/actions

Sample request headers

Content-Type: application/json
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

{
  "ActionName":"comment.action.approve",
  "Comments":""

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json or application/xml

application/vnd.soa.v71+json or application/vnd.soa.v71+xml

application/vnd.soa.v72+json or application/vnd.soa.v72+xml

application/vnd.soa.v80+json or application/vnd.soa.v80+xml

application/vnd.soa.v81+json or application/vnd.soa.v81+xml

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
CommentID Path string Required The unique ID for a specific comment.
Action Body Action Required Contains information about an action performed on a resource as part of a workflow-related activity.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the updated workflow status for the comment.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type: text/plain
Expires: Wed, 25 Feb 2015 14:08:01 GMT

Sample response body

Published

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type text/plain

Back to top

Response Body

Name Type Description
PublishedState string returns a string: the published state of the comment, after completion of the workflow action.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics