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

Deletes the specified artifact for the specified BoardItemID.

Authorization Roles/Permissions: 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 developer portal.

This topic includes the following sections:

HTTP Method

DELETE

Back to top

URL

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

Back to top

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.

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_{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

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

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.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the deleted artifact.

Back to top

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"
}

Back to top

Sample response headers: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Expires: Thu, 21 May 2015 19:54:17 GMT

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BoardItemArtifact xmlns="http://soa.com/xsd/board/1.0" xmlns:ns2="http://soa.com/xsd/resource/1.0" 
xmlns:ns3="http://soa.com/xsd/comment/1.0" xmlns:ns4="http://soa.com/xsd/user/1.0" 
xmlns:ns5="http://soa.com/xsd/dnmodel/1.0" xmlns:ns6="http://a9.com/-/spec/opensearch/1.1/" 
xmlns:ns7="http://soa.com/xsd/alert/1.0" xmlns:ns8="http://soa.com/xsd/api/1.0" 
xmlns:ns9="http://soa.com/xsd/contract/1.0" xmlns:ns10="http://soa.com/xsd/ticket/1.0" 
xmlns:ns11="http://soa.com/xsd/app/1.0" xmlns:ns12="http://soa.com/xsd/discussion/1.0" 
xmlns:ns13="http://soa.com/xsd/review/1.0">
  <ContextID>4077d933-34ae-4d0c-b0ef-790f67695cf0.acmepaymentscorp</ContextID>
  <FileName>img_dollars_01.jpg</FileName>
  <BaseUri>http://{hostname}</BaseUri>
  <UriPath>/api/boards/items/4077d933-34ae-4d0c-b0ef-790f67695cf0.acmepaymentscorp/img_dollars_01.jpg</UriPath>
</BoardItemArtifact>

Back to top

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

Back to top

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.

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