FileAttachment

Description

The FileAttachment type holds the details of a file that is attached to an item. The FileAttachment type parameters are listed below.

Parameters

Name	Type	Description
id	integer	This is the internal TS_ID of the attachment from the TS_ATTACHMENTS table.
name	string	The name you give the attachment in SBM.
fileName	string	The name of the file as it exists on the file system.
showAsImage	boolean	This flag indicates whether or not graphic attachments are shown as images on forms.
modificationDateTime	dateTime	The date and time when the attachment was last modified. See Supported Date/Time Formats for more information.
url	string	The URL for the attachment. The file can be downloaded from this URL.
accessType	Attachment-Access-Type	Shows the access type for the attachment. The value is either DEFAULT, RESTRICTED, or UNRESTRICTED.
extendedData	ExtendedData	Placeholder for future arguments. Includes the size of the file attachment in fileAttachment responses.

Usage

FileAttachmentContents is inherited from FileAttachment. FileAttachment is used with FileAttachmentContents to completely describe a file attachment. The file attachment detail consists of an ID, name, and URL. With the URL, client code can download the file directly.

XML

The following XML snippet shows the FileAttachment type in the <urn:fileAttachment> parameter of TTItem.

<urn:fileAttachment>
    <urn:id>39</urn:id>
    <urn:name>test</urn:name>
    <urn:fileName>wslog.txt</urn:fileName>
    <urn:showAsImage>false</urn:showAsImage>
    <urn:modificationDateTime>2010-06-20T15:35:38-07:00
    →</urn:modificationDateTime>
    <urn:url>http://server:80/tmtrack/tmtrack.dll?AttachmentPage
    →&amp;AttachmentID=39
    </urn:url>
    <urn:accessType>ATTACHACCESS-DEFAULT</urn:accessType>
    <urn:extendedData>
        <urn:data>
            <urn:name></urn:name>
            <urn:value></urn:value>
        </urn:data>
    </urn:extendedData>
</urn:fileAttachment>

Sample response:

<ae:fileAttachment>
   <ae:id>45</ae:id>
   <ae:name>FileName</ae:name>
   <ae:fileName>fileName.dll</ae:fileName>
   <ae:showAsImage>false</ae:showAsImage>
   <ae:modificationDateTime>2014-12-03T15:21:50-08:00</ae:modificationDateTime>
   <ae:url>http://serverName:80/tmtrack/tmtrack.dll?
→AttachmentPage&amp;AttachmentID=45</ae:url>
   <ae:accessType>ATTACHACCESS-RESTRICTED</ae:accessType>
   <ae:extendedData>
      <ae:data>
         <ae:name>fileSize</ae:name>
         <ae:value>126280</ae:value>
      </ae:data>
   </ae:extendedData>
</ae:fileAttachment>