POST /api/alerts/{AlertID}/comments

Adds a comment to the specified alert.

Note: If you are using markdown, and will be incorporating one or more artifacts in your comment, you must upload the artifacts first. Run the POST /api/boards/items/comments/artifacts operation to upload the first artifact and the POST /api/boards/items/comments/{CommentID}/artifacts operation to upload any subsequent artifacts. Use the values from the responses, such as the BoardItemID and the image paths, to construct the payload for adding the comment.

Authorization Roles/Permissions: Must be logged in. Must be an authorized user of the API that the alert relates to.

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

https://{hostname}/api/alerts/{AlertID}/comments

Back to top

Sample Request

The example below shows a request to add a comment to the specified alert.

Request URL

https://{hostname}/api/alerts/alert11639.acmepaymentscorp/comments

Sample request headers

Content-Type: application/json
Accept: text/plain
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "Content":"Thanks for letting us know!!",
  "UserID":"f778a368-f060-43af-b75f-99d4fb3905ac.acmepaymentscorp"
}

Back to top

Request Headers

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

Header Description
Accept Any value that matches text/plain is valid; for example, */*.
Content-Type

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

application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
AlertID Path string Required The unique ID for a specific alert.
comment Body Comment Required

Contains information about a comment on a Board item such as a ticket, discussion, or alert.

Content and UserID are required.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the CommentID of the new comment.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: text/plain
Expires: Tue, 12 May 2015 20:05:14 GMT

Sample response body: application/json

4513c498-5055-411d-aa92-79c0f416047c

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
CommentID string The unique ID for the comment that was added.

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
400

Bad request: Returned if the client sends invalid parameters or body content.

In this operation, you'd get a 400 response if you sent an incorrect JSON object in the request.

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. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics