GetFileAttachment

Description

This service gets an existing 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.
item (required)	ItemIdentifier	Specifies the item that contains the attachment.
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 on certain calls.

Response

FileAttachmentContents is returned. The file attachment is returned as a base64 encoded attachment. See FileAttachmentContents for more information.

Usage

You can use the ID returned in the FileAttachment parameter of a returned TTItem in the attachmentID argument of GetFileAttachment.

Faults

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

XML

The following XML is a snippet of the payload being sent with GetFileAttachment.

<urn:GetFileAttachment>
    <urn:auth>
        <urn:userId>admin</urn:userId>
        <urn:password></urn:password>
        <urn:hostname></urn:hostname>
    </urn:auth>
    <urn:item>
        <urn:displayName></urn:displayName>
        <urn:id>109</urn:id>
        <urn:uuid></urn:uuid>
        <urn:tableId>1000</urn:tableId>
        <urn:tableIdItemId>1000:109</urn:tableIdItemId>
        <urn:issueId>BUG000173</urn:issueId>
    </urn:item>
    <urn:attachmentID>104</urn:attachmentID>
</urn:GetFileAttachment>