DELETE /api/boards/items/comments/{CommentID}/artifacts/{FileName}
Deletes the specified artifact for the specified comment.
Authorization Roles/Permissions: Must be logged in. Must be an authorized user for the specific Board item artifact. For more information about how authorization and visibility work for Board operations, see Boards in the Community Manager developer portal.
This topic includes the following sections:
HTTP Method
DELETE
URL
https://{hostname}/api/boards/items/comments/{CommentID}/artifacts/{FileName}
Sample Request
The example below shows a request to delete an image file that was uploaded to the content window as part of adding a comment with markup support.
Sample Request URL
https://{hostname}/api/boards/items/comments/c23c3cb9-3da0-4448-b584-2fef489d3ddf.acmepaymentscorp/artifacts/img_dollars_02.jpg
Sample request headers
DELETE http://{hostname}/api/boards/items/comments/c23c3cb9-3da0-4448-b584-2fef489d3ddf.acmepaymentscorp/artifacts/img_dollars_02.jpg HTTP/1.0 Host: {hostname} Accept: application/json, text/javascript, */*; q=0.01 X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...
Sample request body
Not applicable.
Request Headers
For general information on request header values, refer to HTTP Request Headers.
Header | Description |
---|---|
Accept | application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml |
Request Parameters
Parameter | Parm Type | Data Type | Required | Description |
---|---|---|---|---|
CommentID | Path | string | Required | The unique ID for a specific comment. |
FileName | Path | string | Required | The filename for the artifact associated with the comment. |
Response
If successful, this operation returns HTTP status code 200. There is no response content.
Sample Response
The sample response below shows successful completion of this operation.
Sample response headers
HTTP/1.1 200 OK Expires: Tue, 09 Jun 2015 17:59:18 GMT Content-Length: 0
Sample response body
None.
Response Headers
For general information on response header values, refer to HTTP Response Headers.
Header | Description |
---|---|
Content-Type | application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml |
Response Body
None.
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. 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.