GET /api/boards/items/comments/{CommentID}/artifacts/{FileName}

Returns the specified artifact associated with the specified comment.

Authorization Roles/Permissions: Must have visibility of the applicable Board. 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

GET

URL

https://{hostname}/api/boards/items/comments/{CommentID}/artifacts/{FileName}

Sample Request

The example below shows successful completion of this operation. The image is returned.

Sample Request URL 

https://{hostname}/api/boards/items/comments/c23c3cb9-3da0-4448-b584-2fef489d3ddf.acmepaymentscorp/artifacts/img_dollars_03.jpg

Sample request headers 

Host: {hostname}
Accept: image/png,image/*;q=0.8,*/*;q=0.5

Sample request body

Not applicable.

Request Headers

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

Header Description
Accept None required. This operation detects the media type from the filename in the URL.
Cookie AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
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.

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 Board item.
download Query string Optional

Determines the disposition of the downloadable content:

  • true: the content is downloaded.
  • false: the user is prompted for content disposition.

In versions prior to 2020.2.12, the default value was false. In version 2020.2.12 and later, the default value is true, indicating that the content is downloaded.

Response

If successful, this operation returns HTTP status code 200, with the requested artifact.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json 

HTTP/1.1 200 OK
Content-Type: image/jpeg
Expires: Tue, 09 Jun 2015 17:25:02 GMT

Sample response body: application/json

The response is the artifact file.

Response Headers

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

Header Description
Content-Type An appropriate media type for the file. This operation detects the media type from the filename in the URL.

Response Body

Name Type Description
File Artifact The response is the requested artifact.

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.