REST API - Delete Comment Request
9 min
api/v1/projects/{projectId}/artifacts/{artifactId}/comments/{commentId}Description
Deletes the specified comment from an artifact.
You can only delete comments if Blueprint is configured to allow the deletion of published comments.
URL Structure
[Blueprint_URI]/api/v1/projects/{projectId}/artifacts/{artifactId}/comments/{commentId}- ProjectId: The ID of the project containing the comment you want to delete.
- ArtifactId: The ID of the artifact that contains the comment.
- CommentId: The ID of the comment you want to delete.
Supported Methods
- DELETE
You can override the DELETE method and use the POST method instead.
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.
- 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
http://today/api/v1/projects/1978492/artifacts/1978633/comments/377374Response Header
{'content-length': '106', 'x-xss-protection': '1; mode=block', 'x-content-type-options': 'nosniff', 'expires': '-1', 'server': 'Blueprint', 'pragma': 'no-cache', 'cache-control': 'no-cache', 'date': 'Wed, 27 Nov 2013 19:37:40 GMT', 'x-frame-options': 'deny', 'content-type': 'application/xml; charset=utf-8'}Response Body
<?xml version="1.0" ?> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">Comment successfully deleted.</string>JSON Example
Request URI
http://today/api/v1/projects/1978492/artifacts/1978633/comments/377394Response Header
{'content-length': '31', 'x-xss-protection': '1; mode=block', 'x-content-type-options': 'nosniff', 'expires': '-1', 'server': 'Blueprint', 'pragma': 'no-cache', 'cache-control': 'no-cache', 'date': 'Wed, 27 Nov 2013 18:51:38 GMT', 'x-frame-options': 'deny', 'content-type': 'application/json; charset=utf-8'}Response Body
"Comment successfully deleted."