FieldObj

Description

Holds complete identification information for a File or URL field and the action to be performed in the UpdateFileField and UpdateURLField calls. The FieldObj 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.
action	FileObj-Action	Enumeration that performs an action on a file or a URL.
extendedData	ExtendedData	Placeholder for future arguments.

Usage

The FieldObj type is used in the FileObj argument to describe a file in the UpdateFileField call. See UpdateFileField.

XML

The following XML snippet shows FieldObj in the fileObject element of an UpdateFileField call.

<urn:fileObject>
    <urn:id></urn:id>
    <urn:uuid></urn:uuid>
    <urn:name></urn:name>
    <urn:action>NEW-ONLY</urn:action>
    <urn:filename>HelloWorld.001a.txt</urn:filename>
    <urn:contentsBase64>
        <urn:data>SGVsbG8gV29ybGQ=</urn:data>
    </urn:contentsBase64>
</urn:fileObject>