FieldObject

Description

Describes the individual file or URL object contained within a File or URL field. The FieldObject type parameters are listed below.

Parameters

Name	Type	Description
id	integer	The TS_ID value of the file or URL from the TS_FILEOBJS table.
uuid	string	The UUID value from the TS_FILEOBJS table.
name	string	The display name of the file or URL object.
contents	string	For URL objects, this is the actual URL.
filename	string	For file objects, this is the actual file name.
filesize	string	The file's size in bytes.
contentsBase64	FileBufferBase64	Holds the base64 encoded contents of the file.
extendedData	ExtendedData	Placeholder for future arguments.

Usage

The FieldObject type contains the a file or URL name and other details about File or URL field contents. The GetFileField and GetURLField calls return lists of FieldObject records within FieldObjectHolder. See FieldObjectHolder.

The total size of the file contents that are returned is determined by the FileFieldTotalSizeMax_MB global system setting. The default value is 50MB. For help with changing this value, contact Support.

XML

The following XML snippet shows the FieldObject type in the return element of the GetFileField response.

<ae:fieldObj>
   <ae:id>285</ae:id>
   <ae:uuid>58da2c14-34d5-4235-a5c7-2c52931c7651</ae:uuid>
   <ae:name>sample text</ae:name>
   <ae:filename>mysamplefile.txt</ae:filename>
   <ae:filesize>9</ae:filesize>
   <ae:contentsBase64>
      <ae:data>YWRzZGFzZGFz</ae:data>
   </ae:contentsBase64>
</ae:fieldObj>

The following XML snippet shows the FieldObject type in the return element of the GetURLField response.

<ae:fieldObj>
   <ae:id>220</ae:id>
   <ae:uuid>d1bb8fe4-6acf-4ba4-b083-41a961d03a0c</ae:uuid>
   <ae:name>company name</ae:name>
   <ae:contents>>http://www.companyname.com</ae:contents>
</ae:fieldObj>