FileObj

Description

Describes a file object contained within a File field in the UpdateFileField call. The FileObj type parameters are listed below.

Parameters

Name Type Description
FieldObj FieldObj Holds complete identification information for a File or URL field and the action to be performed.
filename string The actual file name.
contentsBase64 FileBufferBase64 Holds the base64 encoded contents of the file.

Usage

FileObj is used to describe a file in the UpdateFileField call. See UpdateFileField.

The fileObject argument in the UpdateFileField call uses the FileObj type, which includes the FieldObj type, the file name, and optionally, the Base64 contents of a file to add, update, or delete a file value in a File field. See UpdateFileField.

XML

The following XML snippet shows the FileObj argument in the fileObject argument of an UpdateFileField call.

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