FieldObjectHolder

Description

The FieldObjectHolder type contains the FieldObject response and any errors for objects that were not successfully returned. The FieldObjectHolder type parameters are listed below.

Parameters

Name	Type	Description
fieldObj	FieldObject	Holds complete information about a file or URL.
fieldObjCount	integer	The number of FieldObjects that are returned.
extendedData	ExtendedData	Placeholder for future arguments.
statusList	Status	Holds status information for any messages or failures that are encountered.

Usage

The FieldObjectHolder type returns detailed information for objects in File and URL fields returned by the GetFileField and GetURLField calls. See FieldObject. If any errors occur during the call, they are returned in the status element in the order in which they were processed.

XML

The following XML shows URL objects in the FieldObjectHolder as seen in the <ae:FieldObjectResponse> response.

<ae:FieldObjectResponse>
   <ae:return>
      <ae:fieldObj>
         <ae:id>2</ae:id>
            <ae:uuid>6f41c463-949c-4cf5-a670-af6d98263473</ae:uuid>
            <ae:name>companyName</ae:name>
            <ae:contents>http://www.companyname.com</ae:contents>
      </ae:fieldObj>
      <ae:fieldObj>
            <ae:id>3</ae:id>
            <ae:uuid>61b56784-1732-4705-81fd-c41185c3ee8f</ae:uuid>
            <ae:name>micro focus</ae:name>
            <ae:contents>http://www.microfocus.com</ae:contents>
      </ae:fieldObj>
      <ae:fieldObjCount>2</ae:fieldObjCount>
    </ae:return>
</ae:FieldObjectResponse>

The following XML shows file objects in the FieldObjectHolder as seen in the <ae:FieldObjectResponse> response.

<ae:FieldObjectResponse>
   <ae:return>
      <ae:fieldObj>
         <ae:id>286</ae:id>
         <ae:uuid>2e953ae5-dcd0-4b78-a01d-755d356457e3</ae:uuid>
         <ae:name>_HelloWorld.txt</ae:name>
         <ae:filename>_HelloWorld.txt</ae:filename>
         <ae:filesize>11</ae:filesize>
         <ae:contentsBase64>
            <ae:data>SGVsbG8gV29ybGQ=</ae:data>
         </ae:contentsBase64>
      </ae:fieldObj>
      <ae:fieldObj>
         <ae:id>287</ae:id>
         <ae:uuid>d272809b-e56a-4d42-97df-d209fd4847b5</ae:uuid>
         <ae:name>_HelloWorld.001.txt</ae:name>
         <ae:filename>_HelloWorld.001.txt</ae:filename>
         <ae:filesize>11</ae:filesize>
         <ae:contentsBase64>
            <ae:data>SGVsbG8gV29ybGQ=</ae:data>
         </ae:contentsBase64>
      </ae:fieldObj>
      <ae:fieldObjCount>2</ae:fieldObjCount>
   </ae:return>
</ae:FieldObjectResponse>