DeleteAttachment

Description

This service deletes an existing attachment, which can be a note, item link, URL attachment, or file attachment.

Arguments

Argument	Type	Description
auth (optional)	Auth	The Auth type supplies credentials and optionally, a host name for licensing. The userId and password can be specified with HTTP BASIC or WS-SECURITY instead.
attachmentID (required)	integer	This is the internal TS_ID of the attachment from the TS_ATTACHMENTS table.
options	Options	Holds name value pairing for future arguments.

Response

An empty XML response is returned and the specified note, item link, URL, or file attachment is deleted:

<ae:DeleteAttachmentResponse></ae:DeleteAttachmentResponse>

Usage

You can use GetItems to find the TS_ID of the attachment to be deleted. If the item has any attachments, they are listed in the <ae:note>, <ae:itemLink>, <ae:urlAttachment>, or <ae:fileAttachment> parameters.

Faults

Invalid database pointer.
The attachment ID is not valid.
Creating the record fails.
The user lacks sufficient permission.
Failed to delete the attachment.

XML

The following XML is a snippet of the payload that is sent with DeleteAttachment.

<urn:DeleteAttachment>
    <urn:auth>
        <urn:userId>admin</urn:userId>
        <urn:password></urn:password>
        <urn:hostname>localhost</urn:hostname>
        <urn:loginAsUserId></urn:loginAsUserId>
   </urn:auth>
   <urn:attachmentID>47</urn:attachmentID>
</urn:DeleteAttachment>