GET /api/boards/items/{BoardItemID}/artifacts/{FileName}

Returns the specified artifact associated with the specified Board item.

Authorization Roles/Permissions: Anyone can use this operation; login is not required. However, note that for any operations that do not require login, information about private resources is not returned unless the user is logged in and is authorized to view information about those resources. Without login, only public information is returned. For more information about how authorization and visibility work for Board operations, see Boards in the developer portal.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/boards/items/{BoardItemID}/artifacts/{FileName}

Back to top

Sample Request

The example below shows a request for the specified artifact.

Request URL

https://{hostname}/api/boards/items/f4827eb8-5a9f-429a-8b2a-4ef2f7f8af8c.acmepaymentscorp/artifacts/img_dollars.jpg

Sample request headers

X-Csrf-Token_{tenant}: {TokenID}

Sample request body

Not applicable.

Back to top

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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
BoardItemID Path string Required The unique ID for a specific Board item. For example, if it is an API board, it is the APIID. For information about how to find a BoardItemID, see Board Item ID.
FileName Path string Required The filename for the artifact associated with the Board item.
download Query string Optional If set to true (the default), the content is downloaded. If set to false, the user is prompted for content disposition.

Back to top

Response

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

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Content-Type: image/jpeg
Expires: Fri, 22 May 2015 15:41:56 GMT

Sample response body

The response is the artifact file.

Back to top

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.

Back to top

Response Body

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

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
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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics