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

Deletes the specified artifact for the specified BoardItemID.

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/{BoardItemID}/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 board item with markup support.

Sample Request URL

https://{hostname}/api/boards/items/artifacts/cad5266e-ef52-4961-b2f4-00ebf80b615a.acmepaymentscorp/img_dollars.jpg

Sample request headers

DELETE http://{hostname}/api/boards/items/artifacts/cad5266e-ef52-4961-b2f4-00ebf80b615a.acmepaymentscorp/img_dollars.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
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.

Response

If successful, this operation returns HTTP status code 200, with information about the deleted 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: application/json
Expires: Thu, 21 May 2015 18:03:57 GMT

Sample response body: application/json

{
  "ContextID" : "cad5266e-ef52-4961-b2f4-00ebf80b615a.acmepaymentscorp",
  "FileName" : "img_dollars.jpg",
  "BaseUri" : "http://{hostname}",
  "UriPath" : "/api/boards/items/cad5266e-ef52-4961-b2f4-00ebf80b615a.acmepaymentscorp/img_dollars.jpg"
}

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

Name	Type	Description
BoardItemArtifact	BoardItemArtifact	Contains information about an image or other artifact associated with a Board item. Applicable only if the DescriptionMediaType for the Board item is text/markdown.

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.

Related Topics