REST API - Rate Comment Request

api/v1/projects/{projectId}/artifacts/{artifactId}/comments/{commentId}/feedback

Description

Rates a comment by specifying whether you like or dislike the comment.

URL Structure

[Blueprint_URI]/api/v1/projects/{projectId}/artifacts/{artifactId}/comments/{commentId}/feedback
  • ProjectId: The ID of the project containing the comment you want to rate.
  • ArtifactId: The ID of the artifact containing the comment you want to rate.
  • CommentId: The ID of the comment you want to rate. You can retrieve CommentId information via the Get Artifact request.

Supported Methods

  • POST

URI Parameters

  • Like: (Required) Specifies your feedback. You must specify one of the following values:
    • True: Indicates that you agree with the comment and activates a thumbs-up icon.
    • False: Indicates that you disagree with the comment and uses a thumbs-down icon.
    • None: Resets the like status to neither like or dislike.

HTTP Status Codes

  • 200: OK
  • 201: Successfully Created
  • 206: Partial Content
  • 400: Bad Request
    This error can occur for a variety of reasons:
    • At least one URI or request body parameter is invalid, such as one of the Filter, Traces, Offset or Limit parameters.
    • A required value has not been provided.
    • If you are submitting a POST or PATCH request and have not added the X-HTTP-Method-Override parameter to your request header.
  • 401: Unauthorized
    • The Blueprint token is missing, invalid or expired.
  • 403: Forbidden
    • The applicable permissions are needed. For example, this error can occur when:
      • An Author or Collaborate license is needed for access.
      • Comment permissions are needed on the artifact.
      • Edit permissions are needed on the change summary job.
  • 404: NotFound
    • Item is not found in the project. For example, this error can occur when:
      • Artifact not found.
      • Artifact type not found.
      • Project not found.
      • ALM target not found.
      • Change summary job not found.
      • User does not have edit permissions for this artifact, project or ALM target.
  • 409: Conflict
    • Reason for failure can be found in the response body. Additional information may also be found in the log.
  • 411: Length Required
    • If the Content-Length header is missing in the request.
  • 413: Request Entity Too Large
    • If the provided file size is larger than allowed.
  • 415: Unsupported Media Type
    • If the provided media type is not of MIME Multipart Content "form-data."
  • 416: Request Range Not Satisfiable
    • If offset points to a part of a collection that is not available.
  • 500: Internal Server Error
  • 501: Not Implemented

Examples

XML Example

Request URI

https://production.blueprintcloud.com/api/v1/projects/220870/artifacts/220914/comments/583921/feedback?like=true

Response Body

<?xml version="1.0" ?><string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">The comment was successfully rated.</string>
JSON Example

Request URI

https://production.blueprintcloud.com/api/v1/projects/220870/artifacts/220914/comments/583921/feedback?like=true

Response Body

"The comment was successfully rated."